Skip to main content

Publish a Helm Chart

What is a Helm Chart?​

Helm is a package manager for Kubernetes. It simplifies deploying and managing applications by packaging them into charts, which include:

  • Kubernetes resources: definitions of the Kubernetes resources (like Deployments, Services, etc.) that make up your application.
  • Configuration values: default values for the resources, which can be overridden at deployment time.
  • Dependencies: other charts that your chart depends on.
  • Metadata: information about the chart, such as its name, version, and description.
  • Templates: files that define how the Kubernetes resources should be rendered based on the configuration values.
  • OCI support: Helm charts can be stored in OCI-compliant registries, allowing for better integration with container images and other artifacts.
  • Versioning: information about the chart's versioning, allowing for easy upgrades and rollbacks.
  • Release management: Helm provides commands to manage the lifecycle of your applications, including installation, upgrading, and deleting releases.

For more information, check out the official Helm documentation or the Helm GitHub repository.

Publish a Helm Chart to the Katapult Container Registry​

Before You Start

This guide assumes you already have a Helm chart prepared. If not, refer to the official Helm documentation for help creating one.

Log in to the Katapult Container Registry​

Use the following command:

helm registry login kcr.io

You'll be prompted to enter your username and password (API token).

You can also do this non-interactively:

helm registry login kcr.io -u <username> -p <user-api-token>

Replace <username> and <user-api-token> with your actual credentials.

Package the Helm Chart​

Use the following command to package your Helm chart:

helm package <chart-directory>

Replace <chart-directory> with the path to your Helm chart directory. This will create a .tgz file containing your chart.

Publish the Helm Chart​

Use the following command to publish your Helm chart to the Katapult Container Registry:

helm push <chart-file> oci://kcr.io/<org-subdomain>/<chart-name>

Replace the placeholders:

  • <chart-file> with the path to your packaged Helm chart file,
  • <org-name> with your desired organization name, and
  • <chart-name> with the name of your chart.

Verify the Helm Chart Publication​

After publishing, you can verify that your Helm chart was successfully uploaded by logging into the Katapult UI and navigating to your container registry.

Viewing Remote Chart Versions​

To view available versions of a Helm chart stored in the Katapult Container Registry, you can use the following command:

helm show all oci://kcr.io/<org-subdomain>/<chart-name>