diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml deleted file mode 100644 index 763d10ab4..000000000 --- a/.github/workflows/helm-docs.yaml +++ /dev/null @@ -1,20 +0,0 @@ -name: Check if helm-docs are up-to-date -on: - - pull_request - - push - -jobs: - - check-helm-docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - ref: ${{ github.event.pull_request.head.ref }} - - name: Run helm-docs - uses: losisin/helm-docs-github-action@v1 - with: - fail-on-diff: true - chart-search-root: charts/ - template-files: README.md.gotmpl - git-push: false 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/Chart.yaml b/charts/account-operator-crds/Chart.yaml index f48fc01dd..235ca2a7a 100644 --- a/charts/account-operator-crds/Chart.yaml +++ b/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" diff --git a/charts/account-operator-crds/README.md b/charts/account-operator-crds/README.md index 3df7dfc05..2f54e9ca1 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,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 | diff --git a/charts/account-operator-crds/README.md.gotmpl b/charts/account-operator-crds/README.md.gotmpl index 4afb525d8..e69de29bb 100644 --- a/charts/account-operator-crds/README.md.gotmpl +++ b/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" . }} diff --git a/charts/account-operator/Chart.yaml b/charts/account-operator/Chart.yaml index a82d55ec8..f14addbb3 100644 --- a/charts/account-operator/Chart.yaml +++ b/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 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/Chart.yaml b/charts/common/Chart.yaml index 57dca4e09..2f0b8023c 100644 --- a/charts/common/Chart.yaml +++ b/charts/common/Chart.yaml @@ -4,4 +4,4 @@ description: A Helm chart for Kubernetes type: library -version: 0.1.8 +version: 0.1.9 diff --git a/charts/common/README.md b/charts/common/README.md index 607061bef..39f65c9e3 100644 --- a/charts/common/README.md +++ b/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 +``` diff --git a/charts/common/README.md.gotmpl b/charts/common/README.md.gotmpl index 4afb525d8..e69de29bb 100644 --- a/charts/common/README.md.gotmpl +++ b/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" . }} diff --git a/charts/example-content/Chart.yaml b/charts/example-content/Chart.yaml index 45b91cd26..d35b7712b 100644 --- a/charts/example-content/Chart.yaml +++ b/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 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/Chart.yaml b/charts/extension-manager-operator-crds/Chart.yaml index 5a9ed798b..b5d6fc0e2 100644 --- a/charts/extension-manager-operator-crds/Chart.yaml +++ b/charts/extension-manager-operator-crds/Chart.yaml @@ -3,5 +3,5 @@ name: extension-manager-operator-crds description: A Helm chart for Kubernetes type: application -version: 0.1.5 -appVersion: "1.16.0" +version: 0.1.6 +appVersion: "0.0.0" diff --git a/charts/extension-manager-operator-crds/README.md b/charts/extension-manager-operator-crds/README.md index d97e50d08..b055b416e 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,3 @@ Example 3) .Values.deployment.resources.limits.memory = 1024MB 4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB ``` - -| Key | Type | Default | Description | -|-----|------|---------|-------------| diff --git a/charts/extension-manager-operator-crds/README.md.gotmpl b/charts/extension-manager-operator-crds/README.md.gotmpl index 4afb525d8..e69de29bb 100644 --- a/charts/extension-manager-operator-crds/README.md.gotmpl +++ b/charts/extension-manager-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" . }} diff --git a/charts/extension-manager-operator/Chart.yaml b/charts/extension-manager-operator/Chart.yaml index 2f7e166de..e194e6c22 100644 --- a/charts/extension-manager-operator/Chart.yaml +++ b/charts/extension-manager-operator/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: extension-manager-operator description: A Helm chart for extension-manager-operator type: application -version: 0.22.44 +version: 0.22.45 appVersion: "0.77.0" dependencies: - name: extension-manager-operator-crds 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/Chart.yaml b/charts/infra/Chart.yaml index 078816c65..8bf161269 100644 --- a/charts/infra/Chart.yaml +++ b/charts/infra/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: infra description: The infra openmfp chart configures a number of common infrastructure components for the OpenMFP platform. type: application -version: 0.60.0 +version: 0.60.1 appVersion: "0.0.0" dependencies: 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 acf9f0e76..8aa773b1b 100644 --- a/charts/keycloak/README.md +++ b/charts/keycloak/README.md @@ -2,38 +2,15 @@ A Helm chart for Kubernetes -![Version: 0.59.29](https://img.shields.io/badge/Version-0.59.29-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 | Sources | -|------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | common | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| -| oci://ghcr.io/openmfp/helm-charts | keycloak | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | - +| 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 | @@ -95,3 +72,22 @@ Example | service | object | `{"name":"keycloak","port":8080}` | service configuration | | service.name | string | `"keycloak"` | service name | | service.port | int | `8080` | service port | + +## 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 fce741428..e6d3d402e 100644 --- a/charts/keycloak/README.md.gotmpl +++ b/charts/keycloak/README.md.gotmpl @@ -1,36 +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. ## Requirements -| Repository | Name | Sources | -|------------|------|---------| -| oci://ghcr.io/openmfp/helm-charts | common | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common)| -| oci://ghcr.io/openmfp/helm-charts | keycloak | [source](https://github.com/bitnami/charts/tree/main/bitnami/keycloak) | - -{{ 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/Chart.yaml b/charts/openmfp-crds/Chart.yaml index f68602c6f..2f011f5b8 100644 --- a/charts/openmfp-crds/Chart.yaml +++ b/charts/openmfp-crds/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: openmfp-crds description: A chart containing CRD Definitions for OpenMFP type: application -version: 0.0.8 +version: 0.0.9 appVersion: "0.0.0" dependencies: 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/Chart.lock b/charts/openmfp/Chart.lock index 10f3ace80..9fc3426a9 100644 --- a/charts/openmfp/Chart.lock +++ b/charts/openmfp/Chart.lock @@ -1,9 +1,9 @@ dependencies: - name: example-content repository: oci://ghcr.io/openmfp/helm-charts - version: 0.110.14 + version: 0.110.15 - name: portal repository: oci://ghcr.io/openmfp/helm-charts - version: 0.69.165 -digest: sha256:fe490c50572d5d067ffb52c2383ca4201a691816086f4d6df603f8f2d59871a4 -generated: "2024-12-09T23:21:49.435618684Z" + version: 0.69.168 +digest: sha256:4a745c124de240458c6db64f42be56e5f41ade38dc0d165cf9c60b6364ada13a +generated: "2024-12-10T12:46:52.628237308Z" diff --git a/charts/openmfp/Chart.yaml b/charts/openmfp/Chart.yaml index 24822fe00..54f9cda96 100644 --- a/charts/openmfp/Chart.yaml +++ b/charts/openmfp/Chart.yaml @@ -2,15 +2,15 @@ apiVersion: v2 name: openmfp description: The OpenMFP chart for Kubernetes type: application -version: 0.0.61 +version: 0.0.64 appVersion: "0.0.0" dependencies: - name: example-content - version: 0.110.14 + version: 0.110.15 repository: oci://ghcr.io/openmfp/helm-charts condition: components.example-content.enabled - name: portal - version: 0.69.165 + version: 0.69.168 repository: oci://ghcr.io/openmfp/helm-charts condition: components.portal.enabled 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/openmfp/charts/example-content-0.110.14.tgz b/charts/openmfp/charts/example-content-0.110.14.tgz deleted file mode 100644 index 4e467f8e9..000000000 Binary files a/charts/openmfp/charts/example-content-0.110.14.tgz and /dev/null differ diff --git a/charts/openmfp/charts/example-content-0.110.15.tgz b/charts/openmfp/charts/example-content-0.110.15.tgz new file mode 100644 index 000000000..7d91fdd7c Binary files /dev/null and b/charts/openmfp/charts/example-content-0.110.15.tgz differ diff --git a/charts/openmfp/charts/portal-0.69.165.tgz b/charts/openmfp/charts/portal-0.69.165.tgz deleted file mode 100644 index 571f7edf0..000000000 Binary files a/charts/openmfp/charts/portal-0.69.165.tgz and /dev/null differ diff --git a/charts/openmfp/charts/portal-0.69.168.tgz b/charts/openmfp/charts/portal-0.69.168.tgz new file mode 100644 index 000000000..01a3dd2c2 Binary files /dev/null and b/charts/openmfp/charts/portal-0.69.168.tgz differ diff --git a/charts/portal/Chart.yaml b/charts/portal/Chart.yaml index 753f7fc87..ef319e8a6 100644 --- a/charts/portal/Chart.yaml +++ b/charts/portal/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 -appVersion: "0.237.0" description: Helm Chart for the openmfp Portal name: portal -version: 0.69.167 +version: 0.69.170 +appVersion: "0.239.0" dependencies: - name: common repository: oci://ghcr.io/openmfp/helm-charts diff --git a/charts/portal/README.md b/charts/portal/README.md index ebe452086..eff23d91d 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -2,37 +2,12 @@ Helm Chart for the openmfp Portal -![Version: 0.69.167](https://img.shields.io/badge/Version-0.69.167-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/docs-templates/footer.md.gotmpl b/docs-templates/footer.md.gotmpl new file mode 100644 index 000000000..2993d7f7e --- /dev/null +++ b/docs-templates/footer.md.gotmpl @@ -0,0 +1,21 @@ +{{ 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 +``` 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" . }}