The Kluctl Library for Kubernetes
Helm Charts provided by kluctl.
Prerequisites
- Kubernetes 1.19+
- Helm 3.2.0+
Install
$ helm repo add kluctl http://kluctl.github.io/charts
$ helm search repo kluctl
$ helm install my-release kluctl/<chart>
Contribute
In order to contribute please create a pull request and read the following guidelines depending on your type of change.
IMPORTANT: Because this project follows the conventional commit specification, each commit for a chart needs to include the type as well as the corresponding scope so that our tooling can determine the new chart version automatically (e.g. feat(flux-kluctl-controller): this a valid commit
).
General information
- Check that all commits are signed with a valid GPG key and that each commit includes a sign-off to certify that you accept the https://developercertificate.org/.
- Check that the charts are still working by running
task template-all-charts
. - Check that all charts are formatted correctly by running
task lint-all-charts
.
Bump the operator version
- Check the version of the operator and replace it in the
appVersion
of the chart. - Update the CRDs by running
task download-crds-CHART_FOLDER
(Check if any new CRDs are introduced as part of the new operator version and add them to the task insideTaskfile.yml
). - Update the RBAC resources by running
task download-rbac-CHART_FOLDER
(Check if any new RBAC resources are introduced as part of the new operator version and add them to the task insideTaskfile.yml
). - Create a commit following the conventional commit specification (Don't miss the scope!).
- Check if all charts are still working by running
task template-all-charts
. - Check if all charts are formatted correctly by running
task lint-all-charts
. - Create a pull request.
Introduce changes to a chart
- Change something in a chart.
- Create one or multiple commits following the conventional commit specification (Don't miss the scope!).
- Check if all charts are still working by running
task template-all-charts
. - Check if all charts are formatted correctly by running
task lint-all-charts
. - Create a pull request.
Create a new release
- Check if all charts are still working by running
task template-all-charts
. - Check if all charts are formatted correctly by running
task lint-all-charts
. - Prepare the release (Bump chart, Create Changelog, Create README) by running
task prepare-release-CHART_FOLDER
. - Create the release commit by running
task create-release-commit-CHART_FOLDER
. - Create a pull request.