Helm install

From NovaOrdis Knowledge Base
Jump to navigation Jump to search

External

Internal

Overview


Revised for Helm 3


helm install installs a chart archive and creates a release:

helm install <release-name> <chart> [options]

The release name must be specified explicitly. If it should be generated, --generate-name must be used instead of the release name. Charts may come from different sources.

Chart Sources

Path to an Unpacked Chart

The chart argument of the install command can be an unpacked chart directory:

helm install simplest ./playground/helm/simplest

Path to a Packaged Chart

helm install simplest ./simplest-1.0.0.tgz

Charts can be packaged with helm package command.

Absolute URL

The absolute URL of a chart can be used as such:

helm install https://example.com/charts/something-1.0.0.tgz

Chart Reference

A chart available in a chart repository can be specified by a chart reference when installed. There are two ways to specify a chart reference:

Using a Repository Prefix

helm install postgresql example/postgresql

Note that the "example" is a name of a repository that has been previously added locally with helm repo add.

Using an Explicit Repository URL with --repo

A repository URL can be specified in-line in the install command line with --repo, without being previously added with helm repo add:

helm install --repo https://example.com/charts/ my-nginx nginx

Options

--generate-name

Generate a release name. If used,




The chart may come from a repository:

helm install <chart-name>

helm install stable/mysql

or from a local directory (note that the directory name must be identical with the chart name specified in Chart.yaml):

helm install <directory-name-that-must-match-chart-name>

If the chart has dependencies, they must be present in the charts/ subdirectory at the time of the installation. helm install does not manage dependencies, helm dependency does.

helm install performs some sanity checks, such as comparing the content of requirements.yaml with the content of the charts/ subdirectory and failing if requirements.yaml contains dependencies that are not in charts/. However, if a dependency is present in charts/ but not in requirements.yaml, it will be installed.

For more details on dependencies and how they work, see:

How Helm Dependencies Work

Dry Run

In this mode, we send the templates to the Tiller server, which renders them, but instead of installing the chart, it returns the rendered template so it can be inspected:

helm install <...> --debug --dry-run

Note that in this mode, it is not guaranteed that Kubernetes will accept the generated manifest.

Overriding Default Configuration or Providing New Cofiguration

-f|--values

Default configuration can be overridden or new configuration can be specified with:

helm install -f|--values <configuration-overrides-file.yaml> <chart name>

The -f|--values flag can be specified multiple time on the command line, and the rightmost value will take precedence. For more details on Helm configuration see:

Helm Configuration

--set-file

TODO: Clarify use cases and file content syntax.

For more details on Helm configuration see:

Helm Configuration

--set, --set--string

Individual configuration options can be specified with --set or --set-string.

helm install --set size=10 <chart name>

For more details on overriding or specifying configuration see:

Helm Configuration

Debug

helm install --debug

The --debug flag displays:

Overriding Tags and Conditions

Using the CLI with Tags and Conditions

Use --set to override default tag and condition values at installation time.