chore(charts): update helm-docs

On-behalf-of: @SAP angel.kafazov@sap.com Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>
openmfp · Dec 4, 2024 · 35d099f · 35d099f
1 parent 23c8c2e
commit 35d099f
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 50 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,14 +1,14 @@
 # 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
 
 ## Requirements
 
 | 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
@@ -1,15 +1,15 @@
 # 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
 
 ## Requirements
 
 | 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
@@ -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