Skip to content

deliveryhero/helm-charts

Repository files navigation

Helm Charts @ Delivery Hero

Delivery Hero ❤️ Helm

Delivery Hero are big fans of Kubernetes and use Helm extensively. Here we have collected a few charts that are used across our organisation.

TLDR

helm install my-release oci://ghcr.io/deliveryhero/helm-charts/<chart>

Chart list

Artifact HUB

Contributing

Contributions are welcome ❤️

This repository has multiple Github Actions to ensure quality is high, these include:

All chart README.md files are generated from a template. This ensures all values are documented and that formatting is consistent. See here about how the table of values is produced and how to add descriptions to your chart values.

Opening a PR

Follow these steps:

  1. Fork this repo
  2. Make desired changes to the chart
  3. Bump the chart version
  4. Regenerate the chart README.md. Run from the repo root: docker run --rm -v "${PWD}:/helm-docs" jnorwood/helm-docs:v1.11.3 --template-files ./ci/README.md.gotmpl
  5. Commit and push changes
  6. Open 1 pull request per chart you want to change
  7. Set pull request title to [stable/<chart name>]: <description>

Running CI tests locally

All commands to be run from the root of this repo.

chart-testing:

brew install chart-testing
pip3 install yamale yamllint
ct lint --charts stable/<chart>

markdown-lint:

docker run --rm -v "$PWD:/helm-charts" avtodev/markdown-lint:v1.5.0 --config /helm-charts/ci/markdown-lint.yaml /helm-charts/**/*.md

helm-docs:

To generate chart README.md files from the template, you can run helm-docs via docker:

docker run --rm -v "$(git rev-parse --show-toplevel):/helm-docs" jnorwood/helm-docs:v1.11.3 --template-files ./ci/README.md.gotmpl

Or alternatively install via pre-commit:

pre-commit install
pre-commit install-hooks

helm-conftest:

brew tap instrumenta/instrumenta
brew install conftest
sh ci/helm-conftest.sh

License

Copyright © 2023 Delivery Hero

Contents of this repository and any charts without a specific license are licensed under the Apache-2.0 License. Some charts may have their own respective license at <chart>/LICENSE. When adding a new chart to this repository and the chart is copied from another repository then include the license from the source if is not Apache-2.0 and include a link to the source under the sources section in <chart>/Chart.yaml.