Creating or updating a chart

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.

• Chart purpose and functionality should be fully described in README.md.

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

• Update /docs/src/index.rst.

• Packaging your new chart:

  cd ska-sdp-helmdeploy-charts
  helm package charts/<new_chart> -d chart-repo
  helm repo index chart-repo
  

  Make sure you replace <new_chart> with the actual chart name.

• Test the chart.

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

• Your chart is now available to be accessed from the chart-repo directory.

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.

• Packaging your new chart:

  cd ska-sdp-helmdeploy-charts
  helm package charts/<updated_chart> -d chart-repo
  helm repo index chart-repo
  

  Make sure you replace <updated_chart> with the actual chart name.

• Do NOT remove older versions of <updated_chart> in chart-repo as they should still be available versions.

• 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.

• Your chart is now available to be accessed from the chart-repo directory.