Helm.md

Chart Management

Creates a chart directory along with the common files and directories used in a chart.

helm create

Packages a chart into a versioned chart archive file.

helm package

Run tests to examine a chart and identify possible issues:

helm lint

Inspect a chart and list its contents:

helm show all

Displays the contents of the values.yaml file

helm show values

Download/pull chart

helm pull

If set to true, will untar the chart after downloading it

helm pull --untar=true

Verify the package before using it

helm pull --verify

Default-latest is used, specify a version constraint for the chart version to use

helm pull --version

Display a list of a chart’s dependencies:

helm dependency list

Install and Uninstall Apps

Install the chart with a name

helm install

Install the chart in a specific namespace

helm install --namespace

Set values on the command line (can specify multiple or separate values with commas)

helm install --set key1=val1,key2=val2

Install the chart with your specified values

helm install --values <yaml-file/url>

Run a test installation to validate chart (p)

helm install --dry-run --debug

Verify the package before using it

helm install --verify

update dependencies if they are missing before installing the chart

helm install --dependency-update

Uninstall a release

helm uninstall

Perform App Upgrade and Rollback

Upgrade a release

helm upgrade

If set, upgrade process rolls back changes made in case of failed upgrade.

helm upgrade --atomic

update dependencies if they are missing before installing the chart

helm upgrade --dependency-update

specify a version constraint for the chart version to use

helm upgrade --version <version_number>

specify values in a YAML file or a URL (can specify multiple)

helm upgrade --values

Set values on the command line (can specify multiple or separate valuese)

helm upgrade --set key1=val1,key2=val2

Force resource updates through a replacement strategy

helm upgrade --force

Roll back a release to a specific revision

helm rollback

Allow deletion of new resources created in this rollback when rollback fails

helm rollback --cleanup-on-fail

List, Add, Remove, and Update Repositories

Add a repository from the internet:

helm repo add

List added chart repositories

helm repo list

Update information of available charts locally from chart repositories

helm repo update

Remove one or more chart repositories

helm repo remove <repo_name>

Read the current directory and generate an index file based on the charts found.

helm repo index

Merge the generated index with an existing index file

helm repo index

--merge

Search repositories for a keyword in charts

helm search repo

Search for charts in the Artifact Hub or your own hub instance

helm search hub

Helm Release monitoring

Lists all of the releases for a specified namespace, uses current namespace context if namespace not specified

helm list

Show all releases without any filter applied, can use -a

helm list --all

List releases across all namespaces, we can use -A

helm list --all-namespaces

Selector (label query) to filter on, supports '=', '==', and '!='

helm -l key1=value1,key2=value2

Sort by release date

helm list --date

Show deployed releases. If no other is specified, this will be automatically enabled

helm list --deployed

Show pending releases

helm list --pending

Show failed releases

helm list --failed

Show uninstalled releases (if 'helm uninstall --keep-history' was used)

helm list --uninstalled

Show superseded releases

helm list --superseded

Prints the output in the specified format. Allowed values: table, json, yaml (default table)

helm list -o yaml

This command shows the status of a named release.

helm status

if set, display the status of the named release with revision

helm status --revision

Historical revisions for a given release.

helm history

Env prints out all the environment information in use by Helm.

helm env

Download Release Information

A human readable collection of information about the notes, hooks, supplied values, and generated manifest file of the given release.

helm get all

This command downloads hooks for a given release. Hooks are formatted in YAML and separated by the YAML '---\n' separator.

helm get hooks

A manifest is a YAML-encoded representation of the Kubernetes resources that were generated from this release's chart(s). If a chart is dependent on other charts, those resources will also be included in the manifest.

helm get manifest

Shows notes provided by the chart of a named release.

helm get notes

Downloads a values file for a given release. use -o to format output

helm get values

Plugin Management

Install plugins

helm plugin install <path/url1>

View a list of all installed plugins

helm plugin list

Update plugins

helm plugin update

Uninstall a plugin

helm plugin uninstall