Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.01 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.01 KB
Raw

Charts

OpenSSF Scorecard

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) Install the pre-commit hooks

    pip install pre-commit
pre-commit install

  2. (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

  3. Make changes to the charts

  4. 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.30@sha256:b7e588f30df97635c271e49ebd15e84c3d2845a67f0eaf20e9c273ad269b2964

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

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

  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.30@sha256:b7e588f30df97635c271e49ebd15e84c3d2845a67f0eaf20e9c273ad269b2964
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

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