mirror of https://github.com/helm/helm
Martin Hickey
6 years ago
parent
4b9bdf5baa
commit
d59835fb67
@ -0,0 +1,68 @@
|
||||
## 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 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_DRIVER set the backend storage driver. Values are: configmap, secret, memory
|
||||
$HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.
|
||||
$KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config")
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
-h, --help help for helm
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
* [helm completion](helm_completion.md) - Generate autocompletions script for the specified shell (bash or zsh)
|
||||
* [helm create](helm_create.md) - create a new chart with the given name
|
||||
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
|
||||
* [helm get](helm_get.md) - download a named release
|
||||
* [helm history](helm_history.md) - fetch release history
|
||||
* [helm home](helm_home.md) - displays the location of HELM_HOME
|
||||
* [helm init](helm_init.md) - initialize Helm client
|
||||
* [helm install](helm_install.md) - install a chart
|
||||
* [helm lint](helm_lint.md) - examines a chart for possible issues
|
||||
* [helm list](helm_list.md) - list releases
|
||||
* [helm package](helm_package.md) - package a chart directory into a chart archive
|
||||
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
|
||||
* [helm pull](helm_pull.md) - download a chart from a repository and (optionally) unpack it in local directory
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
* [helm rollback](helm_rollback.md) - roll back a release to a previous revision
|
||||
* [helm search](helm_search.md) - search for a keyword in charts
|
||||
* [helm show](helm_show.md) - inspect a chart
|
||||
* [helm status](helm_status.md) - displays the status of the named release
|
||||
* [helm template](helm_template.md) - locally render templates
|
||||
* [helm test](helm_test.md) - test a release
|
||||
* [helm uninstall](helm_uninstall.md) - given a release name, uninstall the release from Kubernetes
|
||||
* [helm upgrade](helm_upgrade.md) - upgrade a release
|
||||
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
|
||||
* [helm version](helm_version.md) - print the client version information
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,41 @@
|
||||
## helm chart
|
||||
|
||||
push, pull, tag, or remove Helm charts
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command consists of multiple subcommands to interact with charts and registries.
|
||||
|
||||
It can be used to push, pull, tag, list, or remove Helm charts.
|
||||
Example usage:
|
||||
$ helm chart pull [URL]
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for chart
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm chart export](helm_chart_export.md) - export a chart to directory
|
||||
* [helm chart list](helm_chart_list.md) - list all saved charts
|
||||
* [helm chart pull](helm_chart_pull.md) - pull a chart from remote
|
||||
* [helm chart push](helm_chart_push.md) - push a chart to remote
|
||||
* [helm chart remove](helm_chart_remove.md) - remove a chart
|
||||
* [helm chart save](helm_chart_save.md) - save a chart directory
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,39 @@
|
||||
## helm chart export
|
||||
|
||||
export a chart to directory
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Export a chart stored in local registry cache.
|
||||
|
||||
This will create a new directory with the name of
|
||||
the chart, in a format that developers can modify
|
||||
and check into source control if desired.
|
||||
|
||||
|
||||
```
|
||||
helm chart export [ref] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for export
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,37 @@
|
||||
## helm chart list
|
||||
|
||||
list all saved charts
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
List all charts in the local registry cache.
|
||||
|
||||
Charts are sorted by ref name, alphabetically.
|
||||
|
||||
|
||||
```
|
||||
helm chart 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,37 @@
|
||||
## helm chart pull
|
||||
|
||||
pull a chart from remote
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Download a chart from a remote registry.
|
||||
|
||||
This will store the chart in the local registry cache to be used later.
|
||||
|
||||
|
||||
```
|
||||
helm chart pull [ref] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for pull
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,39 @@
|
||||
## helm chart push
|
||||
|
||||
push a chart to remote
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Upload a chart to a remote registry.
|
||||
|
||||
Note: the ref must already exist in the local registry cache.
|
||||
|
||||
Must first run "helm chart save" or "helm chart pull".
|
||||
|
||||
|
||||
```
|
||||
helm chart push [ref] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for push
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,40 @@
|
||||
## helm chart remove
|
||||
|
||||
remove a chart
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Remove a chart from the local registry cache.
|
||||
|
||||
Note: the chart content will still exist in the cache,
|
||||
but it will no longer appear in "helm chart list".
|
||||
|
||||
To remove all unlinked content, please run "helm chart prune". (TODO)
|
||||
|
||||
|
||||
```
|
||||
helm chart remove [ref] [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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,38 @@
|
||||
## helm chart save
|
||||
|
||||
save a chart directory
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Store a copy of chart in local registry cache.
|
||||
|
||||
Note: modifying the chart after this operation will
|
||||
not change the item as it exists in the cache.
|
||||
|
||||
|
||||
```
|
||||
helm chart save [path] [ref] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for save
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm chart](helm_chart.md) - push, pull, tag, or remove Helm charts
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,43 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,52 @@
|
||||
## 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.
|
||||
|
||||
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
|
||||
|
||||
'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.
|
||||
|
||||
|
||||
```
|
||||
helm create NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for create
|
||||
-p, --starter string the named Helm starter scaffold
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,78 @@
|
||||
## 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 dependencies in 'Chart.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.
|
||||
|
||||
For example, this Chart.yaml declares two dependencies:
|
||||
|
||||
# Chart.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,
|
||||
|
||||
# Chart.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 add repo". 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm dependency build](helm_dependency_build.md) - rebuild the charts/ directory based on the Chart.lock file
|
||||
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart
|
||||
* [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of Chart.yaml
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,44 @@
|
||||
## helm dependency build
|
||||
|
||||
rebuild the charts/ directory based on the Chart.lock file
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Build out the charts/ directory from the Chart.lock file.
|
||||
|
||||
Build is used to reconstruct a chart's dependencies to the state specified in
|
||||
the lock file. This will not re-negotiate dependencies, as 'helm dependency update'
|
||||
does.
|
||||
|
||||
If no lock file is found, 'helm dependency build' will mirror the behavior
|
||||
of 'helm dependency update'.
|
||||
|
||||
|
||||
```
|
||||
helm dependency build CHART [flags]
|
||||
```
|
||||
|
||||
### 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,40 @@
|
||||
## 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.
|
||||
|
||||
|
||||
```
|
||||
helm dependency list CHART [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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,49 @@
|
||||
## helm dependency update
|
||||
|
||||
update charts/ based on the contents of Chart.yaml
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Update the on-disk dependencies to mirror Chart.yaml.
|
||||
|
||||
This command verifies that the required charts, as expressed in 'Chart.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 dependencies to an exact version.
|
||||
|
||||
Dependencies are not required to be represented in 'Chart.yaml'. For that
|
||||
reason, an update command will not remove charts unless they are (a) present
|
||||
in the Chart.yaml file, but (b) at the wrong version.
|
||||
|
||||
|
||||
```
|
||||
helm dependency update CHART [flags]
|
||||
```
|
||||
|
||||
### 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,48 @@
|
||||
## 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 RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for get
|
||||
--revision int get the named release with revision
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm get hooks](helm_get_hooks.md) - download all hooks for a named release
|
||||
* [helm get manifest](helm_get_manifest.md) - download the manifest for a named release
|
||||
* [helm get values](helm_get_values.md) - download the values file for a named release
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,38 @@
|
||||
## 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 RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for hooks
|
||||
--revision int get the named release with revision
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm get](helm_get.md) - download a named release
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,40 @@
|
||||
## 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 RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for manifest
|
||||
--revision int get the named release with revision
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm get](helm_get.md) - download a named release
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,37 @@
|
||||
## 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 RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --all dump all (computed) values
|
||||
-h, --help help for values
|
||||
--revision int get the named release with revision
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm get](helm_get.md) - download a named release
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,49 @@
|
||||
## 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 DESCRIPTION
|
||||
1 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 Initial install
|
||||
2 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 Upgraded successfully
|
||||
3 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 Rolled back to 2
|
||||
4 Mon Oct 3 10:15:13 2016 deployed alpine-0.1.0 Upgraded successfully
|
||||
|
||||
|
||||
```
|
||||
helm history RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for history
|
||||
--max int maximum number of revision to include in history (default 256)
|
||||
-o, --output string prints the output in the specified format (json|table|yaml) (default "table")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,36 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,38 @@
|
||||
## helm init
|
||||
|
||||
initialize Helm client
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command sets up local configuration in $HELM_HOME (default ~/.helm/).
|
||||
|
||||
|
||||
```
|
||||
helm init [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for init
|
||||
--plugins string a YAML file specifying plugins to install
|
||||
--skip-refresh do not refresh (download) the local repository cache
|
||||
--stable-repo-url string URL for stable repository (default "https://kubernetes-charts.storage.googleapis.com")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,114 @@
|
||||
## helm install
|
||||
|
||||
install a chart
|
||||
|
||||
### 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
|
||||
a string value use '--set-string'.
|
||||
|
||||
$ helm install -f myvalues.yaml myredis ./redis
|
||||
|
||||
or
|
||||
|
||||
$ helm install --set name=prod myredis ./redis
|
||||
|
||||
or
|
||||
|
||||
$ helm install --set-string long_int=1234567890 myredis ./redis
|
||||
|
||||
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 myredis ./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 myredis ./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 [NAME] [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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
|
||||
--dependency-update run helm dependency update before installing the chart
|
||||
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
|
||||
--dry-run simulate an install
|
||||
-g, --generate-name generate the name (and omit the NAME parameter)
|
||||
-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")
|
||||
--name-template string specify template used to name the release
|
||||
--no-hooks prevent hooks from running during install
|
||||
--password string chart repository password where to locate the requested chart
|
||||
--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-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)
|
||||
--username string chart repository username where to locate the requested chart
|
||||
-f, --values strings specify values in a YAML file or a URL(can specify multiple)
|
||||
--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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,44 @@
|
||||
## 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 PATH [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for lint
|
||||
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
|
||||
--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 strings specify values in a YAML file or a URL(can specify multiple)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,72 @@
|
||||
## 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
|
||||
'--uninstalled' and '--all' will alter this behavior. Such flags can be combined:
|
||||
'--uninstalled --failed'.
|
||||
|
||||
By default, items are sorted alphabetically. Use the '-d' flag to sort by
|
||||
release date.
|
||||
|
||||
If the --filter flag 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 --filter '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]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --all show all releases, not just the ones marked deployed
|
||||
--all-namespaces list releases across all namespaces
|
||||
-d, --date sort by release date
|
||||
--deployed show deployed releases. If no other is specified, this will be automatically enabled
|
||||
--failed show failed releases
|
||||
-f, --filter string a regular expression (Perl compatible). Any releases that match the expression will be included in the results
|
||||
-h, --help help for list
|
||||
-m, --max int maximum number of releases to fetch (default 256)
|
||||
-o, --offset int next release name in the list, used to offset from start value
|
||||
--pending show pending releases
|
||||
-r, --reverse reverse the sort order
|
||||
-q, --short output short (quiet) listing format
|
||||
--superseded show superseded releases
|
||||
--uninstalled show uninstalled releases
|
||||
--uninstalling show releases that are currently being uninstalled
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,52 @@
|
||||
## 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 [CHART_PATH] [...] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--app-version string set the appVersion on the chart to this version
|
||||
-u, --dependency-update update dependencies from "Chart.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")
|
||||
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
|
||||
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
|
||||
--sign use a PGP private key to sign this package
|
||||
-f, --values strings specify values in a YAML file or a URL(can specify multiple)
|
||||
--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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,35 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm plugin install](helm_plugin_install.md) - install one or more Helm plugins
|
||||
* [helm plugin list](helm_plugin_list.md) - list installed Helm plugins
|
||||
* [helm plugin remove](helm_plugin_remove.md) - remove one or more Helm plugins
|
||||
* [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,39 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,33 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,33 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,33 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,60 @@
|
||||
## helm pull
|
||||
|
||||
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 pull [chart URL | repo/chartname] [...] [flags]
|
||||
```
|
||||
|
||||
### 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 pull
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
|
||||
--password string chart repository password where to locate the requested chart
|
||||
--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 where to locate the requested chart
|
||||
--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
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,40 @@
|
||||
## 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm repo add](helm_repo_add.md) - add a chart repository
|
||||
* [helm repo index](helm_repo_index.md) - generate an index file given a directory containing packaged charts
|
||||
* [helm repo list](helm_repo_list.md) - list chart repositories
|
||||
* [helm repo remove](helm_repo_remove.md) - remove a chart repository
|
||||
* [helm repo update](helm_repo_update.md) - update information of available charts locally from chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,39 @@
|
||||
## helm repo add
|
||||
|
||||
add a chart repository
|
||||
|
||||
### Synopsis
|
||||
|
||||
add a chart repository
|
||||
|
||||
```
|
||||
helm repo add [NAME] [URL] [flags]
|
||||
```
|
||||
|
||||
### 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,44 @@
|
||||
## 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 [DIR] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for index
|
||||
--merge string merge the generated index into the given index
|
||||
--url string 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,33 @@
|
||||
## helm repo list
|
||||
|
||||
list chart repositories
|
||||
|
||||
### Synopsis
|
||||
|
||||
list chart repositories
|
||||
|
||||
```
|
||||
helm repo 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,33 @@
|
||||
## helm repo remove
|
||||
|
||||
remove a chart repository
|
||||
|
||||
### Synopsis
|
||||
|
||||
remove a chart repository
|
||||
|
||||
```
|
||||
helm repo remove [NAME] [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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,39 @@
|
||||
## 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.
|
||||
|
||||
|
||||
```
|
||||
helm repo update [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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,46 @@
|
||||
## helm rollback
|
||||
|
||||
roll back 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'.
|
||||
|
||||
|
||||
```
|
||||
helm rollback [RELEASE] [REVISION] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--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)
|
||||
-v, --version int revision number to rollback to (default: rollback to previous release)
|
||||
--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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,41 @@
|
||||
## helm search
|
||||
|
||||
search for a keyword in charts
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Search reads through all of the repositories configured on the system, and
|
||||
looks for matches.
|
||||
|
||||
Repositories are managed with 'helm repo' commands.
|
||||
|
||||
|
||||
```
|
||||
helm search [keyword] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for search
|
||||
-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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,50 @@
|
||||
## helm show
|
||||
|
||||
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 show [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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 show
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (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 package before installing it
|
||||
--version string specify the exact chart version to install. 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
* [helm show chart](helm_show_chart.md) - shows the chart
|
||||
* [helm show readme](helm_show_readme.md) - shows the chart's README
|
||||
* [helm show values](helm_show_values.md) - shows values for this chart
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,45 @@
|
||||
## helm show chart
|
||||
|
||||
shows the chart
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the Charts.yaml file
|
||||
|
||||
|
||||
```
|
||||
helm show chart [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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 chart
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (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 package before installing it
|
||||
--version string specify the exact chart version to install. 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm show](helm_show.md) - inspect a chart
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,45 @@
|
||||
## helm show readme
|
||||
|
||||
shows the chart's README
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the README file
|
||||
|
||||
|
||||
```
|
||||
helm show readme [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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 readme
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (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 package before installing it
|
||||
--version string specify the exact chart version to install. 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm show](helm_show.md) - inspect a chart
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,45 @@
|
||||
## helm show values
|
||||
|
||||
shows values for this chart
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the values.yaml file
|
||||
|
||||
|
||||
```
|
||||
helm show values [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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 values
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (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 package before installing it
|
||||
--version string specify the exact chart version to install. 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm show](helm_show.md) - inspect a chart
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,44 @@
|
||||
## 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 RELEASE_NAME [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for status
|
||||
-o, --output string output the status in the specified format (json or yaml)
|
||||
--revision int if set, display the status of the named release with revision
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,65 @@
|
||||
## helm template
|
||||
|
||||
locally render templates
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Render chart templates locally and display the output.
|
||||
|
||||
This does not require Helm. 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 CHART [flags]
|
||||
```
|
||||
|
||||
### 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
|
||||
--dependency-update run helm dependency update before installing the chart
|
||||
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
|
||||
--dry-run simulate an install
|
||||
-g, --generate-name generate the name (and omit the NAME parameter)
|
||||
-h, --help help for template
|
||||
--key-file string identify HTTPS client using this SSL key file
|
||||
--keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
|
||||
--name-template string specify template used to name the release
|
||||
--no-hooks prevent hooks from running during install
|
||||
--password string chart repository password where to locate the requested chart
|
||||
--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-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)
|
||||
--username string chart repository username where to locate the requested chart
|
||||
-f, --values strings specify values in a YAML file or a URL(can specify multiple)
|
||||
--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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,40 @@
|
||||
## 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
|
||||
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,43 @@
|
||||
## helm uninstall
|
||||
|
||||
given a release name, uninstall the release from Kubernetes
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command takes a release name, and then uninstalls 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 uninstalled without actually
|
||||
uninstalling them.
|
||||
|
||||
|
||||
```
|
||||
helm uninstall RELEASE_NAME [...] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--dry-run simulate a uninstall
|
||||
-h, --help help for uninstall
|
||||
--no-hooks prevent hooks from running during uninstallation
|
||||
--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)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,79 @@
|
||||
## helm upgrade
|
||||
|
||||
upgrade a release
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
This command upgrades a release to a new version of a chart.
|
||||
|
||||
The upgrade arguments must be a release and chart. The chart
|
||||
argument can be either: a chart reference('stable/mariadb'), a path to a chart directory,
|
||||
a packaged chart, or a fully qualified URL. For chart references, the latest
|
||||
version will be specified unless the '--version' flag is set.
|
||||
|
||||
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, use '--set-string'.
|
||||
|
||||
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 upgrade -f myvalues.yaml -f override.yaml redis ./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 upgrade --set foo=bar --set foo=newbar redis ./redis
|
||||
|
||||
|
||||
```
|
||||
helm upgrade [RELEASE] [CHART] [flags]
|
||||
```
|
||||
|
||||
### 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
|
||||
--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
|
||||
--history-max int limit the maximum number of revisions saved per release. Use 0 for no limit.
|
||||
-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 location of public keys used for verification (default "~/.gnupg/pubring.gpg")
|
||||
--no-hooks disable pre/post upgrade hooks
|
||||
--password string chart repository password where to locate the requested chart
|
||||
--recreate-pods performs pods restart for the resource if applicable
|
||||
--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-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)
|
||||
--username string chart repository username where to locate the requested chart
|
||||
-f, --values strings specify values in a YAML file or a URL(can specify multiple)
|
||||
--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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,43 @@
|
||||
## 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 crytographic 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 PATH [flags]
|
||||
```
|
||||
|
||||
### 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")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
@ -0,0 +1,47 @@
|
||||
## helm version
|
||||
|
||||
print the client version information
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Show the version for Helm.
|
||||
|
||||
This will print a representation the version of Helm.
|
||||
The output will look something like this:
|
||||
|
||||
version.BuildInfo{Version:"v2.0.0", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"clean"}
|
||||
|
||||
- Version 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.
|
||||
|
||||
|
||||
```
|
||||
helm version [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for version
|
||||
--short print the version number
|
||||
--template string template for version string format
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug enable verbose output
|
||||
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
|
||||
--kube-context string name of the kubeconfig context to use
|
||||
--kubeconfig string path to the kubeconfig file
|
||||
-n, --namespace string namespace scope for this request
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [helm](helm.md) - The Helm package manager for Kubernetes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 15-Mar-2019
|
||||
Loading…
Reference in new issue