helm install

install a chart archive

Synopsis

This command installs a chart archive.

The install argument must be a chart reference, a path to a packaged chart, a path to an unpacked chart directory or a URL.

To override values in a chart, use either the ‘–values’ flag and pass in a file or use the ‘–set’ flag and pass configuration from the command line. To force string values in ‘–set’, use ‘–set-string’ instead. In case a value is large and therefore you want not to use neither ‘–values’ nor ‘–set’, use ‘–set-file’ to read the single large value from file.

  1. $ helm install -f myvalues.yaml ./redis

or

  1. $ helm install --set name=prod ./redis

or

  1. $ helm install --set-string long-int=1234567890 ./redis

or $ helm install –set-file multiline-text=path/to/textfile

You can specify the ‘–values’/‘-f’ flag multiple times. The priority will be given to the last (right-most) file specified. For example, if both myvalues.yaml and override.yaml contained a key called ‘Test’, the value set in override.yaml would take precedence:

  1. $ helm install -f myvalues.yaml -f override.yaml ./redis

You can specify the ‘–set’ flag multiple times. The priority will be given to the last (right-most) set specified. For example, if both ‘bar’ and ‘newbar’ values are set for a key called ‘foo’, the ‘newbar’ value would take precedence:

  1. $ helm install --set foo=bar --set foo=newbar ./redis

To check the generated manifests of a release without installing the chart, the ‘–debug’ and ‘–dry-run’ flags can be combined. This will still require a round-trip to the Tiller server.

If –verify is set, the chart MUST have a provenance file, and the provenance file MUST pass all verification steps.

There are five different ways you can express the chart you want to install:

  1. By chart reference: helm install stable/mariadb
  2. By path to a packaged chart: helm install ./nginx-1.2.3.tgz
  3. By path to an unpacked chart directory: helm install ./nginx
  4. By absolute URL: helm install https://example.com/charts/nginx-1.2.3.tgz
  5. By chart reference and repo url: helm install –repo https://example.com/charts/ nginx

CHART REFERENCES

A chart reference is a convenient way of reference a chart in a chart repository.

When you use a chart reference with a repo prefix (‘stable/mariadb’), Helm will look in the local configuration for a chart repository named ‘stable’, and will then look for a chart in that repository whose name is ‘mariadb’. It will install the latest version of that chart unless you also supply a version number with the ‘–version’ flag.

To see the list of chart repositories, use ‘helm repo list’. To search for charts in a repository, use ‘helm search’.

  1. helm install [CHART] [flags]

Options

  1. --atomic if set, installation process purges chart on fail, also sets --wait flag
  2. --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
  3. --cert-file string identify HTTPS client using this SSL certificate file
  4. --dep-up run helm dependency update before installing the chart
  5. --description string specify a description for the release
  6. --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  7. --dry-run simulate an install
  8. -h, --help help for install
  9. --key-file string identify HTTPS client using this SSL key file
  10. --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
  11. -n, --name string release name. If unspecified, it will autogenerate one for you
  12. --name-template string specify template used to name the release
  13. --namespace string namespace to install the release into. Defaults to the current kube config namespace.
  14. --no-crd-hook prevent CRD hooks from running, but run other hooks
  15. --no-hooks prevent hooks from running during install
  16. --password string chart repository password where to locate the requested chart
  17. --render-subchart-notes render subchart notes along with the parent
  18. --replace re-use the given name, even if that name is already used. This is unsafe in production
  19. --repo string chart repository url where to locate the requested chart
  20. --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
  21. --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
  22. --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
  23. --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
  24. --tls enable TLS for request
  25. --tls-ca-cert string path to TLS CA certificate file (default "$HELM-HOME/ca.pem")
  26. --tls-cert string path to TLS certificate file (default "$HELM-HOME/cert.pem")
  27. --tls-hostname string the server name used to verify the hostname on the returned certificates from the server
  28. --tls-key string path to TLS key file (default "$HELM-HOME/key.pem")
  29. --tls-verify enable TLS for request and verify remote
  30. --username string chart repository username where to locate the requested chart
  31. -f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default [])
  32. --verify verify the package before installing it
  33. --version string specify the exact chart version to install. If this is not specified, the latest version is installed
  34. --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout

Options inherited from parent commands

  1. --debug enable verbose output
  2. --home string location of your Helm config. Overrides $HELM-HOME (default "~/.helm")
  3. --host string address of Tiller. Overrides $HELM-HOST
  4. --kube-context string name of the kubeconfig context to use
  5. --kubeconfig string absolute path to the kubeconfig file to use
  6. --tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
  7. --tiller-namespace string namespace of Tiller (default "kube-system")

SEE ALSO

  • helm - The Helm package manager for Kubernetes.
Auto generated by spf13/cobra on 28-Jan-2019