Difference between revisions of "Helm --help"
Jump to navigation
Jump to search
| (7 intermediate revisions by 3 users not shown) | |||
| Line 10: | Line 10: | ||
- [[helm install]]: upload the chart to Kubernetes | - [[helm install]]: upload the chart to Kubernetes | ||
- [[helm list]]: list releases of charts | - [[helm list]]: list releases of charts | ||
| − | + | ||
| − | + | ||
Environment variables: | Environment variables: | ||
| Line 61: | Line 61: | ||
dependency manage a chart's dependencies | dependency manage a chart's dependencies | ||
env helm client environment information | env helm client environment information | ||
| − | get download extended information of a named release | + | [[helm get|get]] download extended information of a named release |
help Help about any command | help Help about any command | ||
| − | history fetch release history | + | [[helm history|history]] fetch release history |
install install a chart | install install a chart | ||
lint examine a chart for possible issues | lint examine a chart for possible issues | ||
list list releases | list list releases | ||
| − | package package a chart directory into a chart archive | + | [[helm package|package]] package a chart directory into a chart archive |
plugin install, list, or uninstall Helm plugins | plugin install, list, or uninstall Helm plugins | ||
pull download a chart from a repository and (optionally) unpack it in local directory | pull download a chart from a repository and (optionally) unpack it in local directory | ||
| Line 76: | Line 76: | ||
status display the status of the named release | status display the status of the named release | ||
[[helm template|template]] locally render templates | [[helm template|template]] locally render templates | ||
| − | test run tests for a release | + | [[helm test|test]] run tests for a release |
[[helm uninstall|uninstall]] uninstall a release | [[helm uninstall|uninstall]] uninstall a release | ||
upgrade upgrade a release | upgrade upgrade a release | ||
| Line 99: | Line 99: | ||
Use "helm [command] --help" for more information about a command. | Use "helm [command] --help" for more information about a command. | ||
</pre> | </pre> | ||
| + | |||
| + | == Helm v2 --help == | ||
| + | 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 | ||
| + | |||
| + | Usage: | ||
| + | helm [command] | ||
| + | |||
| + | Available Commands: | ||
| + | completion Generate autocompletions script for the specified shell (bash or zsh) | ||
| + | create Create a new chart with the given name | ||
| + | [[helm delete|delete]] Given a release name, delete the release from Kubernetes | ||
| + | dependency Manage a chart's dependencies | ||
| + | fetch Download a chart from a repository and (optionally) unpack it in local directory | ||
| + | get Download a named release | ||
| + | help Help about any command | ||
| + | history Fetch release history | ||
| + | home Displays the location of HELM_HOME | ||
| + | init Initialize Helm on both client and server | ||
| + | inspect Inspect a chart | ||
| + | install Install a chart archive | ||
| + | lint Examines a chart for possible issues | ||
| + | list List releases | ||
| + | [[helm package|package]] Package a chart directory into a chart archive | ||
| + | plugin Add, list, or remove Helm plugins | ||
| + | repo Add, list, remove, update, and index chart repositories | ||
| + | reset Uninstalls Tiller from a cluster | ||
| + | rollback Rollback a release to a previous revision | ||
| + | search Search for a keyword in charts | ||
| + | serve Start a local http web server | ||
| + | status Displays the status of the named release | ||
| + | template Locally render templates | ||
| + | test Test a release | ||
| + | upgrade Upgrade a release | ||
| + | verify Verify that a chart at the given path has been signed and is valid | ||
| + | version Print the client/server version information | ||
| + | |||
| + | Flags: | ||
| + | --debug Enable verbose output | ||
| + | -h, --help help for helm | ||
| + | --home string Location of your Helm config. Overrides $HELM_HOME (default "/Users/el/.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") | ||
| + | |||
| + | Use "helm [command] --help" for more information about a command. | ||
== See also == | == See also == | ||
Latest revision as of 08:37, 28 September 2022
helm --help 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: | Name | Description | |------------------------------------|-----------------------------------------------------------------------------------| | $HELM_CACHE_HOME | set an alternative location for storing cached files. | | $HELM_CONFIG_HOME | set an alternative location for storing Helm configuration. | | $HELM_DATA_HOME | set an alternative location for storing Helm data. | | $HELM_DEBUG | indicate whether or not Helm is running in Debug mode | | $HELM_DRIVER | set the backend storage driver. Values are: configmap, secret, memory, sql. | | $HELM_DRIVER_SQL_CONNECTION_STRING | set the connection string the SQL storage driver should use. | | $HELM_MAX_HISTORY | set the maximum number of helm release history. | | $HELM_NAMESPACE | set the namespace used for the helm operations. | | $HELM_NO_PLUGINS | disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. | | $HELM_PLUGINS | set the path to the plugins directory | | $HELM_REGISTRY_CONFIG | set the path to the registry config file. | | $HELM_REPOSITORY_CACHE | set the path to the repository cache directory | | $HELM_REPOSITORY_CONFIG | set the path to the repositories file. | | $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") | | $HELM_KUBEAPISERVER | set the Kubernetes API Server Endpoint for authentication | | $HELM_KUBECAFILE | set the Kubernetes certificate authority file. | | $HELM_KUBEASGROUPS | set the Groups to use for impersonation using a comma-separated list. | | $HELM_KUBEASUSER | set the Username to impersonate for the operation. | | $HELM_KUBECONTEXT | set the name of the kubeconfig context. | | $HELM_KUBETOKEN | set 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 System | Cache Path | Configuration Path | Data 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 | Usage: helm [command]
Available Commands: completion generate autocompletion scripts for the specified shell create create a new chart with the given name dependency manage a chart's dependencies env helm client environment information get download extended information of a named release help Help about any command history fetch release history install install a chart lint examine a chart for possible issues list list releases package package a chart directory into a chart archive plugin install, list, or uninstall Helm plugins pull download a chart from a repository and (optionally) unpack it in local directory repo add, list, remove, update, and index chart repositories rollback roll back a release to a previous revision search search for a keyword in charts show show information of a chart status display the status of the named release template locally render templates test run tests for a release uninstall uninstall a release upgrade upgrade a release verify verify that a chart at the given path has been signed and is valid version print the client version information
Flags:
--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 "/root/.config/helm/registry.json")
--repository-cache string path to the file containing cached repository indexes (default "/root/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "/root/.config/helm/repositories.yaml")
Use "helm [command] --help" for more information about a command.
Helm v2 --help[edit]
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 Usage: helm [command] Available Commands: completion Generate autocompletions script for the specified shell (bash or zsh) create Create a new chart with the given name delete Given a release name, delete the release from Kubernetes dependency Manage a chart's dependencies fetch Download a chart from a repository and (optionally) unpack it in local directory get Download a named release help Help about any command history Fetch release history home Displays the location of HELM_HOME init Initialize Helm on both client and server inspect Inspect a chart install Install a chart archive lint Examines a chart for possible issues list List releases package Package a chart directory into a chart archive plugin Add, list, or remove Helm plugins repo Add, list, remove, update, and index chart repositories reset Uninstalls Tiller from a cluster rollback Rollback a release to a previous revision search Search for a keyword in charts serve Start a local http web server status Displays the status of the named release template Locally render templates test Test a release upgrade Upgrade a release verify Verify that a chart at the given path has been signed and is valid version Print the client/server version information Flags: --debug Enable verbose output -h, --help help for helm --home string Location of your Helm config. Overrides $HELM_HOME (default "/Users/el/.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") Use "helm [command] --help" for more information about a command.
See also[edit]
- Helm,
helm[repo | template|list|install | unsintall|create|show | pull | push|status | history | plugin|search | upgrade | delete | lint | test | package | dependency | get | rollback | version | --help],helm@2, Chart file structure, Helm Charts,values.yaml, chart.yaml, Helm functions, Helm versions,helmfileDeprecated:init, variables, Mapkubeapis
Advertising:
