helm

The Helm package manager for Kubernetes.

Synopsis

The Kubernetes package manager

To begin working with Helm, run the ‘helm init’ command:

$ helm init

This will install Tiller to your running Kubernetes cluster. It will also set up any necessary local configuration.

Common actions from this point include:

  • helm search: Search for charts
  • helm fetch: Download a chart to your local directory to view
  • helm install: Upload the chart to Kubernetes
  • helm list: List releases of charts

Environment:

  • $HELM_HOME: Set an alternative location for Helm files. By default, these are stored in ~/.helm
  • $HELM_HOST: Set an alternative Tiller host. The format is host:port
  • $HELM_NO_PLUGINS: Disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.
  • $TILLER_NAMESPACE: Set an alternative Tiller namespace (default “kube-system”)
  • $KUBECONFIG: Set an alternative Kubernetes configuration file (default “~/.kube/config”)
  • $HELM_TLS_CA_CERT: Path to TLS CA certificate used to verify the Helm client and Tiller server certificates (default “$HELM_HOME/ca.pem”)
  • $HELM_TLS_CERT: Path to TLS client certificate file for authenticating to Tiller (default “$HELM_HOME/cert.pem”)
  • $HELM_TLS_KEY: Path to TLS client key file for authenticating to Tiller (default “$HELM_HOME/key.pem”)
  • $HELM_TLS_ENABLE: Enable TLS connection between Helm and Tiller (default “false”)
  • $HELM_TLS_VERIFY: Enable TLS connection between Helm and Tiller and verify Tiller server certificate (default “false”)
  • $HELM_TLS_HOSTNAME: The hostname or IP address used to verify the Tiller server certificate (default “127.0.0.1”)
  • $HELM_KEY_PASSPHRASE: Set HELM_KEY_PASSPHRASE to the passphrase of your PGP private key. If set, you will not be prompted for the passphrase while signing helm charts

Options

      --debug                           Enable verbose output
  -h, --help                            help for helm
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm completion

Generate autocompletions script for the specified shell (bash or zsh)

Synopsis

Generate autocompletions script for Helm for the specified shell (bash or zsh).

This command can generate shell autocompletions. e.g.

$ helm completion bash

Can be sourced as such

$ source <(helm completion bash)
helm completion SHELL [flags]

Options

  -h, --help   help for completion

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm create

Create a new chart with the given name

Synopsis

This command creates a chart directory along with the common files and directories used in a chart. It provides a basic example and is not meant to cover all Kubernetes resources.

For example, ‘helm create foo’ will create a directory structure that looks something like this:

foo/
  |
  |- .helmignore        # Contains patterns to ignore when packaging Helm charts.
  |
  |- Chart.yaml         # Information about your chart
  |
  |- values.yaml        # The default values for your templates
  |
  |- charts/            # Charts that this chart depends on
  |
  |- templates/         # The template files
  |
  |- templates/tests/   # The test files

‘helm create’ takes a path for an argument. If directories in the given path do not exist, Helm will attempt to create them as it goes. If the given destination exists and there are files in that directory, conflicting files will be overwritten, but other files will be left alone.

The chart that is created by invoking this command contains a Deployment, Ingress and a Service. To use other Kubernetes resources with your chart, refer to The Chart Template Developer’s Guide.

helm create NAME [flags]

Options

  -h, --help             help for create
  -p, --starter string   The name or absolute path to Helm starter scaffold

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm delete

Given a release name, delete the release from Kubernetes

Synopsis

This command takes a release name, and then deletes the release from Kubernetes. It removes all of the resources associated with the last release of the chart.

Use the ‘–dry-run’ flag to see which releases will be deleted without actually deleting them.

helm delete [flags] RELEASE_NAME [...]

Options

      --description string    Specify a description for the release
      --dry-run               Simulate a delete
  -h, --help                  help for delete
      --no-hooks              Prevent hooks from running during deletion
      --purge                 Remove the release from the store and make its name free for later use
      --timeout int           Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm dependency

Manage a chart’s dependencies

Synopsis

Manage the dependencies of a chart.

Helm charts store their dependencies in ‘charts/’. For chart developers, it is often easier to manage a single dependency file (‘requirements.yaml’) which declares all dependencies.

The dependency commands operate on that file, making it easy to synchronize between the desired dependencies and the actual dependencies stored in the ‘charts/’ directory.

A ‘requirements.yaml’ file is a YAML file in which developers can declare chart dependencies, along with the location of the chart and the desired version. For example, this requirements file declares two dependencies:

# requirements.yaml
dependencies:
- name: nginx
  version: "1.2.3"
  repository: "https://example.com/charts"
- name: memcached
  version: "3.2.1"
  repository: "https://another.example.com/charts"

The ‘name’ should be the name of a chart, where that name must match the name in that chart’s ‘Chart.yaml’ file.

The ‘version’ field should contain a semantic version or version range.

The ‘repository’ URL should point to a Chart Repository. Helm expects that by appending ‘/index.yaml’ to the URL, it should be able to retrieve the chart repository’s index. Note: ‘repository’ can be an alias. The alias must start with ‘alias:’ or ‘@’.

Starting from 2.2.0, repository can be defined as the path to the directory of the dependency charts stored locally. The path should start with a prefix of “file://“. For example,

# requirements.yaml
dependencies:
- name: nginx
  version: "1.2.3"
  repository: "file://../dependency_chart/nginx"

If the dependency chart is retrieved locally, it is not required to have the repository added to helm by “helm repo add”. Version matching is also supported for this case.

Options

  -h, --help   help for dependency

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm dependency build

Rebuild the charts/ directory based on the requirements.lock file

Synopsis

Build out the charts/ directory from the requirements.lock file.

Build is used to reconstruct a chart’s dependencies to the state specified in the lock file.

If no lock file is found, ‘helm dependency build’ will mirror the behavior of the ‘helm dependency update’ command. This means it will update the on-disk dependencies to mirror the requirements.yaml file and generate a lock file.

helm dependency build [flags] CHART

Options

  -h, --help             help for build
      --keyring string   Keyring containing public keys (default "~/.gnupg/pubring.gpg")
      --verify           Verify the packages against signatures

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm dependency list

List the dependencies for the given chart

Synopsis

List all of the dependencies declared in a chart.

This can take chart archives and chart directories as input. It will not alter the contents of a chart.

This will produce an error if the chart cannot be loaded. It will emit a warning if it cannot find a requirements.yaml.

helm dependency list [flags] CHART

Options

  -h, --help   help for list

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm dependency update

Update charts/ based on the contents of requirements.yaml

Synopsis

Update the on-disk dependencies to mirror the requirements.yaml file.

This command verifies that the required charts, as expressed in ‘requirements.yaml’, are present in ‘charts/’ and are at an acceptable version. It will pull down the latest charts that satisfy the dependencies, and clean up old dependencies.

On successful update, this will generate a lock file that can be used to rebuild the requirements to an exact version.

Dependencies are not required to be represented in ‘requirements.yaml’. For that reason, an update command will not remove charts unless they are (a) present in the requirements.yaml file, but (b) at the wrong version.

helm dependency update [flags] CHART

Options

  -h, --help             help for update
      --keyring string   Keyring containing public keys (default "~/.gnupg/pubring.gpg")
      --skip-refresh     Do not refresh the local repository cache
      --verify           Verify the packages against signatures

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm fetch

Download a chart from a repository and (optionally) unpack it in local directory

Synopsis

Retrieve a package from a package repository, and download it locally.

This is useful for fetching packages to inspect, modify, or repackage. It can also be used to perform cryptographic verification of a chart without installing the chart.

There are options for unpacking the chart after download. This will create a directory for the chart and uncompress into that directory.

If the –verify flag is specified, the requested chart MUST have a provenance file, and MUST pass the verification process. Failure in any part of this will result in an error, and the chart will not be saved locally.

helm fetch [flags] [chart URL | repo/chartname] [...]

Options

      --ca-file string       Verify certificates of HTTPS-enabled servers using this CA bundle
      --cert-file string     Identify HTTPS client using this SSL certificate file
  -d, --destination string   Location to write the chart. If this and tardir are specified, tardir is appended to this (default ".")
      --devel                Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  -h, --help                 help for fetch
      --key-file string      Identify HTTPS client using this SSL key file
      --keyring string       Keyring containing public keys (default "~/.gnupg/pubring.gpg")
      --password string      Chart repository password
      --prov                 Fetch the provenance file, but don't perform verification
      --repo string          Chart repository url where to locate the requested chart
      --untar                If set to true, will untar the chart after downloading it
      --untardir string      If untar is specified, this flag specifies the name of the directory into which the chart is expanded (default ".")
      --username string      Chart repository username
      --verify               Verify the package against its signature
      --version string       Specific version of a chart. Without this, the latest version is fetched

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm get

Download a named release

Synopsis

This command shows the details of a named release.

It can be used to get extended information about the release, including:

  • The values used to generate the release
  • The chart used to generate the release
  • The generated manifest file

By default, this prints a human readable collection of information about the chart, the supplied values, and the generated manifest file.

helm get [flags] RELEASE_NAME

Options

  -h, --help                  help for get
      --revision int32        Get the named release with revision
      --template string       Go template for formatting the output, eg: {{.Release.Name}}
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm get hooks

Download all hooks for a named release

Synopsis

This command downloads hooks for a given release.

Hooks are formatted in YAML and separated by the YAML ‘—\n’ separator.

helm get hooks [flags] RELEASE_NAME

Options

  -h, --help                  help for hooks
      --revision int32        Get the named release with revision
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm get manifest

Download the manifest for a named release

Synopsis

This command fetches the generated manifest for a given release.

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 [flags] RELEASE_NAME

Options

  -h, --help                  help for manifest
      --revision int32        Get the named release with revision
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm get notes

Displays the notes of the named release

Synopsis

This command shows notes provided by the chart of a named release.

helm get notes [flags] RELEASE_NAME

Options

  -h, --help                  help for notes
      --revision int32        Get the notes of the named release with revision
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm get values

Download the values file for a named release

Synopsis

This command downloads a values file for a given release.

helm get values [flags] RELEASE_NAME

Options

  -a, --all                   Dump all (computed) values
  -h, --help                  help for values
      --output string         Output the specified format (json or yaml) (default "yaml")
      --revision int32        Get the named release with revision
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm history

Fetch release history

Synopsis

History prints historical revisions for a given release.

A default maximum of 256 revisions will be returned. Setting ‘–max’ configures the maximum length of the revision list returned.

The historical release set is printed as a formatted table, e.g:

$ helm history angry-bird --max=4
REVISION   UPDATED                      STATUS           CHART        APP VERSION   DESCRIPTION
1           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  1.1       Initial install
2           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  1.2       Upgraded successfully
3           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  1.1       Rolled back to 2
4           Mon Oct 3 10:15:13 2016     DEPLOYED        alpine-0.1.0  1.3       Upgraded successfully
helm history [flags] RELEASE_NAME

Options

      --col-width uint        Specifies the max column width of output (default 60)
  -h, --help                  help for history
      --max int32             Maximum number of revisions to include in history (default 256)
  -o, --output string         Prints the output in the specified format (json|table|yaml) (default "table")
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm home

Displays the location of HELM_HOME

Synopsis

This command displays the location of HELM_HOME. This is where any helm configuration files live.

helm home [flags]

Options

  -h, --help   help for home

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm init

Initialize Helm on both client and server

Synopsis

This command installs Tiller (the Helm server-side component) onto your Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/).

As with the rest of the Helm commands, ‘helm init’ discovers Kubernetes clusters by reading $KUBECONFIG (default ‘~/.kube/config’) and using the default context.

To set up just a local environment, use ‘–client-only’. That will configure $HELM_HOME, but not attempt to connect to a Kubernetes cluster and install the Tiller deployment.

When installing Tiller, ‘helm init’ will attempt to install the latest released version. You can specify an alternative image with ‘–tiller-image’. For those frequently working on the latest code, the flag ‘–canary-image’ will install the latest pre-release version of Tiller (e.g. the HEAD commit in the GitHub repository on the master branch).

To dump a manifest containing the Tiller deployment YAML, combine the ‘–dry-run’ and ‘–debug’ flags.

helm init [flags]

Options

      --automount-service-account-token    Auto-mount the given service account to tiller (default true)
      --canary-image                       Use the canary Tiller image
  -c, --client-only                        If set does not install Tiller
      --dry-run                            Do not install local or remote
      --force-upgrade                      Force upgrade of Tiller to the current helm version
  -h, --help                               help for init
      --history-max int                    Limit the maximum number of revisions saved per release. Use 0 for no limit.
      --local-repo-url string              URL for local repository (default "http://127.0.0.1:8879/charts")
      --net-host                           Install Tiller with net=host
      --node-selectors string              Labels to specify the node on which Tiller is installed (app=tiller,helm=rocks)
  -o, --output OutputFormat                Skip installation and output Tiller's manifest in specified format (json or yaml)
      --override stringArray               Override values for the Tiller Deployment manifest (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --replicas int                       Amount of tiller instances to run on the cluster (default 1)
      --service-account string             Name of service account
      --skip-refresh                       Do not refresh (download) the local repository cache
      --skip-repos                         Skip adding the stable and local repositories
      --stable-repo-url string             URL for stable repository (default "https://charts.helm.sh/stable")
  -i, --tiller-image string                Override Tiller image
      --tiller-tls                         Install Tiller with TLS enabled
      --tiller-tls-cert string             Path to TLS certificate file to install with Tiller
      --tiller-tls-hostname string         The server name used to verify the hostname on the returned certificates from Tiller
      --tiller-tls-key string              Path to TLS key file to install with Tiller
      --tiller-tls-verify                  Install Tiller with TLS enabled and to verify remote certificates
      --tls-ca-cert string                 Path to CA root certificate
      --upgrade                            Upgrade if Tiller is already installed
      --use-deprecated-stable-repository   Use the old (googleapis) repository URL even though that URL is being shutdown.
      --wait                               Block until Tiller is running and ready to receive requests

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm - The Helm package manager for Kubernetes.
Auto generated by spf13/cobra on 15-Oct-2020

helm inspect

Inspect a chart

Synopsis

This command inspects a chart and displays information. It takes a chart reference (‘stable/drupal’), a full path to a directory or packaged chart, or a URL.

Inspect prints the contents of the Chart.yaml file and the values.yaml file.

helm inspect [CHART] [flags]

Options

      --ca-file string     Chart repository url where to locate the requested chart
      --cert-file string   Verify certificates of HTTPS-enabled servers using this CA bundle
      --devel              Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  -h, --help               help for inspect
      --key-file string    Identify HTTPS client using this SSL key file
      --keyring string     Path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg")
      --password string    Chart repository password where to locate the requested chart
      --repo string        Chart repository url where to locate the requested chart
      --username string    Chart repository username where to locate the requested chart
      --verify             Verify the provenance data for this chart
      --version string     Version of the chart. By default, the newest chart is shown

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm inspect chart

shows inspect chart

Synopsis

This command inspects a chart (directory, file, or URL) and displays the contents of the Charts.yaml file

helm inspect chart [CHART] [flags]

Options

      --ca-file string     Chart repository url where to locate the requested chart
      --cert-file string   Verify certificates of HTTPS-enabled servers using this CA bundle
      --devel              Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  -h, --help               help for chart
      --key-file string    Identify HTTPS client using this SSL key file
      --keyring string     Path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg")
      --password string    Chart repository password where to locate the requested chart
      --repo string        Chart repository url where to locate the requested chart
      --username string    Chart repository username where to locate the requested chart
      --verify             Verify the provenance data for this chart
      --version string     Version of the chart. By default, the newest chart is shown

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm inspect readme

shows inspect readme

Synopsis

This command inspects a chart (directory, file, or URL) and displays the contents of the README file

helm inspect readme [CHART] [flags]

Options

      --ca-file string     Chart repository url where to locate the requested chart
      --cert-file string   Verify certificates of HTTPS-enabled servers using this CA bundle
      --devel              Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  -h, --help               help for readme
      --key-file string    Identify HTTPS client using this SSL key file
      --keyring string     Path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg")
      --repo string        Chart repository url where to locate the requested chart
      --verify             Verify the provenance data for this chart
      --version string     Version of the chart. By default, the newest chart is shown

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm inspect values

shows inspect values

Synopsis

This command inspects a chart (directory, file, or URL) and displays the contents of the values.yaml file

helm inspect values [CHART] [flags]

Options

      --ca-file string     Chart repository url where to locate the requested chart
      --cert-file string   Verify certificates of HTTPS-enabled servers using this CA bundle
      --devel              Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
  -h, --help               help for values
      --key-file string    Identify HTTPS client using this SSL key file
      --keyring string     Path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg")
      --password string    Chart repository password where to locate the requested chart
      --repo string        Chart repository url where to locate the requested chart
      --username string    Chart repository username where to locate the requested chart
      --verify             Verify the provenance data for this chart
      --version string     Version of the chart. By default, the newest chart is shown

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

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.

$ helm install -f myvalues.yaml ./redis

or

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

or

$ 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:

$ 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:

$ 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’.

helm install [CHART] [flags]

Options

      --atomic                   If set, installation process purges chart on fail, also sets --wait flag
      --ca-file string           Verify certificates of HTTPS-enabled servers using this CA bundle
      --cert-file string         Identify HTTPS client using this SSL certificate file
      --dep-up                   Run helm dependency update before installing the chart
      --description string       Specify a description for the release
      --devel                    Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
      --dry-run                  Simulate an install
  -h, --help                     help for install
      --key-file string          Identify HTTPS client using this SSL key file
      --keyring string           Location of public keys used for verification (default "~/.gnupg/pubring.gpg")
  -n, --name string              The release name. If unspecified, it will autogenerate one for you
      --name-template string     Specify template used to name the release
      --namespace string         Namespace to install the release into. Defaults to the current kube config namespace.
      --no-crd-hook              Prevent CRD hooks from running, but run other hooks
      --no-hooks                 Prevent hooks from running during install
  -o, --output string            Prints the output in the specified format. Allowed values: table, json, yaml (default "table")
      --password string          Chart repository password where to locate the requested chart
      --render-subchart-notes    Render subchart notes along with the parent
      --replace                  Re-use the given name, even if that name is already used. This is unsafe in production
      --repo string              Chart repository url where to locate the requested chart
      --set stringArray          Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --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)
      --set-string stringArray   Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --timeout int              Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
      --tls                      Enable TLS for request
      --tls-ca-cert string       Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string          Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string      The server name used to verify the hostname on the returned certificates from the server
      --tls-key string           Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify               Enable TLS for request and verify remote
      --username string          Chart repository username where to locate the requested chart
  -f, --values valueFiles        Specify values in a YAML file or a URL(can specify multiple) (default [])
      --verify                   Verify the package before installing it
      --version string           Specify the exact chart version to install. If this is not specified, the latest version is installed
      --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

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm lint

Examines a chart for possible issues

Synopsis

This command takes a path to a chart and runs a series of tests to verify that the chart is well-formed.

If the linter encounters things that will cause the chart to fail installation, it will emit [ERROR] messages. If it encounters issues that break with convention or recommendation, it will emit [WARNING] messages.

helm lint [flags] PATH

Options

  -h, --help                     help for lint
      --namespace string         Namespace to put the release into (default "default")
      --set stringArray          Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --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)
      --set-string stringArray   Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --strict                   Fail on lint warnings
  -f, --values valueFiles        Specify values in a YAML file (can specify multiple) (default [])

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm list

List releases

Synopsis

This command lists all of the releases.

By default, it lists only releases that are deployed or failed. Flags like ‘–deleted’ and ‘–all’ will alter this behavior. Such flags can be combined: ‘–deleted –failed’.

By default, items are sorted alphabetically. Use the ‘-d’ flag to sort by release date.

If an argument is provided, it will be treated as a filter. Filters are regular expressions (Perl compatible) that are applied to the list of releases. Only items that match the filter will be returned.

$ helm list 'ara[a-z]+'
NAME                UPDATED                     CHART
maudlin-arachnid    Mon May  9 16:07:08 2016    alpine-0.1.0

If no results are found, ‘helm list’ will exit 0, but with no output (or in the case of no ‘-q’ flag, only headers).

By default, up to 256 items may be returned. To limit this, use the ‘–max’ flag. Setting ‘–max’ to 0 will not return all results. Rather, it will return the server’s default, which may be much higher than 256. Pairing the ‘–max’ flag with the ‘–offset’ flag allows you to page through results.

helm list [flags] [FILTER]

Options

  -a, --all                   Show all releases, not just the ones marked DEPLOYED
  -c, --chart-name            Sort by chart name
      --col-width uint        Specifies the max column width of output (default 60)
  -d, --date                  Sort by release date
      --deleted               Show deleted releases
      --deleting              Show releases that are currently being deleted
      --deployed              Show deployed releases. If no other is specified, this will be automatically enabled
      --failed                Show failed releases
  -h, --help                  help for list
  -m, --max int               Maximum number of releases to fetch (default 256)
      --namespace string      Show releases within a specific namespace
  -o, --offset string         Next release name in the list, used to offset from start value
      --output string         Output the specified format (json or yaml)
      --pending               Show pending releases
  -r, --reverse               Reverse the sort order
  -q, --short                 Output short (quiet) listing format
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm package

Package a chart directory into a chart archive

Synopsis

This command packages a chart into a versioned chart archive file. If a path is given, this will look at that path for a chart (which must contain a Chart.yaml file) and then package that directory.

If no path is given, this will look in the present working directory for a Chart.yaml file, and (if found) build the current directory into a chart.

Versioned chart archives are used by Helm package repositories.

helm package [flags] [CHART_PATH] [...]

Options

      --app-version string   Set the appVersion on the chart to this version
  -u, --dependency-update    Update dependencies from "requirements.yaml" to dir "charts/" before packaging
  -d, --destination string   Location to write the chart. (default ".")
  -h, --help                 help for package
      --key string           Name of the key to use when signing. Used if --sign is true
      --keyring string       Location of a public keyring (default "~/.gnupg/pubring.gpg")
      --save                 Save packaged chart to local chart repository (default true)
      --sign                 Use a PGP private key to sign this package
      --version string       Set the version on the chart to this semver version

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm plugin

Add, list, or remove Helm plugins

Synopsis

Manage client-side Helm plugins.

Options

  -h, --help   help for plugin

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm plugin install

Install one or more Helm plugins

Synopsis

This command allows you to install a plugin from a url to a VCS repo or a local path.

Example usage: $ helm plugin install https://github.com/technosophos/helm-template

helm plugin install [options] <path|url>... [flags]

Options

  -h, --help             help for install
      --version string   Specify a version constraint. If this is not specified, the latest version is installed

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm plugin list

List installed Helm plugins

Synopsis

List installed Helm plugins

helm plugin list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm plugin remove

Remove one or more Helm plugins

Synopsis

Remove one or more Helm plugins

helm plugin remove <plugin>... [flags]

Options

  -h, --help   help for remove

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm plugin update

Update one or more Helm plugins

Synopsis

Update one or more Helm plugins

helm plugin update <plugin>... [flags]

Options

  -h, --help   help for update

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm repo

Add, list, remove, update, and index chart repositories

Synopsis

This command consists of multiple subcommands to interact with chart repositories.

It can be used to add, remove, list, and index chart repositories. Example usage: $ helm repo add [NAME] [REPO_URL]

Options

  -h, --help   help for repo

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

Auto generated by spf13/cobra on 16-May-2019

helm repo add

Add a chart repository

Synopsis

Add a chart repository

helm repo add [flags] [NAME] [URL]

Options

      --ca-file string     Verify certificates of HTTPS-enabled servers using this CA bundle
      --cert-file string   Identify HTTPS client using this SSL certificate file
  -h, --help               help for add
      --key-file string    Identify HTTPS client using this SSL key file
      --no-update          Raise error if repo is already registered
      --password string    Chart repository password
      --username string    Chart repository username

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm repo - Add, list, remove, update, and index chart repositories
Auto generated by spf13/cobra on 16-May-2019

helm repo index

Generate an index file given a directory containing packaged charts

Synopsis

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

This tool is used for creating an ‘index.yaml’ file for a chart repository. To set an absolute URL to the charts, use ‘–url’ flag.

To merge the generated index with an existing index file, use the ‘–merge’ flag. In this case, the charts found in the current directory will be merged into the existing index, with local charts taking priority over existing charts.

helm repo index [flags] [DIR]

Options

  -h, --help           help for index
      --merge string   Merge the generated index into the given index
      --url string     URL of the chart repository

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm repo - Add, list, remove, update, and index chart repositories
Auto generated by spf13/cobra on 16-May-2019

helm repo list

List chart repositories

Synopsis

List chart repositories

helm repo list [flags]

Options

  -h, --help            help for list
  -o, --output string   Prints the output in the specified format. Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm repo - Add, list, remove, update, and index chart repositories
Auto generated by spf13/cobra on 24-Sep-2019

helm repo remove

Remove a chart repository

Synopsis

Remove a chart repository

helm repo remove [flags] [NAME]

Options

  -h, --help   help for remove

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm repo - Add, list, remove, update, and index chart repositories
Auto generated by spf13/cobra on 16-May-2019

helm repo update

Update information of available charts locally from chart repositories

Synopsis

Update gets the latest information about charts from the respective chart repositories. Information is cached locally, where it is used by commands like ‘helm search’.

‘helm update’ is the deprecated form of ‘helm repo update’. It will be removed in future releases.

You can specify the name of a repository you want to update.

$ helm repo update <repo_name>

To update all the repositories, use ‘helm repo update’.

helm repo update [REPO_NAME] [flags]

Options

  -h, --help     help for update
      --strict   Fail on update warnings

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

  • helm repo - Add, list, remove, update, and index chart repositories
Auto generated by spf13/cobra on 7-Jun-2019

helm reset

Uninstalls Tiller from a cluster

Synopsis

This command uninstalls Tiller (the Helm server-side component) from your Kubernetes Cluster and optionally deletes local configuration in $HELM_HOME (default ~/.helm/)

helm reset [flags]

Options

  -f, --force                 Forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state. Releases are not deleted.)
  -h, --help                  help for reset
      --remove-helm-home      If set, deletes $HELM_HOME
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm rollback

Rollback a release to a previous revision

Synopsis

This command rolls back a release to a previous revision.

The first argument of the rollback command is the name of a release, and the second is a revision (version) number. To see revision numbers, run ‘helm history RELEASE’. If you’d like to rollback to the previous release use ‘helm rollback [RELEASE] 0’.

helm rollback [flags] [RELEASE] [REVISION]

Options

      --cleanup-on-fail       Allow deletion of new resources created in this rollback when rollback failed
      --description string    Specify a description for the release
      --dry-run               Simulate a rollback
      --force                 Force resource update through delete/recreate if needed
  -h, --help                  help for rollback
      --no-hooks              Prevent hooks from running during rollback
      --recreate-pods         Performs pods restart for the resource if applicable
      --timeout int           Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote
      --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

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

Search for a keyword in charts

Synopsis

Search reads through all of the repositories configured on the system, and looks for matches.

It will display the latest stable versions of the charts found. If you specify the –devel flag, the output will include pre-release versions. If you want to search using a version constraint, use –version.

Examples:

# Search for stable release versions matching the keyword "nginx"
helm search nginx

# Search for release versions matching the keyword "nginx", including pre-release versions
helm search nginx --devel

# Search for the latest stable release for nginx-ingress with a major version of 1
helm search nginx-ingress --version ^1.0.0

Repositories are managed with ‘helm repo’ commands.

To look for charts with a particular name (such as stable/mysql), try searching using vertical tabs (\v). Vertical tabs are used as the delimiter between search fields. For example:

helm search --regexp '\vstable/mysql\v'

To search for charts using common keywords (such as “database” or “key-value store”), use

helm search database

or

helm search key-value store
helm search [keyword] [flags]

Options

      --col-width uint   Specifies the max column width of output (default 60)
      --devel            use development versions (alpha, beta, and release candidate releases), too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored
  -h, --help             help for search
  -o, --output string    Prints the output in the specified format. Allowed values: table, json, yaml (default "table")
  -r, --regexp           Use regular expressions for searching
  -v, --version string   Search using semantic versioning constraints
  -l, --versions         Show the long listing, with each version of each chart on its own line

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm serve

Start a local http web server

Synopsis

This command starts a local chart repository server that serves charts from a local directory.

The new server will provide HTTP access to a repository. By default, it will scan all of the charts in ‘$HELM_HOME/repository/local’ and serve those over the local IPv4 TCP port (default ‘127.0.0.1:8879’).

This command is intended to be used for educational and testing purposes only. It is best to rely on a dedicated web server or a cloud-hosted solution like Google Cloud Storage for production use.

See https://github.com/helm/helm/blob/master/docs/developing_charts.md#hosting-chart-repositories for more information on hosting chart repositories in a production setting.

helm serve [flags]

Options

      --address string     Address to listen on (default "127.0.0.1:8879")
  -h, --help               help for serve
      --repo-path string   Local directory path from which to serve charts
      --url string         External URL of chart repository

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm status

Displays the status of the named release

Synopsis

This command shows the status of a named release. The status consists of: - last deployment time - k8s namespace in which the release lives - state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) - list of resources that this release consists of, sorted by kind - details on last test suite run, if applicable - additional notes provided by the chart

helm status [flags] RELEASE_NAME

Options

  -h, --help                  help for status
  -o, --output string         Prints the output in the specified format. Allowed values: table, json, yaml (default "table")
      --revision int32        If set, display the status of the named release with revision
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm template

Locally render templates

Synopsis

Render chart templates locally and display the output.

This does not require Tiller. However, any values that would normally be looked up or retrieved in-cluster will be faked locally. Additionally, none of the server-side testing of chart validity (e.g. whether an API is supported) is done.

To render just one template in a chart, use ‘-x’:

$ helm template mychart -x templates/deployment.yaml
helm template [flags] CHART

Options

  -a, --api-versions stringArray   Kubernetes api versions used for Capabilities.APIVersions
  -x, --execute stringArray        Only execute the given templates
  -h, --help                       help for template
      --is-upgrade                 Set .Release.IsUpgrade instead of .Release.IsInstall
      --kube-version string        Kubernetes version used as Capabilities.KubeVersion.Major/Minor (default "1.14")
  -n, --name string                Release name (default "release-name")
      --name-template string       Specify template used to name the release
      --namespace string           Namespace to install the release into
      --notes                      Show the computed NOTES.txt file as well
      --output-dir string          Writes the executed templates to files in output-dir instead of stdout
      --set stringArray            Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --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)
      --set-string stringArray     Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
  -f, --values valueFiles          Specify values in a YAML file (can specify multiple) (default [])

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm test

Test a release

Synopsis

The test command runs the tests for a release.

The argument this command takes is the name of a deployed release. The tests to be run are defined in the chart that was installed.

helm test [RELEASE] [flags]

Options

      --cleanup               Delete test pods upon completion
  -h, --help                  help for test
      --logs                  Dump the logs from test pods (this runs after all tests are complete, but before any cleanup
      --max uint32            Maximum number of test pods to run in parallel (default 20)
      --parallel              Run test pods in parallel
      --timeout int           Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm upgrade

Upgrade a release

Synopsis

This command upgrades a release to a specified version of a chart and/or updates chart values.

Required arguments are release and chart. The chart argument can be one of: - a chart reference(‘stable/mariadb’); use ‘–version’ and ‘–devel’ flags for versions other than latest, - a path to a chart directory, - a packaged chart, - a fully qualified URL.

To customize the chart values, use any of - ‘–values’/‘-f’ to pass in a yaml file holding settings, - ‘–set’ to provide one or more key=val pairs directly, - ‘–set-string’ to provide key=val forcing val to be stored as a string, - ‘–set-file’ to provide key=path to read a single large value from a file at path.

To edit or append to the existing customized values, add the ‘–reuse-values’ flag, otherwise any existing customized values are ignored.

If no chart value arguments are provided on the command line, any existing customized values are carried forward. If you want to revert to just the values provided in the chart, use the ‘–reset-values’ flag.

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

$ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis

Note that the key name provided to the ‘–set’, ‘–set-string’ and ‘–set-file’ flags can reference structure elements. Examples: - mybool=TRUE - livenessProbe.timeoutSeconds=10 - metrics.annotations[0]=hey,metrics.annotations[1]=ho

which sets the top level key mybool to true, the nested timeoutSeconds to 10, and two array values, respectively.

Note that the value side of the key=val provided to ‘–set’ and ‘–set-string’ flags will pass through shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with special characters in unexpected ways, for example

$ helm upgrade --set pwd=3jk$o2,z=f\30.e redis ./redis

results in “pwd: 3jk” and “z: f30.e”. Use single quotes to avoid shell evaluation and argument delimiters, and use backslash to escape yaml special characters:

$ helm upgrade --set pwd='3jk$o2z=f\\30.e' redis ./redis

which results in the expected “pwd: 3jk$o2z=f\30.e”. If a single quote occurs in your value then follow your shell convention for escaping it; for example in bash:

$ helm upgrade --set pwd='3jk$o2z=f\\30with'\''quote'

which results in “pwd: 3jk$o2z=f\30with’quote”.

helm upgrade [RELEASE] [CHART] [flags]

Options

      --atomic                   If set, upgrade process rolls back changes made in case of failed upgrade, also sets --wait flag
      --ca-file string           Verify certificates of HTTPS-enabled servers using this CA bundle
      --cert-file string         Identify HTTPS client using this SSL certificate file
      --cleanup-on-fail          Allow deletion of new resources created in this upgrade when upgrade failed
      --description string       Specify the description to use for the upgrade, rather than the default
      --devel                    Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
      --dry-run                  Simulate an upgrade
      --force                    Force resource update through delete/recreate if needed
  -h, --help                     help for upgrade
  -i, --install                  If a release by this name doesn't already exist, run an install
      --key-file string          Identify HTTPS client using this SSL key file
      --keyring string           Path to the keyring that contains public signing keys (default "~/.gnupg/pubring.gpg")
      --namespace string         Namespace to install the release into (only used if --install is set). Defaults to the current kube config namespace
      --no-hooks                 Disable pre/post upgrade hooks
  -o, --output string            Prints the output in the specified format. Allowed values: table, json, yaml (default "table")
      --password string          Chart repository password where to locate the requested chart
      --recreate-pods            Performs pods restart for the resource if applicable
      --render-subchart-notes    Render subchart notes along with parent
      --repo string              Chart repository url where to locate the requested chart
      --reset-values             When upgrading, reset the values to the ones built into the chart
      --reuse-values             When upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored.
      --set stringArray          Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --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)
      --set-string stringArray   Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
      --timeout int              Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
      --tls                      Enable TLS for request
      --tls-ca-cert string       Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string          Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string      The server name used to verify the hostname on the returned certificates from the server
      --tls-key string           Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify               Enable TLS for request and verify remote
      --username string          Chart repository username where to locate the requested chart
  -f, --values valueFiles        Specify values in a YAML file or a URL(can specify multiple) (default [])
      --verify                   Verify the provenance of the chart before upgrading
      --version string           Specify the exact chart version to use. If this is not specified, the latest version is used
      --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

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm verify

Verify that a chart at the given path has been signed and is valid

Synopsis

Verify that the given chart has a valid provenance file.

Provenance files provide cryptographic verification that a chart has not been tampered with, and was packaged by a trusted provider.

This command can be used to verify a local chart. Several other commands provide ‘–verify’ flags that run the same validation. To generate a signed package, use the ‘helm package –sign’ command.

helm verify [flags] PATH

Options

  -h, --help             help for verify
      --keyring string   Keyring containing public keys (default "~/.gnupg/pubring.gpg")

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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

helm version

Print the client/server version information

Synopsis

Show the client and server versions for Helm and tiller.

This will print a representation of the client and server versions of Helm and Tiller. The output will look something like this:

Client: &version.Version{SemVer:“v2.0.0”, GitCommit:“ff52399e51bb880526e9cd0ed8386f6433b74da1”, GitTreeState:“clean”} Server: &version.Version{SemVer:“v2.0.0”, GitCommit:“b0c113dfb9f612a9add796549da66c0d294508a3”, GitTreeState:“clean”}

  • SemVer is the semantic version of the release.
  • GitCommit is the SHA for the commit that this version was built from.
  • GitTreeState is “clean” if there are no local code changes when this binary was built, and “dirty” if the binary was built from locally modified code.

To print just the client version, use ‘–client’. To print just the server version, use ‘–server’.

helm version [flags]

Options

  -c, --client                Client version only
  -h, --help                  help for version
  -s, --server                Server version only
      --short                 Print the version number
      --template string       Template for version string format
      --tls                   Enable TLS for request
      --tls-ca-cert string    Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
      --tls-cert string       Path to TLS certificate file (default "$HELM_HOME/cert.pem")
      --tls-hostname string   The server name used to verify the hostname on the returned certificates from the server
      --tls-key string        Path to TLS key file (default "$HELM_HOME/key.pem")
      --tls-verify            Enable TLS for request and verify remote

Options inherited from parent commands

      --debug                           Enable verbose output
      --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
      --host string                     Address of Tiller. Overrides $HELM_HOST
      --kube-context string             Name of the kubeconfig context to use
      --kubeconfig string               Absolute path of the kubeconfig file to be used
      --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
      --tiller-namespace string         Namespace of Tiller (default "kube-system")

SEE ALSO

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