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. (Optional) With Calico as a CNI to test NetworkPolicy resources

   kind create cluster --config hack/kind-config-calico.yaml
   kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/v3.30.2/manifests/operator-crds.yaml
   kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/v3.30.2/manifests/tigera-operator.yaml
   kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/v3.30.2/manifests/custom-resources.yaml
   watch kubectl get pods -l k8s-app=calico-node -A

3. Make changes to the charts

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. 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.4.5@sha256:3d98a9f3a7191f06924b2d7b0feb5ba13fe95bb72d842d3373d3dffffb5caddd

6. 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"

7. (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.4.5@sha256:3d98a9f3a7191f06924b2d7b0feb5ba13fe95bb72d842d3373d3dffffb5caddd
   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.

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

   generate-docs.sh