helm-charts

Reusable Helm templates for Kubernetes workloads

Requirements

uv

Development workflows require uv

pre-commit

We use pre-commit to provide a useful signal that versions need to be bumped

uv tool install pre-commit

helm

Helm must be installed for unit tests to run

helm-docs

helm-docs is required during pre-commit runs, installation methods vary by OS:

• MacOS: brew install norwoodj/tap/helm-docs
• Additional info available in repo: https://github.com/norwoodj/helm-docs

Setup

Run make install to ensure uv, pre-commit, and helm are installed.

Additionally, this will install/update the unittest Helm plugin.

Development Helpers

make update-dependencies

Update the helm dependencies of all the charts. Does a depth first travels of the depenency tree to update all chart dependencies. Can be dry-run by setting DRY_RUN=1

make update-dependencies DRY_RUN=1

make bump-charts

By default it will bump the chart versions of the charts that are staged to be committed. This works well in tandem with the pre-commit hook that checks if charts need a version bump. It is also possible to pass individual chart names to the make target. Default:

make bump-charts

With arguments:

make bump-charts mozcloud-preview-lib

make unit-tests

This will run the unit tests for all application charts. Run make install if the unittest Helm plugin is not installed.

Run unit tests:

make unit-tests

Run unit tests and update snapshots:

make unit-tests UPDATE_SNAPSHOTS=1  # The following all translate as "true": 1, true, yes