Helm

helm

The Helm package manager for Kubernetes.

Synopsis

The Kubernetes package manager

Common actions for Helm:

  • helm search: search for charts
  • helm pull: download a chart to your local directory to view
  • helm install: upload the chart to Kubernetes
  • helm list: list releases of charts

Environment variables:

NameDescription
$HELM_CACHE_HOMEset an alternative location for storing cached files.
$HELM_CONFIG_HOMEset an alternative location for storing Helm configuration.
$HELM_DATA_HOMEset an alternative location for storing Helm data.
$HELM_DEBUGindicate whether or not Helm is running in Debug mode
$HELM_DRIVERset the backend storage driver. Values are: configmap, secret, memory, postgres
$HELM_DRIVER_SQL_CONNECTION_STRINGset the connection string the SQL storage driver should use.
$HELM_MAX_HISTORYset the maximum number of helm release history.
$HELM_NAMESPACEset the namespace used for the helm operations.
$HELM_NO_PLUGINSdisable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.
$HELM_PLUGINSset the path to the plugins directory
$HELM_REGISTRY_CONFIGset the path to the registry config file.
$HELM_REPOSITORY_CACHEset the path to the repository cache directory
$HELM_REPOSITORY_CONFIGset the path to the repositories file.
$KUBECONFIGset an alternative Kubernetes configuration file (default "~/.kube/config")
$HELM_KUBEAPISERVERset the Kubernetes API Server Endpoint for authentication
$HELM_KUBECAFILEset the Kubernetes certificate authority file.
$HELM_KUBEASGROUPSset the Groups to use for impersonation using a comma-separated list.
$HELM_KUBEASUSERset the Username to impersonate for the operation.
$HELM_KUBECONTEXTset the name of the kubeconfig context.
$HELM_KUBETOKENset the Bearer KubeToken used for authentication.

Helm stores cache, configuration, and data based on the following configuration order:

  • If a HELM_*_HOME environment variable is set, it will be used
  • Otherwise, on systems supporting the XDG base directory specification, the XDG variables will be used
  • When no other location is set a default location will be used based on the operating system

By default, the default directories depend on the Operating System. The defaults are listed below:

Operating SystemCache PathConfiguration PathData Path
Linux$HOME/.cache/helm$HOME/.config/helm$HOME/.local/share/helm
macOS$HOME/Library/Caches/helm$HOME/Library/Preferences/helm$HOME/Library/helm
Windows%TEMP%\helm%APPDATA%\helm%APPDATA%\helm

Options

      --debug                       enable verbose output
  -h, --help                        help for helm
      --kube-apiserver string       the address and the port for the Kubernetes API server
      --kube-as-group stringArray   group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --kube-as-user string         username to impersonate for the operation
      --kube-ca-file string         the certificate authority file for the Kubernetes API server connection
      --kube-context string         name of the kubeconfig context to use
      --kube-token string           bearer token used for authentication
      --kubeconfig string           path to the kubeconfig file
  -n, --namespace string            namespace scope for this request
      --registry-config string      path to the registry config file (default "~/.config/helm/registry.json")
      --repository-cache string     path to the file containing cached repository indexes (default "~/.cache/helm/repository")
      --repository-config string    path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")

SEE ALSO

Auto generated by spf13/cobra on 16-Jun-2021