Using Helm

This guide explains the basics of using Helm to manage packages on your Kubernetes cluster. It assumes that you have already installed the Helm client.

If you are simply interested in running a few quick commands, you may wish to begin with the Quickstart Guide. This chapter covers the particulars of Helm commands, and explains how to use Helm.

Three Big Concepts

A Chart is a Helm package. It contains all of the resource definitions necessary to run an application, tool, or service inside of a Kubernetes cluster. Think of it like the Kubernetes equivalent of a Homebrew formula, an Apt dpkg, or a Yum RPM file.

A Repository is the place where charts can be collected and shared. It’s like Perl’s CPAN archive or the Fedora Package Database, but for Kubernetes packages.

A Release is an instance of a chart running in a Kubernetes cluster. One chart can often be installed many times into the same cluster. And each time it is installed, a new release is created. Consider a MySQL chart. If you want two databases running in your cluster, you can install that chart twice. Each one will have its own release, which will in turn have its own release name.

With these concepts in mind, we can now explain Helm like this:

Helm installs charts into Kubernetes, creating a new release for each installation. And to find new charts, you can search Helm chart repositories.

‘helm search’: Finding Charts

Helm comes with a powerful search command. It can be used to search two different types of source:

  • helm search hub searches the Artifact Hub, which lists helm charts from dozens of different repositories.
  • helm search repo searches the repositories that you have added to your local helm client (with helm repo add). This search is done over local data, and no public network connection is needed.

You can find publicly available charts by running helm search hub:

  1. $ helm search hub wordpress
  2. URL                                                 CHART VERSION APP VERSION DESCRIPTION
  3. https://hub.helm.sh/charts/bitnami/wordpress        7.6.7         5.2.4       Web publishing platform for building blogs and ...
  4. https://hub.helm.sh/charts/presslabs/wordpress-...  v0.6.3        v0.6.3      Presslabs WordPress Operator Helm Chart
  5. https://hub.helm.sh/charts/presslabs/wordpress-...  v0.7.1        v0.7.1      A Helm chart for deploying a WordPress site on ...

The above searches for all wordpress charts on Artifact Hub.

With no filter, helm search hub shows you all of the available charts.

Using helm search repo, you can find the names of the charts in repositories you have already added:

  1. $ helm repo add brigade https://brigadecore.github.io/charts
  2. "brigade" has been added to your repositories
  3. $ helm search repo brigade
  4. NAME                          CHART VERSION APP VERSION DESCRIPTION
  5. brigade/brigade               1.3.2         v1.2.1      Brigade provides event-driven scripting of Kube...
  6. brigade/brigade-github-app    0.4.1         v0.2.1      The Brigade GitHub App, an advanced gateway for...
  7. brigade/brigade-github-oauth  0.2.0         v0.20.0     The legacy OAuth GitHub Gateway for Brigade
  8. brigade/brigade-k8s-gateway   0.1.0                     A Helm chart for Kubernetes
  9. brigade/brigade-project       1.0.0         v1.0.0      Create a Brigade project
  10. brigade/kashti                0.4.0         v0.4.0      A Helm chart for Kubernetes

Helm search uses a fuzzy string matching algorithm, so you can type parts of words or phrases:

  1. $ helm search repo kash
  2. NAME            CHART VERSION APP VERSION DESCRIPTION
  3. brigade/kashti  0.4.0         v0.4.0      A Helm chart for Kubernetes

Search is a good way to find available packages. Once you have found a package you want to install, you can use helm install to install it.

‘helm install’: Installing a Package

To install a new package, use the helm install command. At its simplest, it takes two arguments: A release name that you pick, and the name of the chart you want to install.

  1. $ helm install happy-panda bitnami/wordpress
  2. NAME: happy-panda
  3. LAST DEPLOYED: Tue Jan 26 10:27:17 2021
  4. NAMESPACE: default
  5. STATUS: deployed
  6. REVISION: 1
  7. NOTES:
  8. ** Please be patient while the chart is being deployed **
  10. Your WordPress site can be accessed through the following DNS name from within your cluster:
  12.     happy-panda-wordpress.default.svc.cluster.local (port 80)
  14. To access your WordPress site from outside the cluster follow the steps below:
  16. 1. Get the WordPress URL by running these commands:
  18.   NOTE: It may take a few minutes for the LoadBalancer IP to be available.
  19.         Watch the status with: 'kubectl get svc --namespace default -w happy-panda-wordpress'
  21.    export SERVICE_IP=$(kubectl get svc --namespace default happy-panda-wordpress --template "{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}")
  22.    echo "WordPress URL: http://$SERVICE_IP/"
  23.    echo "WordPress Admin URL: http://$SERVICE_IP/admin"
  25. 2. Open a browser and access WordPress using the obtained URL.
  27. 3. Login with the following credentials below to see your blog:
  29.   echo Username: user
  30.   echo Password: $(kubectl get secret --namespace default happy-panda-wordpress -o jsonpath="{.data.wordpress-password}" | base64 --decode)

Now the wordpress chart is installed. Note that installing a chart creates a new release object. The release above is named happy-panda. (If you want Helm to generate a name for you, leave off the release name and use --generate-name.)

During installation, the helm client will print useful information about which resources were created, what the state of the release is, and also whether there are additional configuration steps you can or should take.

Helm installs resources in the following order:

  • Namespace
  • NetworkPolicy
  • ResourceQuota
  • LimitRange
  • PodSecurityPolicy
  • PodDisruptionBudget
  • ServiceAccount
  • Secret
  • SecretList
  • ConfigMap
  • StorageClass
  • PersistentVolume
  • PersistentVolumeClaim
  • CustomResourceDefinition
  • ClusterRole
  • ClusterRoleList
  • ClusterRoleBinding
  • ClusterRoleBindingList
  • Role
  • RoleList
  • RoleBinding
  • RoleBindingList
  • Service
  • DaemonSet
  • Pod
  • ReplicationController
  • ReplicaSet
  • Deployment
  • HorizontalPodAutoscaler
  • StatefulSet
  • Job
  • CronJob
  • Ingress
  • APIService

Helm does not wait until all of the resources are running before it exits. Many charts require Docker images that are over 600M in size, and may take a long time to install into the cluster.

To keep track of a release’s state, or to re-read configuration information, you can use helm status:

  1. $ helm status happy-panda
  2. NAME: happy-panda
  3. LAST DEPLOYED: Tue Jan 26 10:27:17 2021
  4. NAMESPACE: default
  5. STATUS: deployed
  6. REVISION: 1
  7. NOTES:
  8. ** Please be patient while the chart is being deployed **
  10. Your WordPress site can be accessed through the following DNS name from within your cluster:
  12.     happy-panda-wordpress.default.svc.cluster.local (port 80)
  14. To access your WordPress site from outside the cluster follow the steps below:
  16. 1. Get the WordPress URL by running these commands:
  18.   NOTE: It may take a few minutes for the LoadBalancer IP to be available.
  19.         Watch the status with: 'kubectl get svc --namespace default -w happy-panda-wordpress'
  21.    export SERVICE_IP=$(kubectl get svc --namespace default happy-panda-wordpress --template "{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}")
  22.    echo "WordPress URL: http://$SERVICE_IP/"
  23.    echo "WordPress Admin URL: http://$SERVICE_IP/admin"
  25. 2. Open a browser and access WordPress using the obtained URL.
  27. 3. Login with the following credentials below to see your blog:
  29.   echo Username: user
  30.   echo Password: $(kubectl get secret --namespace default happy-panda-wordpress -o jsonpath="{.data.wordpress-password}" | base64 --decode)

The above shows the current state of your release.

Customizing the Chart Before Installing

Installing the way we have here will only use the default configuration options for this chart. Many times, you will want to customize the chart to use your preferred configuration.

To see what options are configurable on a chart, use helm show values:

  1. $ helm show values bitnami/wordpress
  2. ## Global Docker image parameters
  3. ## Please, note that this will override the image parameters, including dependencies, configured to use the global value
  4. ## Current available global Docker image parameters: imageRegistry and imagePullSecrets
  5. ##
  6. # global:
  7. #   imageRegistry: myRegistryName
  8. #   imagePullSecrets:
  9. #     - myRegistryKeySecretName
  10. #   storageClass: myStorageClass
  12. ## Bitnami WordPress image version
  13. ## ref: https://hub.docker.com/r/bitnami/wordpress/tags/
  14. ##
  15. image:
  16.   registry: docker.io
  17.   repository: bitnami/wordpress
  18.   tag: 5.6.0-debian-10-r35
  19.   [..]

You can then override any of these settings in a YAML formatted file, and then pass that file during installation.

  1. $ echo '{mariadb.auth.database: user0db, mariadb.auth.username: user0}' > values.yaml
  2. $ helm install -f values.yaml bitnami/wordpress --generate-name

The above will create a default MariaDB user with the name user0, and grant this user access to a newly created user0db database, but will accept all the rest of the defaults for that chart.

There are two ways to pass configuration data during install:

  • --values (or -f): Specify a YAML file with overrides. This can be specified multiple times and the rightmost file will take precedence
  • --set: Specify overrides on the command line.

If both are used, --set values are merged into --values with higher precedence. Overrides specified with --set are persisted in a ConfigMap. Values that have been --set can be viewed for a given release with helm get values <release-name>. Values that have been --set can be cleared by running helm upgrade with --reset-values specified.

The Format and Limitations of --set

The --set option takes zero or more name/value pairs. At its simplest, it is used like this: --set name=value. The YAML equivalent of that is:

  1. name: value

Multiple values are separated by , characters. So --set a=b,c=d becomes:

  1. a: b
  2. c: d

More complex expressions are supported. For example, --set outer.inner=value is translated into this:

  1. outer:
  2.   inner: value

Lists can be expressed by enclosing values in { and }. For example, --set name={a, b, c} translates to:

  1. name:
  2.   - a
  3.   - b
  4.   - c

Certain name/key can be set to be null or to be an empty array []. For example, --set name=[],a=null translates

  1. name:
  2.   - a
  3.   - b
  4.   - c
  5. a: b

to

  1. name: []
  2. a: null

As of Helm 2.5.0, it is possible to access list items using an array index syntax. For example, --set servers[0].port=80 becomes:

  1. servers:
  2.   - port: 80

Multiple values can be set this way. The line --set servers[0].port=80,servers[0].host=example becomes:

  1. servers:
  2.   - port: 80
  3.     host: example

Sometimes you need to use special characters in your --set lines. You can use a backslash to escape the characters; --set name=value1\,value2 will become:

  1. name: "value1,value2"

Similarly, you can escape dot sequences as well, which may come in handy when charts use the toYaml function to parse annotations, labels and node selectors. The syntax for --set nodeSelector."kubernetes\.io/role"=master becomes:

  1. nodeSelector:
  2.   kubernetes.io/role: master

Deeply nested data structures can be difficult to express using --set. Chart designers are encouraged to consider the --set usage when designing the format of a values.yaml file (read more about Values Files).

More Installation Methods

The helm install command can install from several sources:

  • A chart repository (as we’ve seen above)
  • A local chart archive (helm install foo foo-0.1.1.tgz)
  • An unpacked chart directory (helm install foo path/to/foo)
  • A full URL (helm install foo https://example.com/charts/foo-1.2.3.tgz)

‘helm upgrade’ and ‘helm rollback’: Upgrading a Release, and Recovering on Failure

When a new version of a chart is released, or when you want to change the configuration of your release, you can use the helm upgrade command.

An upgrade takes an existing release and upgrades it according to the information you provide. Because Kubernetes charts can be large and complex, Helm tries to perform the least invasive upgrade. It will only update things that have changed since the last release.

  1. $ helm upgrade -f panda.yaml happy-panda bitnami/wordpress

In the above case, the happy-panda release is upgraded with the same chart, but with a new YAML file:

  1. mariadb.auth.username: user1

We can use helm get values to see whether that new setting took effect.

  1. $ helm get values happy-panda
  2. mariadb:
  3.   auth:
  4.     username: user1

The helm get command is a useful tool for looking at a release in the cluster. And as we can see above, it shows that our new values from panda.yaml were deployed to the cluster.

Now, if something does not go as planned during a release, it is easy to roll back to a previous release using helm rollback [RELEASE] [REVISION].

  1. $ helm rollback happy-panda 1

The above rolls back our happy-panda to its very first release version. A release version is an incremental revision. Every time an install, upgrade, or rollback happens, the revision number is incremented by 1. The first revision number is always 1. And we can use helm history [RELEASE] to see revision numbers for a certain release.

Helpful Options for Install/Upgrade/Rollback

There are several other helpful options you can specify for customizing the behavior of Helm during an install/upgrade/rollback. Please note that this is not a full list of cli flags. To see a description of all flags, just run helm <command> --help.

  • --timeout: A Go duration value to wait for Kubernetes commands to complete. This defaults to 5m0s.
  • --wait: Waits until all Pods are in a ready state, PVCs are bound, Deployments have minimum (Desired minus maxUnavailable) Pods in ready state and Services have an IP address (and Ingress if a LoadBalancer) before marking the release as successful. It will wait for as long as the --timeout value. If timeout is reached, the release will be marked as FAILED. Note: In scenarios where Deployment has replicas set to 1 and maxUnavailable is not set to 0 as part of rolling update strategy, --wait will return as ready as it has satisfied the minimum Pod in ready condition.
  • --no-hooks: This skips running hooks for the command
  • --recreate-pods (only available for upgrade and rollback): This flag will cause all pods to be recreated (with the exception of pods belonging to deployments). (DEPRECATED in Helm 3)

‘helm uninstall’: Uninstalling a Release

When it is time to uninstall a release from the cluster, use the helm uninstall command:

  1. $ helm uninstall happy-panda

This will remove the release from the cluster. You can see all of your currently deployed releases with the helm list command:

  1. $ helm list
  2. NAME            VERSION UPDATED                         STATUS          CHART
  3. inky-cat        1       Wed Sep 28 12:59:46 2016        DEPLOYED        alpine-0.1.0

From the output above, we can see that the happy-panda release was uninstalled.

In previous versions of Helm, when a release was deleted, a record of its deletion would remain. In Helm 3, deletion removes the release record as well. If you wish to keep a deletion release record, use helm uninstall --keep-history. Using helm list --uninstalled will only show releases that were uninstalled with the --keep-history flag.

The helm list --all flag will show you all release records that Helm has retained, including records for failed or deleted items (if --keep-history was specified):

  1. $  helm list --all
  2. NAME            VERSION UPDATED                         STATUS          CHART
  3. happy-panda     2       Wed Sep 28 12:47:54 2016        UNINSTALLED     wordpress-10.4.5.6.0
  4. inky-cat        1       Wed Sep 28 12:59:46 2016        DEPLOYED        alpine-0.1.0
  5. kindred-angelf  2       Tue Sep 27 16:16:10 2016        UNINSTALLED     alpine-0.1.0

Note that because releases are now deleted by default, it is no longer possible to rollback an uninstalled resource.

‘helm repo’: Working with Repositories

Helm 3 no longer ships with a default chart repository. The helm repo command group provides commands to add, list, and remove repositories.

You can see which repositories are configured using helm repo list:

  1. $ helm repo list
  2. NAME            URL
  3. stable          https://charts.helm.sh/stable
  4. mumoshu         https://mumoshu.github.io/charts

And new repositories can be added with helm repo add:

  1. $ helm repo add dev https://example.com/dev-charts

Because chart repositories change frequently, at any point you can make sure your Helm client is up to date by running helm repo update.

Repositories can be removed with helm repo remove.

Creating Your Own Charts

The Chart Development Guide explains how to develop your own charts. But you can get started quickly by using the helm create command:

  1. $ helm create deis-workflow
  2. Creating deis-workflow

Now there is a chart in ./deis-workflow. You can edit it and create your own templates.

As you edit your chart, you can validate that it is well-formed by running helm lint.

When it’s time to package the chart up for distribution, you can run the helm package command:

  1. $ helm package deis-workflow
  2. deis-workflow-0.1.0.tgz

And that chart can now easily be installed by helm install:

  1. $ helm install deis-workflow ./deis-workflow-0.1.0.tgz
  2. ...

Charts that are packaged can be loaded into chart repositories. See the documentation for Helm chart repositories for more details.

Conclusion

This chapter has covered the basic usage patterns of the helm client, including searching, installation, upgrading, and uninstalling. It has also covered useful utility commands like helm status, helm get, and helm repo.

For more information on these commands, take a look at Helm’s built-in help: helm help.

In the next chapter, we look at the process of developing charts.