Charts

A collection of Helm charts

helm repo add miracum https://miracum.github.io/charts
helm repo update

Note

Also available as OCI artifacts: https://github.com/orgs/miracum/packages?repo_name=charts.

Development

1. (Optional) Setup a KinD cluster with Nginx ingress support

   kind create cluster --config=hack/kind-config.yaml
   kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml

2. Make changes to the charts

3. Mount the folder in the kube-powertools container to easily run linters and checks

   docker run --rm -it -v $PWD:/root/workspace ghcr.io/chgl/kube-powertools:v2.3.44@sha256:8cc17596d1d6d83ab25c32b45fe5ddbe7add14ad3042bde31cb5339bc5bbce3f

4. Bump the version in the changed Chart.yaml according to SemVer (The ct lint step below will complain if you forget to update the version).

5. Run chart-testing and the chart-powerlint.sh script to lint the chart

   ct lint --config .github/ct/ct.yaml && chart-powerlint.sh

   Info: Sometimes for that to work you need to update the commons chart, like e.g. for blaze:

   helm dependency update charts/blaze

   because else it will throw errors like:

   ==> Linting charts/blaze
   [ERROR] templates/: template: blaze/templates/tests/test-connection.yaml:25:21: executing "blaze/templates/tests/test-connection.yaml" at <include "common.resources.preset" (dict "type" .Values.tests.resourcesPreset)>: error calling include: template: no template "common.resources.preset" associated with template "gotpl"

6. (Optional) View the results of the polaris audit check in your browser

   $ docker run --rm -it -p 9090:8080 -v $PWD:/root/workspace ghcr.io/chgl/kube-powertools:v2.3.44@sha256:8cc17596d1d6d83ab25c32b45fe5ddbe7add14ad3042bde31cb5339bc5bbce3f
   bash-5.0: helm template charts/fhir-gateway/ | polaris dashboard --config .polaris.yaml --audit-path -

   You can now open your browser at http://localhost:9090 and see the results and recommendations.

7. Run generate-docs.sh to auto-generate an updated README

   generate-docs.sh