Merge remote-tracking branch 'origin/main' into refactor/move-charts

On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>

Taskfile.yaml

@@ -55,4 +55,4 @@ tasks:
     deps:
       - task: setup:helm-docs
     cmds:
-      - "{{.LOCAL_BIN}}/helm-docs --chart-search-root charts/ --template-files=README.md.gotmpl --skip-version-footer=false"
+      - "for chart in $(echo {{.CHARTS}} | tr ',' ' '); do {{.LOCAL_BIN}}/helm-docs --log-level=debug --chart-search-root $chart --template-files=../../docs-templates/header.md.gotmpl,README.md.gotmpl,../../docs-templates/footer.md.gotmpl --skip-version-footer=false; done"

charts/account-operator-crds/Chart.yaml

@@ -4,6 +4,6 @@ description: A Helm chart for Kubernetes
 
 type: application
 
-version: 0.1.8
+version: 0.1.9
 
-appVersion: "1.16.0"
+appVersion: "0.0.0"

charts/account-operator-crds/README.md

@@ -2,13 +2,13 @@
 
 A Helm chart for Kubernetes
 
-![Version: 0.1.8](https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
+![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 ## Values
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| kcp.enabled | bool | `false` | Enable KCP |
+
+## Overriding Values
 
 The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
 
@@ -26,7 +26,3 @@ Example
 3) .Values.deployment.resources.limits.memory =  1024MB
 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
 ```
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| kcp.enabled | bool | `false` | Enable KCP |

charts/account-operator-crds/README.md.gotmpl

@@ -1,31 +0,0 @@
-{{ template "chart.header" . }}
-{{ template "chart.description" . }}
-
-{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
-{{ template "chart.requirementsSection" . }}
-
-{{ template "chart.valuesHeader" . }}
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example 
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
-{{ template "chart.valuesTable" . }}

charts/account-operator/Chart.yaml

@@ -2,8 +2,8 @@ apiVersion: v2
 name: account-operator
 description: A Helm chart for Kubernetes
 type: application
-version: 0.5.8
-appVersion: "0.111.0"
+version: 0.5.10
+appVersion: "0.112.0"
 dependencies:
   - name: account-operator-crds
     version: 0.1.8

charts/account-operator/README.md

@@ -2,38 +2,15 @@
 
 A Helm chart for Kubernetes
 
-![Version: 0.5.8](https://img.shields.io/badge/Version-0.5.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.111.0](https://img.shields.io/badge/AppVersion-0.111.0-informational?style=flat-square)
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
+![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 ## Requirements
 
-| Repository | Name | Version |
-|------------|------|---------|
-| oci://ghcr.io/openmfp/helm-charts | account-operator-crds | 0.1.8 |
-| oci://ghcr.io/openmfp/helm-charts | common | 0.1.8 |
-
+| Repository | Name | Description | Sources |
+|------------|------|-------------|---------|
+| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|
+| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)|
 ## Values
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | crds.enabled | bool | `true` | Enable CRDs |
@@ -58,3 +35,22 @@ Example
 | subroutines.namespace.enabled | bool | `true` | Enable namespace subroutines |
 | webhooks.certDir | string | `"/certs"` | The directory for webhook certificates |
 | webhooks.enabled | bool | `false` | Enable webhooks |
+
+## Overriding Values
+
+The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
+
+1. Looks for `keyOverride` in the chart's values.yaml
+2. Looks for `global.key` in the chart's or parent chart's values.yaml
+3. Uses the `key` in the chart's values.yaml
+4. Uses the `common.defaults.key` value from the table below.
+
+1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
+
+Example
+```
+1) .Values.deployment.resources.limits.memoryOveride =  4096MB
+2) .Values.global.deployment.resources.limits.memory =  2048MB
+3) .Values.deployment.resources.limits.memory =  1024MB
+4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
+```

charts/account-operator/README.md.gotmpl

@@ -1,31 +1,7 @@
-{{ template "chart.header" . }}
-{{ template "chart.description" . }}
 
-{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+## Requirements
 
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
-{{ template "chart.requirementsSection" . }}
-
-{{ template "chart.valuesHeader" . }}
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example 
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
-{{ template "chart.valuesTable" . }}
+| Repository | Name | Description | Sources |
+|------------|------|-------------|---------|
+| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|
+| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)|

charts/common/Chart.yaml

@@ -4,4 +4,4 @@ description: A Helm chart for Kubernetes
 
 type: library
 
-version: 0.1.8
+version: 0.1.9

charts/common/README.md

@@ -2,31 +2,8 @@
 
 A Helm chart for Kubernetes
 
-![Version: 0.1.8](https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
+![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
 ## Values
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager |
@@ -52,3 +29,22 @@ Example
 | defaults.securityContext.fsGroup | int | `2000` | fsGroup id to run the container |
 | defaults.securityContext.runAsGroup | int | `3000` | group id to run the container |
 | defaults.securityContext.runAsUser | int | `1000` | user id to run the container |
+
+## Overriding Values
+
+The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
+
+1. Looks for `keyOverride` in the chart's values.yaml
+2. Looks for `global.key` in the chart's or parent chart's values.yaml
+3. Uses the `key` in the chart's values.yaml
+4. Uses the `common.defaults.key` value from the table below.
+
+1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
+
+Example
+```
+1) .Values.deployment.resources.limits.memoryOveride =  4096MB
+2) .Values.global.deployment.resources.limits.memory =  2048MB
+3) .Values.deployment.resources.limits.memory =  1024MB
+4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
+```

charts/common/README.md.gotmpl

@@ -1,31 +0,0 @@
-{{ template "chart.header" . }}
-{{ template "chart.description" . }}
-
-{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
-{{ template "chart.requirementsSection" . }}
-
-{{ template "chart.valuesHeader" . }}
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example 
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
-{{ template "chart.valuesTable" . }}

charts/example-content/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "0.126.0"
 description: Helm Chart for the openmfp Portal
 name: example-content
-version: 0.110.15
+version: 0.110.16
 dependencies:
   - name: common
     version: 0.1.8

charts/example-content/README.md

@@ -2,19 +2,20 @@
 
 Helm Chart for the openmfp Portal
 
-![Version: 0.110.15](https://img.shields.io/badge/Version-0.110.15-informational?style=flat-square) ![AppVersion: 0.126.0](https://img.shields.io/badge/AppVersion-0.126.0-informational?style=flat-square)
-
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
 ## Requirements
 
-| Repository | Name | Version |
-|------------|------|---------|
-| oci://ghcr.io/openmfp/helm-charts | common | 0.1.8 |
-
+| Repository | Name | Description | Sources |
+|------------|------|-------------|---------|
+| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|
 ## Values
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name |
+| istio.virtualService.hosts[0] | string | `"your-host.com"` |  |
+| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` |  |
+| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` |  |
+
+## Overriding Values
 
 The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
 
@@ -32,10 +33,3 @@ Example
 3) .Values.deployment.resources.limits.memory =  1024MB
 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
 ```
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name |
-| istio.virtualService.hosts[0] | string | `"your-host.com"` |  |
-| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` |  |
-| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` |  |

charts/example-content/README.md.gotmpl

@@ -1,31 +1,6 @@
-{{ template "chart.header" . }}
-{{ template "chart.description" . }}
 
-{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+## Requirements
 
-## Additional Information
-
-The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and default values that can be used by other charts.
-
-{{ template "chart.requirementsSection" . }}
-
-{{ template "chart.valuesHeader" . }}
-
-The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
-
-1. Looks for `keyOverride` in the chart's values.yaml
-2. Looks for `global.key` in the chart's or parent chart's values.yaml
-3. Uses the `key` in the chart's values.yaml
-4. Uses the `common.defaults.key` value from the table below.
-
-1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
-
-Example 
-```
-1) .Values.deployment.resources.limits.memoryOveride =  4096MB
-2) .Values.global.deployment.resources.limits.memory =  2048MB
-3) .Values.deployment.resources.limits.memory =  1024MB
-4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
-```
-
-{{ template "chart.valuesTable" . }}
+| Repository | Name | Description | Sources |
+|------------|------|-------------|---------|
+| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|