From 35d099fe2d774222114b3d9c7d96f6bae4b9d6ca Mon Sep 17 00:00:00 2001 From: Angel Kafazov Date: Wed, 4 Dec 2024 15:28:43 +0200 Subject: [PATCH] chore(charts): update helm-docs On-behalf-of: @SAP angel.kafazov@sap.com Signed-off-by: Angel Kafazov --- charts/account-operator/README.md | 2 +- charts/example-content/README.md | 2 +- charts/extension-manager-operator/README.md | 2 +- charts/infra/README.md | 45 +++------------------ charts/keycloak/README.md | 23 ++++++++++- charts/keycloak/README.md.gotmpl | 33 +++++++++++++++ charts/openmfp-crds/README.md | 4 +- charts/openmfp/README.md | 6 +-- charts/portal/README.md | 2 +- 9 files changed, 69 insertions(+), 50 deletions(-) create mode 100644 charts/keycloak/README.md.gotmpl diff --git a/charts/account-operator/README.md b/charts/account-operator/README.md index a749e6901..01ed4a94b 100644 --- a/charts/account-operator/README.md +++ b/charts/account-operator/README.md @@ -1,6 +1,6 @@ # account-operator -![Version: 0.4.21](https://img.shields.io/badge/Version-0.4.21-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.108.0](https://img.shields.io/badge/AppVersion-0.108.0-informational?style=flat-square) +![Version: 0.4.22](https://img.shields.io/badge/Version-0.4.22-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.108.0](https://img.shields.io/badge/AppVersion-0.108.0-informational?style=flat-square) A Helm chart for Kubernetes diff --git a/charts/example-content/README.md b/charts/example-content/README.md index 7b1f5cd1f..b77b91aff 100644 --- a/charts/example-content/README.md +++ b/charts/example-content/README.md @@ -1,6 +1,6 @@ # example-content -![Version: 0.110.8](https://img.shields.io/badge/Version-0.110.8-informational?style=flat-square) ![AppVersion: 0.126.0](https://img.shields.io/badge/AppVersion-0.126.0-informational?style=flat-square) +![Version: 0.110.9](https://img.shields.io/badge/Version-0.110.9-informational?style=flat-square) ![AppVersion: 0.126.0](https://img.shields.io/badge/AppVersion-0.126.0-informational?style=flat-square) Helm Chart for the openmfp Portal diff --git a/charts/extension-manager-operator/README.md b/charts/extension-manager-operator/README.md index 4e552b051..1f048cf41 100644 --- a/charts/extension-manager-operator/README.md +++ b/charts/extension-manager-operator/README.md @@ -1,6 +1,6 @@ # extension-manager-operator -![Version: 0.22.34](https://img.shields.io/badge/Version-0.22.34-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.66.0](https://img.shields.io/badge/AppVersion-0.66.0-informational?style=flat-square) +![Version: 0.22.35](https://img.shields.io/badge/Version-0.22.35-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.66.0](https://img.shields.io/badge/AppVersion-0.66.0-informational?style=flat-square) A Helm chart for extension-manager-operator diff --git a/charts/infra/README.md b/charts/infra/README.md index 8a41f9cd3..f34cdf336 100644 --- a/charts/infra/README.md +++ b/charts/infra/README.md @@ -1,42 +1,5 @@ # infra -A Helm chart for Kubernetes - -![Version: 0.57.2](https://img.shields.io/badge/Version-0.57.2-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) - -## Configuration - -The chart supports the following configuration parameters in the table below. Additionally, default configuration parameters documented in [common/README.md](../common/README.md) are not explicitely listed in the table but are also supported. - -## Values - -Default configuration parameters, which can be overriden either globally or on a chart level are documented in [common/README.md](../common/README.md). - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| auth | string | `nil` | | -| certificate.gardener.enabled | bool | `false` | | -| clusterRole.enabled | bool | `false` | | -| externalSecrets.accountOperatorSaKubeconfig | string | `"account-operator-sa-kubeconfig"` | | -| gateway.annotations | object | `{}` | | -| gateway.apiVersion | string | `"networking.istio.io/v1"` | | -| gateway.name | string | `"gateway"` | | -| gateway.selector.istio | string | `"gateway"` | | -| gateway.servers[0].hosts[0] | string | `"*"` | | -| gateway.servers[0].port.name | string | `"http"` | | -| gateway.servers[0].port.number | int | `8080` | | -| gateway.servers[0].port.protocol | string | `"HTTP"` | | -| kcp.enabled | bool | `false` | | -| stores | list | `[]` | | - -## Requirements - -| Repository | Name | Version | -|------------|------|---------| -| file://../common | common | 0.1.5 | - -# infra - ![Version: 0.57.2](https://img.shields.io/badge/Version-0.57.2-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) A Helm chart for Kubernetes @@ -51,10 +14,10 @@ A Helm chart for Kubernetes | Key | Type | Default | Description | |-----|------|---------|-------------| -| auth | string | `nil` | | | certificate.gardener.enabled | bool | `false` | | -| clusterRole.enabled | bool | `false` | | | externalSecrets.accountOperatorSaKubeconfig | string | `"account-operator-sa-kubeconfig"` | | +| fga.enabled | bool | `true` | | +| fga.stores | list | `[]` | | | gateway.annotations | object | `{}` | | | gateway.apiVersion | string | `"networking.istio.io/v1"` | | | gateway.name | string | `"gateway"` | | @@ -64,5 +27,7 @@ A Helm chart for Kubernetes | gateway.servers[0].port.number | int | `8080` | | | gateway.servers[0].port.protocol | string | `"HTTP"` | | | kcp.enabled | bool | `false` | | -| stores | list | `[]` | | +| keycloak.enabled | bool | `false` | | +| keycloak.hosts[0] | string | `"login.microsoftonline.com"` | | +| rbac.clusterRole.enabled | bool | `false` | | diff --git a/charts/keycloak/README.md b/charts/keycloak/README.md index 56917793e..08c362f53 100644 --- a/charts/keycloak/README.md +++ b/charts/keycloak/README.md @@ -1,8 +1,12 @@ # keycloak +A Helm chart for Kubernetes + ![Version: 0.59.21](https://img.shields.io/badge/Version-0.59.21-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) -A Helm chart for Kubernetes +## 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 @@ -13,6 +17,23 @@ A Helm chart for Kubernetes ## 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 | |-----|------|---------|-------------| | crossplane.clients | object | `{"openmfp":{"name":"OpenMFP","validRedirectUris":["http://localhost:8000/callback*"]}}` | crossplane clients config | diff --git a/charts/keycloak/README.md.gotmpl b/charts/keycloak/README.md.gotmpl new file mode 100644 index 000000000..94146d84e --- /dev/null +++ b/charts/keycloak/README.md.gotmpl @@ -0,0 +1,33 @@ +{{ 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" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/openmfp-crds/README.md b/charts/openmfp-crds/README.md index 2e00052ba..3f4554bbe 100644 --- a/charts/openmfp-crds/README.md +++ b/charts/openmfp-crds/README.md @@ -1,6 +1,6 @@ # openmfp-crds -![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.0](https://img.shields.io/badge/AppVersion-0.0.0-informational?style=flat-square) +![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.0](https://img.shields.io/badge/AppVersion-0.0.0-informational?style=flat-square) A chart containing CRD Definitions for OpenMFP @@ -8,7 +8,7 @@ A chart containing CRD Definitions for OpenMFP | Repository | Name | Version | |------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | account-operator-crds | 0.1.5 | +| oci://ghcr.io/openmfp/helm-charts | account-operator-crds | 0.1.6 | ## Values diff --git a/charts/openmfp/README.md b/charts/openmfp/README.md index 494d142c2..b03a6df47 100644 --- a/charts/openmfp/README.md +++ b/charts/openmfp/README.md @@ -1,6 +1,6 @@ # openmfp -![Version: 0.0.36](https://img.shields.io/badge/Version-0.0.36-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.0](https://img.shields.io/badge/AppVersion-0.0.0-informational?style=flat-square) +![Version: 0.0.39](https://img.shields.io/badge/Version-0.0.39-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.0](https://img.shields.io/badge/AppVersion-0.0.0-informational?style=flat-square) The OpenMFP chart for Kubernetes @@ -8,8 +8,8 @@ The OpenMFP chart for Kubernetes | Repository | Name | Version | |------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | example-content | 0.110.7 | -| oci://ghcr.io/openmfp/helm-charts | portal | 0.69.142 | +| oci://ghcr.io/openmfp/helm-charts | example-content | 0.110.8 | +| oci://ghcr.io/openmfp/helm-charts | portal | 0.69.143 | ## Values diff --git a/charts/portal/README.md b/charts/portal/README.md index d26ef81ba..f0d6688e2 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -1,6 +1,6 @@ # portal -![Version: 0.69.143](https://img.shields.io/badge/Version-0.69.143-informational?style=flat-square) ![AppVersion: 0.220.0](https://img.shields.io/badge/AppVersion-0.220.0-informational?style=flat-square) +![Version: 0.69.144](https://img.shields.io/badge/Version-0.69.144-informational?style=flat-square) ![AppVersion: 0.220.0](https://img.shields.io/badge/AppVersion-0.220.0-informational?style=flat-square) Helm Chart for the openmfp Portal