KT Helm Charts

Helm Chart Repo Usage

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

  helm repo add klicktipp https://klicktipp.github.io/helm-charts/

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo klicktipp to see the charts.

To install the <chart-name> chart:

    helm install my-<chart-name> klicktipp/<chart-name>

To uninstall the chart:

    helm delete my-<chart-name>

Creating/Updating Charts

• Pull latest main branch changes
• Branch out with the name ${chartname}-chart
• Put all your changes on this branch and push
• Bump the Chart.yaml version and push
• Create a merge request and let it approve and be merged to the main branch
• After successful merging, Github Actions (bot) will automagically create a tag on the main branch with the name of the chart and the latest chart version. Example: redisinsight-0.2.0.
• The release workflow now uses GitHub auto-generated release notes (PR-focused What's Changed) and updates each chart release description automatically.
• Now the chart index (in the gh-pages) has been updated with the latest chart changes: https://github.com/klicktipp/helm-charts/blob/gh-pages/index.yaml

Chart Documentation (values -> README)

This repository uses helm-docs and local scripts to keep chart README files in sync with values.yaml.

Install helm-docs:

go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.14.2

Validate values documentation comments (# -- ...) for one chart:

scripts/check-values-docs.sh charts/n8n/values.yaml

Generate/refresh chart README files from values:

scripts/generate-chart-readmes.sh

Check README consistency for one chart:

scripts/check-readme-consistency.sh charts/n8n

For all charts, run:

scripts/check-values-docs.sh
scripts/check-readme-consistency.sh