Creating or updating a chart

The following workflows demonstrate how to create new charts or update existing ones and publish them with helm. Information about the expected file structure for charts can be found in the Helm documentation.

Creating a new chart

  • Create a new branch and create the new chart in a folder /charts/<new_chart>. This will contain, at least, Chart.yaml, CHANGELOG.md, README.md and values.yaml files.

  • The Chart.yaml file should contain a version number and this should be recorded in CHANGELOG.md.

  • Described the purpose and functionality of the chart in README.md.

  • Create a documentation file /docs/src/charts/ska-sdp-helmdeploy-<new_chart>.rst and link this to the README.md - as for the existing charts.

  • Update /docs/src/index.rst.

  • Add the new chart to the HELM_CHARTS_TO_PUBLISH variable in the Makefile. This will publish an initial version of the chart.

  • Test the chart. For the latest details on how to test the chart, refer to this page.

  • Create a merge request and get it approved and merged.

Updating an existing chart

  • Create a new branch and update the chosen chart as needed.

  • Update the version number of your chart in Chart.yaml.

  • Document your change in CHANGELOG.md.

  • Update the chart README.md, and commit and push the changes.

  • Test the chart, make sure it is backwards compatible. If not, dependencies are also updated.

  • Create a merge request and get it approved and merged.