CheatPress

Helm Kubernetes package manager

Version 4.3 · source

Helm, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Helm, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Helm, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Helm, A5, light preview Light · A5 148 × 210 mm · PDF Helm, A5, dark preview Dark · A5 148 × 210 mm · PDF Helm, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Helm, A4, light preview Light · A4 210 × 297 mm · PDF Helm, A4, dark preview Dark · A4 210 × 297 mm · PDF Helm, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Helm, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Helm, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Helm, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Helm, A3, light preview Light · A3 297 × 420 mm · PDF Helm, A3, dark preview Dark · A3 297 × 420 mm · PDF Helm, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Helm, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Helm, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Helm, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Helm, Letter, light preview Light · Letter 8.5 × 11 in · PDF Helm, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Helm, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Helm, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Helm, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Helm, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

helm repo add <name> <url>
Add a chart repository
helm search repo <keyword>
Find a chart
helm show values <chart>
See what you can configure
helm install <release> <chart>
Deploy a chart
helm list
Show installed releases
helm upgrade <release> <chart>
Apply new chart or values
helm rollback <release>
Go back one revision
helm uninstall <release>
Remove a release

Concepts

  1. Repository chart index
  2. Chart + values templates
  3. Manifests rendered YAML
  4. Release revisions in cluster

Repositories

helm repo add <name> <url>
Add a chart repository
helm repo update
Refresh local chart indexes
Run it before searching or installing to see new chart versions.
helm repo list
List configured repositories
helm search repo <keyword>
Search added repositories
helm search repo <chart> --versions
List all versions of a chart
helm search hub <keyword>
Search Artifact Hub
helm repo remove <name>
Remove a repository
helm pull <chart> --untar
Download and unpack a chart

Inspect charts

helm show values <chart>
Print the default values
Save it to a file as a starting point for your own overrides.
helm show readme <chart>
Show the chart README
helm show chart <chart>
Show chart metadata
helm show crds <chart>
Show bundled CRDs
helm show all <chart>
Show everything about a chart

Install

helm install <release> <chart>
Install a chart as a release
helm install <release> <chart> -n <ns> --create-namespace
Install into a new namespace
helm install <chart> --generate-name
Let Helm pick the release name
helm install <release> <chart> -f <values.yaml>
Install with a values file
With several -f files the rightmost wins.
helm install <release> <chart> --set <key>=<val>
Override a single value
--set wins over -f. Use --set-string to force a string.
helm install <release> <chart> --version <ver>
Pin the chart version
Accepts an exact version or a range such as ^2.0.0.
helm install <release> <chart> --wait --timeout 5m
Wait until resources are ready
helm install <release> <chart> --dry-run=client
Simulate without a cluster
Use =server to validate against the cluster.
helm install <release> <chart> --rollback-on-failure
Undo a failed install
Helm 3 spelling: --atomic.
helm install <release> ./<dir>
Install a local chart directory

Releases

helm list
List releases in this namespace
helm list -A
List releases in all namespaces
helm list --failed
Show only failed releases
helm list -f <regex>
Filter releases by name
helm status <release>
Show release status and notes
helm get values <release>
Values you supplied
helm get values <release> --all
Values including chart defaults
helm get manifest <release>
The manifests as deployed
helm get notes <release>
Print the release notes
helm history <release>
List revisions of a release

Upgrade & rollback

helm upgrade <release> <chart> -f <values.yaml>
Upgrade with a values file
helm upgrade --install <release> <chart>
Install or upgrade in one command
The usual form in scripts and CI: it works whether or not the release exists.
helm upgrade <release> <chart> --set <key>=<val>
Change one value
Without --reuse-values, values from earlier --set flags fall back to chart defaults.
helm upgrade <release> <chart> --reuse-values
Keep previous values, merge new
helm upgrade <release> <chart> --reset-values
Reset to the chart's defaults
helm upgrade <release> <chart> --dry-run=server
Check an upgrade against the cluster
helm upgrade <release> <chart> --rollback-on-failure
Roll back if the upgrade fails
Helm 3 spelling: --atomic.
helm rollback <release>
Roll back to the previous revision
helm rollback <release> <revision>
Roll back to a given revision
Find the number with helm history. A rollback creates a new revision.
helm uninstall <release>
Remove a release
helm uninstall <release> --keep-history
Remove it but keep revision history

Templating & debug

helm template <release> <chart> -f <values.yaml>
Render manifests locally
helm template <release> <chart> -s templates/<file>
Render a single template
-s is --show-only.
helm template <release> <chart> --debug
Verbose output while rendering
Shows rendered YAML even when it is invalid.
helm lint <chart-dir>
Check a chart for problems
helm lint <chart-dir> --strict
Fail on warnings too
helm create <name>
Scaffold a new chart
helm package <chart-dir>
Build a chart archive (.tgz)
helm dependency update <chart-dir>
Fetch dependencies into charts/
helm template <release> <chart> --include-crds
Include CRDs in the output
helm test <release>
Run a release's test hooks
Values precedence (low to high)
Source Wins over
chart values.yaml nothing
-f file chart defaults
later -f file earlier -f
--set all files

Recipes

Deploy a public chart
helm repo add bitnami https://charts.bitnami.com/bitnamihelm repo updatehelm show values bitnami/nginx > values.yaml# edit values.yamlhelm install web bitnami/nginx -n web --create-namespace -f values.yaml
Preview before upgrading
helm template web bitnami/nginx -f values.yaml > new.yamlhelm get manifest web -n web > old.yamldiff old.yaml new.yamlhelm upgrade web bitnami/nginx -n web -f values.yaml
Recover from a bad upgrade
helm history web -n webhelm rollback web <revision> -n webhelm status web -n web
CI deploy step
helm upgrade --install web ./chart \  -n web --create-namespace \  -f values-prod.yaml --wait --timeout 10m

Help

helm <command> --help
Help for a command
helm version
Print the client version
helm env
Show client paths and settings