From 9fa80f402843e7c1174d42217749c4f3a852b069 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastian=20Echterh=C3=B6lter?= Date: Tue, 10 Dec 2024 11:06:17 +0100 Subject: [PATCH] docs: increasing reuse of chart doc templates --- Taskfile.yaml | 2 +- charts/account-operator-crds/README.md | 20 ++++--- charts/account-operator/README.md | 52 +++++++++---------- charts/account-operator/README.md.gotmpl | 34 ++---------- charts/common/README.md | 42 ++++++++++++--- charts/common/README.md.gotmpl | 31 ----------- charts/example-content/README.md | 28 ++++------ charts/example-content/README.md.gotmpl | 33 ++---------- .../extension-manager-operator-crds/README.md | 18 ++++--- .../README.md.gotmpl | 31 ----------- charts/extension-manager-operator/README.md | 30 +++++------ .../README.md.gotmpl | 34 ++---------- charts/infra/README.md | 11 ++-- charts/infra/README.md.gotmpl | 36 ++----------- charts/keycloak/README.md | 52 +++++++++---------- charts/keycloak/README.md.gotmpl | 34 ++---------- charts/openmfp-crds/README.md | 25 ++++----- charts/openmfp-crds/README.md.gotmpl | 33 ++---------- charts/openmfp/README.md | 25 ++++----- charts/openmfp/README.md.gotmpl | 33 ++---------- charts/portal/README.md | 50 ++++++++---------- charts/portal/README.md.gotmpl | 33 ++---------- .../footer.md.gotmpl | 18 ++----- docs-templates/header.md.gotmpl | 4 ++ 24 files changed, 224 insertions(+), 485 deletions(-) delete mode 100644 charts/common/README.md.gotmpl delete mode 100644 charts/extension-manager-operator-crds/README.md.gotmpl rename charts/account-operator-crds/README.md.gotmpl => docs-templates/footer.md.gotmpl (65%) create mode 100644 docs-templates/header.md.gotmpl diff --git a/Taskfile.yaml b/Taskfile.yaml index 367959c67..88259fcfb 100644 --- a/Taskfile.yaml +++ b/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" \ No newline at end of file + - "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" \ No newline at end of file diff --git a/charts/account-operator-crds/README.md b/charts/account-operator-crds/README.md index 3df7dfc05..e686137bd 100644 --- a/charts/account-operator-crds/README.md +++ b/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,15 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` +# account-operator-crds + +![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) + +A Helm chart for Kubernetes + +## Values | Key | Type | Default | Description | |-----|------|---------|-------------| | kcp.enabled | bool | `false` | Enable KCP | + diff --git a/charts/account-operator/README.md b/charts/account-operator/README.md index 1012c3a7e..fae16ada9 100644 --- a/charts/account-operator/README.md +++ b/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 +``` diff --git a/charts/account-operator/README.md.gotmpl b/charts/account-operator/README.md.gotmpl index 4afb525d8..771b3fe97 100644 --- a/charts/account-operator/README.md.gotmpl +++ b/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)| diff --git a/charts/common/README.md b/charts/common/README.md index 607061bef..4155f8391 100644 --- a/charts/common/README.md +++ b/charts/common/README.md @@ -2,13 +2,35 @@ 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 +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager | +| defaults.deployment.maxSurge | int | `5` | maxSurge | +| defaults.deployment.maxUnavailable | int | `0` | maxUnavailable | +| defaults.deployment.resources.limits | object | `{"cpu":"100m","memory":"512Mi"}` | cpu and memory limits for the deployment | +| defaults.deployment.resources.requests | object | `{"cpu":"40m","memory":"50Mi"}` | cpu and memory requests for the deployment | +| defaults.deployment.revisionHistoryLimit | int | `3` | deployment revision history limit | +| defaults.deployment.strategy | string | `"RollingUpdate"` | deployment strategy | +| defaults.externalSecrets.enabled | bool | `true` | toggle to enable/disable external-secrets | +| defaults.fga.enabled | bool | `false` | toggle to enable/disable experimental FGA features | +| defaults.health.liveness | object | `{"failureThreshold":1,"path":"/healthz"}` | liveness probe parameters | +| defaults.health.periodSeconds | int | `10` | health period | +| defaults.health.port | int | `8081` | health port | +| defaults.health.readiness | object | `{"initialDelaySeconds":5,"path":"/readyz","periodSeconds":10}` | readiness probe parameters | +| defaults.health.startup | object | `{"failureThreshold":30,"path":"/readyz"}` | startup probe parameters | +| defaults.imagePullPolicy | string | `"Always"` | imagePullPolicy is the policy to use when pulling images for all charts | +| defaults.imagePullSecret | string | `"github"` | imagePullSecret is the name of the secret that holds the docker registry credentials | +| defaults.istio.enabled | bool | `false` | toggle to enable/disable istio | +| defaults.istio.gateway.name | string | `"gateway"` | name of the gateway | +| defaults.metrics.port | int | `8080` | metrics port | +| defaults.port | int | `8080` | service port | +| 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: @@ -26,6 +48,13 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` +# common + +![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) + +A Helm chart for Kubernetes + +## Values | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -52,3 +81,4 @@ 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 | + diff --git a/charts/common/README.md.gotmpl b/charts/common/README.md.gotmpl deleted file mode 100644 index 4afb525d8..000000000 --- a/charts/common/README.md.gotmpl +++ /dev/null @@ -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" . }} diff --git a/charts/example-content/README.md b/charts/example-content/README.md index fa8f55d5b..b2b0b8a7a 100644 --- a/charts/example-content/README.md +++ b/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/"` | | diff --git a/charts/example-content/README.md.gotmpl b/charts/example-content/README.md.gotmpl index 4afb525d8..be5dc995e 100644 --- a/charts/example-content/README.md.gotmpl +++ b/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)| diff --git a/charts/extension-manager-operator-crds/README.md b/charts/extension-manager-operator-crds/README.md index d97e50d08..dfdea5f93 100644 --- a/charts/extension-manager-operator-crds/README.md +++ b/charts/extension-manager-operator-crds/README.md @@ -2,13 +2,12 @@ A Helm chart for Kubernetes -![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-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 | +|-----|------|---------|-------------| + +## 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,6 +25,9 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` +# extension-manager-operator-crds + +![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-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 -| Key | Type | Default | Description | -|-----|------|---------|-------------| diff --git a/charts/extension-manager-operator-crds/README.md.gotmpl b/charts/extension-manager-operator-crds/README.md.gotmpl deleted file mode 100644 index 4afb525d8..000000000 --- a/charts/extension-manager-operator-crds/README.md.gotmpl +++ /dev/null @@ -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" . }} diff --git a/charts/extension-manager-operator/README.md b/charts/extension-manager-operator/README.md index 47f8b6915..570abc45a 100644 --- a/charts/extension-manager-operator/README.md +++ b/charts/extension-manager-operator/README.md @@ -2,20 +2,23 @@ A Helm chart for extension-manager-operator -![Version: 0.22.44](https://img.shields.io/badge/Version-0.22.44-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.77.0](https://img.shields.io/badge/AppVersion-0.77.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 | common | 0.1.8 | -| oci://ghcr.io/openmfp/helm-charts | extension-manager-operator-crds | 0.1.5 | - +| 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` | `extension-manager-operator-crds` | The `extension-manager-operator-crds` chart provides CRDS introduced by the `extension-manager-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds)| ## Values +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| commonAnnotations | object | `{}` | | +| crds.enabled | bool | `true` | | +| image.name | string | `"ghcr.io/openmfp/extension-content-operator"` | | +| image.tag | string | `"0.16.0"` | | + +## 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: @@ -33,10 +36,3 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| commonAnnotations | object | `{}` | | -| crds.enabled | bool | `true` | | -| image.name | string | `"ghcr.io/openmfp/extension-content-operator"` | | -| image.tag | string | `"0.16.0"` | | diff --git a/charts/extension-manager-operator/README.md.gotmpl b/charts/extension-manager-operator/README.md.gotmpl index 4afb525d8..e08022fa0 100644 --- a/charts/extension-manager-operator/README.md.gotmpl +++ b/charts/extension-manager-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` | `extension-manager-operator-crds` | The `extension-manager-operator-crds` chart provides CRDS introduced by the `extension-manager-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds)| diff --git a/charts/infra/README.md b/charts/infra/README.md index eb238489c..cf28d2a04 100644 --- a/charts/infra/README.md +++ b/charts/infra/README.md @@ -4,16 +4,11 @@ The infra openmfp chart configures a number of common infrastructure components ![Type: application](https://img.shields.io/badge/Type-application-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 | Sources | -|------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | common | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| - +| 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 | |-----|------|---------|-------------| diff --git a/charts/infra/README.md.gotmpl b/charts/infra/README.md.gotmpl index ded489916..be5dc995e 100644 --- a/charts/infra/README.md.gotmpl +++ b/charts/infra/README.md.gotmpl @@ -1,36 +1,6 @@ -{{ template "chart.header" . }} -{{ template "chart.description" . }} - -{{ template "chart.typeBadge" . }} - -## 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 | Sources | -|------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | common | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| - -{{ template "chart.valuesHeader" . }} -{{ template "chart.valuesTable" . }} - -## 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 -``` +| 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)| diff --git a/charts/keycloak/README.md b/charts/keycloak/README.md index d476c49fb..23cf71a04 100644 --- a/charts/keycloak/README.md +++ b/charts/keycloak/README.md @@ -2,38 +2,15 @@ A Helm chart for Kubernetes -![Version: 0.59.28](https://img.shields.io/badge/Version-0.59.28-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) ## Requirements -| Repository | Name | Version | -|------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | common | 0.1.8 | -| oci://registry-1.docker.io/bitnamicharts | keycloak(keycloak) | 24.2.3 | - +| Repository | Name | Description | Sources | +|------------|------|-------------|---------| +| `oci://registry-1.docker.io/bitnamicharts` | `keycloak` | The open source bitnami keycloak chart to deploy keycloak. | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | +| `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 - -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.openmfp.name | string | `"OpenMFP"` | name of the client | @@ -94,3 +71,22 @@ Example | keycloakConfig.userRegistration.enabled | bool | `true` | toggle to enable/disable user registration | | service | object | `{"name":"keycloak"}` | service configuration | | service.name | string | `"keycloak"` | service name | + +## 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 +``` diff --git a/charts/keycloak/README.md.gotmpl b/charts/keycloak/README.md.gotmpl index 4afb525d8..e6d3d402e 100644 --- a/charts/keycloak/README.md.gotmpl +++ b/charts/keycloak/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://registry-1.docker.io/bitnamicharts` | `keycloak` | The open source bitnami keycloak chart to deploy keycloak. | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | +| `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)| diff --git a/charts/openmfp-crds/README.md b/charts/openmfp-crds/README.md index f232692e2..5afedda8a 100644 --- a/charts/openmfp-crds/README.md +++ b/charts/openmfp-crds/README.md @@ -2,20 +2,22 @@ A chart containing CRD Definitions for OpenMFP -![Version: 0.0.8](https://img.shields.io/badge/Version-0.0.8-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) - -## 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 | extension-manager-operator-crds | 0.1.5 | +| Repository | Name | Description | Sources | +|------------|------|-------------|---------| +| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The openmfp account-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)| +| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator-crds` | The openmfp extension-manager-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds)| ## Values +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| account-operator-crds.enabled | bool | `true` | | +| extension-manager-operator-crds.enabled | bool | `true` | | + +## 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: @@ -33,8 +35,3 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| account-operator-crds.enabled | bool | `true` | | -| extension-manager-operator-crds.enabled | bool | `true` | | diff --git a/charts/openmfp-crds/README.md.gotmpl b/charts/openmfp-crds/README.md.gotmpl index 4afb525d8..d3b7cc3b8 100644 --- a/charts/openmfp-crds/README.md.gotmpl +++ b/charts/openmfp-crds/README.md.gotmpl @@ -1,31 +1,8 @@ -{{ template "chart.header" . }} -{{ template "chart.description" . }} -{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} +## Requirements -## Additional Information +| Repository | Name | Description | Sources | +|------------|------|-------------|---------| +| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The openmfp account-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)| +| `oci://ghcr.io/openmfp/helm-charts` | `extension-manager-operator-crds` | The openmfp extension-manager-operator-crds chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/extension-manager-operator-crds)| -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" . }} diff --git a/charts/openmfp/README.md b/charts/openmfp/README.md index 32ba65675..20671e86d 100644 --- a/charts/openmfp/README.md +++ b/charts/openmfp/README.md @@ -2,20 +2,22 @@ The OpenMFP chart for Kubernetes -![Version: 0.0.61](https://img.shields.io/badge/Version-0.0.61-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) - -## 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 | example-content | 0.110.14 | -| oci://ghcr.io/openmfp/helm-charts | portal | 0.69.165 | +| Repository | Name | Description | Sources | +|------------|------|-------------|---------| +| `oci://ghcr.io/openmfp/helm-charts` | `portal` | The openmfp portal chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/portal)| +| `oci://ghcr.io/openmfp/helm-charts` | `example-content` | The openmfp example-content chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/example-content)| ## Values +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| components.example-content.enabled | bool | `false` | | +| components.portal.enabled | bool | `true` | | + +## 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: @@ -33,8 +35,3 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| components.example-content.enabled | bool | `false` | | -| components.portal.enabled | bool | `true` | | diff --git a/charts/openmfp/README.md.gotmpl b/charts/openmfp/README.md.gotmpl index 4afb525d8..037f1dbcc 100644 --- a/charts/openmfp/README.md.gotmpl +++ b/charts/openmfp/README.md.gotmpl @@ -1,31 +1,8 @@ -{{ template "chart.header" . }} -{{ template "chart.description" . }} -{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} +## Requirements -## Additional Information +| Repository | Name | Description | Sources | +|------------|------|-------------|---------| +| `oci://ghcr.io/openmfp/helm-charts` | `portal` | The openmfp portal chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/portal)| +| `oci://ghcr.io/openmfp/helm-charts` | `example-content` | The openmfp example-content chart. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/example-content)| -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" . }} diff --git a/charts/portal/README.md b/charts/portal/README.md index 106905144..386d70db8 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -2,37 +2,12 @@ Helm Chart for the openmfp Portal -![Version: 0.69.166](https://img.shields.io/badge/Version-0.69.166-informational?style=flat-square) ![AppVersion: 0.237.0](https://img.shields.io/badge/AppVersion-0.237.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 - -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 | |-----|------|---------|-------------| | developmentLandcsape | string | `"true"` | development landscape toggle | @@ -52,3 +27,22 @@ Example | trust.openmfp.tokenUrl | string | `"https://auth.provider.external/realms/openmfp/protocol/openid-connect/token"` | token url (if discoveryEndpoint is not specified) | | validWebcomponentUrls | string | `".?"` | | | virtualService.hosts | list | `["*"]` | virtual service hosts | + +## 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 +``` diff --git a/charts/portal/README.md.gotmpl b/charts/portal/README.md.gotmpl index 4afb525d8..be5dc995e 100644 --- a/charts/portal/README.md.gotmpl +++ b/charts/portal/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)| diff --git a/charts/account-operator-crds/README.md.gotmpl b/docs-templates/footer.md.gotmpl similarity index 65% rename from charts/account-operator-crds/README.md.gotmpl rename to docs-templates/footer.md.gotmpl index 4afb525d8..2993d7f7e 100644 --- a/charts/account-operator-crds/README.md.gotmpl +++ b/docs-templates/footer.md.gotmpl @@ -1,15 +1,7 @@ -{{ 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" . }} +{{ template "chart.valuesTable" . }} + +## 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: @@ -20,12 +12,10 @@ The values in the `defaults:` section can be reused from other charts by using t 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 +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" . }} diff --git a/docs-templates/header.md.gotmpl b/docs-templates/header.md.gotmpl new file mode 100644 index 000000000..8bf635b54 --- /dev/null +++ b/docs-templates/header.md.gotmpl @@ -0,0 +1,4 @@ +{{ template "chart.header" . }} +{{ template "chart.description" . }} + +{{ template "chart.typeBadge" . }}