msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
pull/2245/head
Christoph Blecker 8 years ago
parent 797800a289
commit 190e5c82dd
No known key found for this signature in database
GPG Key ID: B34A59A9D39F838B
37 changed files with 1027 additions and 116 deletions
Show Stats Download Patch File Download Diff File

6
docs/helm/helm.md
Unescape View File

@ -54,15 +54,19 @@ Environment:
* [helm lint](helm_lint.md) - examines a chart for possible issues * [helm lint](helm_lint.md) - examines a chart for possible issues
* [helm list](helm_list.md) - list releases * [helm list](helm_list.md) - list releases
* [helm package](helm_package.md) - package a chart directory into a chart archive * [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 repo](helm_repo.md) - add, list, remove, update, and index chart repositories * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster * [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm rollback](helm_rollback.md) - roll back a release to a previous revision * [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 search](helm_search.md) - search for a keyword in charts
* [helm serve](helm_serve.md) - start a local http web server * [helm serve](helm_serve.md) - start a local http web server
* [helm status](helm_status.md) - displays the status of the named release * [helm status](helm_status.md) - displays the status of the named release
* [helm test](helm_test.md) - test a release * [helm test](helm_test.md) - test a release
* [helm test](helm_test.md) - test a release
* [helm upgrade](helm_upgrade.md) - upgrade a release * [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 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/server version information * [helm version](helm_version.md) - print the client/server version information
* [helm version](helm_version.md) - print the client/server version information
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

15
docs/helm/helm_delete.md
Unescape View File

@ -20,10 +20,15 @@ helm delete [flags] RELEASE_NAME [...]
### Options ### Options
``` ```
--dry-run simulate a delete --dry-run simulate a delete
--no-hooks prevent hooks from running during deletion --no-hooks prevent hooks from running during deletion
--purge remove the release from the store and make its name free for later use --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) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -39,4 +44,4 @@ helm delete [flags] RELEASE_NAME [...]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

23
docs/helm/helm_dependency.md
Unescape View File

@ -24,10 +24,10 @@ For example, this requirements file declares two dependencies:
dependencies: dependencies:
- name: nginx - name: nginx
version: "1.2.3" version: "1.2.3"
repository: "https://example.com/charts" repository: "https://example.com/charts"
- name: memcached - name: memcached
version: "3.2.1" version: "3.2.1"
repository: "https://another.example.com/charts" repository: "https://another.example.com/charts"
The 'name' should be the name of a chart, where that name must match the name The 'name' should be the name of a chart, where that name must match the name
in that chart's 'Chart.yaml' file. in that chart's 'Chart.yaml' file.
@ -36,20 +36,8 @@ The 'version' field should contain a semantic version or version range.
The 'repository' URL should point to a Chart Repository. Helm expects that by 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 appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL.
A repository can also be represented by a repository name defined in the index file
in lieu of a repository URL. If a repository alias is used, it is expected to start with
'alias:' or '@', followed by a repository name. For example,
# requirements.yaml
dependencies:
- name: nginx
version: "1.2.3"
repository: "alias:stable"
Note: In the above example, if the '@' syntax is used, the repository alias '@stable'
must be quoted, as YAML requires to use quotes if the value includes a special character
like '@'.
Starting from 2.2.0, repository can be defined as the path to the directory of 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 the dependency charts stored locally. The path should start with a prefix of
@ -65,6 +53,7 @@ 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 repository added to helm by "helm add repo". Version matching is also supported
for this case. for this case.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
@ -81,4 +70,4 @@ for this case.
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart * [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 requirements.yaml * [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of requirements.yaml
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

9
docs/helm/helm_get.md
Unescape View File

@ -25,7 +25,12 @@ helm get [flags] RELEASE_NAME
### Options ### Options
``` ```
--revision int32 get the named release with revision --revision int32 get the named release with revision
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -44,4 +49,4 @@ helm get [flags] RELEASE_NAME
* [helm get manifest](helm_get_manifest.md) - download the manifest 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 * [helm get values](helm_get_values.md) - download the values file for a named release
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

9
docs/helm/helm_history.md
Unescape View File

@ -28,7 +28,12 @@ helm history [flags] RELEASE_NAME
### Options ### Options
``` ```
--max int32 maximum number of revision to include in history (default 256) --max int32 maximum number of revision to include in history (default 256)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -44,4 +49,4 @@ helm history [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

18
docs/helm/helm_init.md
Unescape View File

@ -33,11 +33,17 @@ helm init
### Options ### Options
``` ```
--canary-image use the canary tiller image --canary-image use the canary tiller image
-c, --client-only if set does not install tiller -c, --client-only if set does not install tiller
--dry-run do not install local or remote --dry-run do not install local or remote
-i, --tiller-image string override tiller image --skip-refresh do not refresh (download) the local repository cache
--upgrade upgrade if tiller is already installed -i, --tiller-image string override tiller image
--tiller-tls install tiller with TLS enabled
--tiller-tls-cert string path to TLS certificate file to install with tiller
--tiller-tls-key string path to TLS key file to install with tiller
--tiller-tls-verify install tiller with TLS enabled and to verify remote certificates
--tls-ca-cert string path to CA root certificate
--upgrade upgrade if tiller is already installed
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -53,4 +59,4 @@ helm init
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

9
docs/helm/helm_install.md
Unescape View File

@ -77,10 +77,15 @@ helm install [CHART]
--replace re-use the given name, even if that name is already used. This is unsafe in production --replace re-use the given name, even if that name is already used. This is unsafe in production
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set stringArray set 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) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default []) -f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
--verify verify the package before installing it --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 --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, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout --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 ### Options inherited from parent commands
@ -96,4 +101,4 @@ helm install [CHART]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

29
docs/helm/helm_list.md
Unescape View File

@ -39,17 +39,22 @@ helm list [flags] [FILTER]
### Options ### Options
``` ```
--all show all releases, not just the ones marked DEPLOYED --all show all releases, not just the ones marked DEPLOYED
-d, --date sort by release date -d, --date sort by release date
--deleted show deleted releases --deleted show deleted releases
--deleting show releases that are currently being deleted --deleting show releases that are currently being deleted
--deployed show deployed releases. If no other is specified, this will be automatically enabled --deployed show deployed releases. If no other is specified, this will be automatically enabled
--failed show failed releases --failed show failed releases
-m, --max int maximum number of releases to fetch (default 256) -m, --max int maximum number of releases to fetch (default 256)
--namespace string show releases within a specific namespace --namespace string show releases within a specific namespace
-o, --offset string next release name in the list, used to offset from start value -o, --offset string next release name in the list, used to offset from start value
-r, --reverse reverse the sort order -r, --reverse reverse the sort order
-q, --short output short (quiet) listing format -q, --short output short (quiet) listing format
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -65,4 +70,4 @@ helm list [flags] [FILTER]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

13
docs/helm/helm_package.md
Unescape View File

@ -23,11 +23,12 @@ helm package [flags] [CHART_PATH] [...]
### Options ### Options
``` ```
--key string name of the key to use when signing. Used if --sign is true -d, --destination string location to write the chart. (default ".")
--keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") --key string name of the key to use when signing. Used if --sign is true
--save save packaged chart to local chart repository (default true) --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg")
--sign use a PGP private key to sign this package --save save packaged chart to local chart repository (default true)
--version string set the version on the chart to this semver version --sign use a PGP private key to sign this package
--version string set the version on the chart to this semver version
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -43,4 +44,4 @@ helm package [flags] [CHART_PATH] [...]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

28
docs/helm/helm_plugin.md
Unescape View File

@ -0,0 +1,28 @@
## helm plugin
add, list, or remove Helm plugins
### Synopsis
Manage client-side Helm plugins.
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### 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
###### Auto generated by spf13/cobra on 12-Apr-2017

33
docs/helm/helm_plugin_install.md
Unescape View File

@ -0,0 +1,33 @@
## helm plugin install
install one or more Helm plugins
### Synopsis
install one or more Helm plugins
```
helm plugin install [options] <path|url>...
```
### Options
```
--version string specify a version constraint. If this is not specified, the latest version is installed
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 12-Apr-2017

27
docs/helm/helm_plugin_list.md
Unescape View File

@ -0,0 +1,27 @@
## helm plugin list
list installed Helm plugins
### Synopsis
list installed Helm plugins
```
helm plugin list
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 12-Apr-2017

27
docs/helm/helm_plugin_remove.md
Unescape View File

@ -0,0 +1,27 @@
## helm plugin remove
remove one or more Helm plugins
### Synopsis
remove one or more Helm plugins
```
helm plugin remove <plugin>...
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 12-Apr-2017

11
docs/helm/helm_reset.md
Unescape View File

@ -18,8 +18,13 @@ helm reset
### Options ### Options
``` ```
-f, --force forces Tiller uninstall even if there are releases installed -f, --force forces Tiller uninstall even if there are releases installed
--remove-helm-home if set deletes $HELM_HOME --remove-helm-home if set deletes $HELM_HOME
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -35,4 +40,4 @@ helm reset
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

17
docs/helm/helm_rollback.md
Unescape View File

@ -20,11 +20,16 @@ helm rollback [flags] [RELEASE] [REVISION]
### Options ### Options
``` ```
--dry-run simulate a rollback --dry-run simulate a rollback
--no-hooks prevent hooks from running during rollback --no-hooks prevent hooks from running during rollback
--recreate-pods performs pods restart for the resource if applicable --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) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--wait if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout --tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -40,4 +45,4 @@ helm rollback [flags] [RELEASE] [REVISION]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

9
docs/helm/helm_status.md
Unescape View File

@ -23,7 +23,12 @@ helm status [flags] RELEASE_NAME
### Options ### Options
``` ```
--revision int32 if set, display the status of the named release with revision --revision int32 if set, display the status of the named release with revision
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -39,4 +44,4 @@ helm status [flags] RELEASE_NAME
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

34
docs/helm/helm_upgrade.md
Unescape View File

@ -36,19 +36,25 @@ helm upgrade [RELEASE] [CHART]
### Options ### Options
``` ```
--dry-run simulate an upgrade --dry-run simulate an upgrade
-i, --install if a release by this name doesn't already exist, run an install -i, --install if a release by this name doesn't already exist, run an install
--keyring string path to the keyring that contains public signing keys (default "~/.gnupg/pubring.gpg") --keyring string path to the keyring that contains public signing keys (default "~/.gnupg/pubring.gpg")
--namespace string namespace to install the release into (only used if --install is set) (default "default") --namespace string namespace to install the release into (only used if --install is set) (default "default")
--no-hooks disable pre/post upgrade hooks --no-hooks disable pre/post upgrade hooks
--recreate-pods performs pods restart for the resource if applicable --recreate-pods performs pods restart for the resource if applicable
--reset-values when upgrading, reset the values to the ones built into the chart --reset-values when upgrading, reset the values to the ones built into the chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --reuse-values when upgrading, reuse the last release's values, and merge in any new values. If '--reset-values' is specified, this is ignored.
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default []) --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--verify verify the provenance of the chart before upgrading --tls enable TLS for request
--version string specify the exact chart version to use. If this is not specified, the latest version is used --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--wait if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
--verify verify the provenance of the chart before upgrading
--version string specify the exact chart version to use. If this is not specified, the latest version is used
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -64,4 +70,4 @@ helm upgrade [RELEASE] [CHART]
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

13
docs/helm/helm_version.md
Unescape View File

@ -30,9 +30,14 @@ helm version
### Options ### Options
``` ```
-c, --client client version only -c, --client client version only
-s, --server server version only -s, --server server version only
--short print the version number --short print the version number
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -48,4 +53,4 @@ helm version
### SEE ALSO ### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017 ###### Auto generated by spf13/cobra on 12-Apr-2017

6
docs/man/man1/helm.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -77,9 +77,9 @@ Environment:
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP \fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-plugin(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP, \fBhelm\-version(1)\fP
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_delete.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -40,6 +40,26 @@ deleting them.
\fB\-\-timeout\fP=300 \fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -70,4 +90,4 @@ deleting them.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

8
docs/man/man1/helm_dependency.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -40,10 +40,10 @@ For example, this requirements file declares two dependencies:
dependencies: dependencies:
\- name: nginx \- name: nginx
version: "1.2.3" version: "1.2.3"
repository: "https://example.com/charts" repository: "https://example.com/charts"
\- name: memcached \- name: memcached
version: "3.2.1" version: "3.2.1"
repository: "https://another.example.com/charts" repository: "https://another.example.com/charts"
.fi .fi
.RE .RE
@ -114,4 +114,4 @@ for this case.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_get.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -36,6 +36,26 @@ chart, the supplied values, and the generated manifest file.
\fB\-\-revision\fP=0 \fB\-\-revision\fP=0
get the named release with revision get the named release with revision
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -66,4 +86,4 @@ chart, the supplied values, and the generated manifest file.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_history.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -44,6 +44,26 @@ REVISION UPDATED STATUS CHART DESCRIPTIO
\fB\-\-max\fP=256 \fB\-\-max\fP=256
maximum number of revision to include in history maximum number of revision to include in history
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -74,4 +94,4 @@ REVISION UPDATED STATUS CHART DESCRIPTIO
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

28
docs/man/man1/helm_init.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -52,10 +52,34 @@ To dump a manifest containing the Tiller deployment YAML, combine the
\fB\-\-dry\-run\fP[=false] \fB\-\-dry\-run\fP[=false]
do not install local or remote do not install local or remote
.PP
\fB\-\-skip\-refresh\fP[=false]
do not refresh (download) the local repository cache
.PP .PP
\fB\-i\fP, \fB\-\-tiller\-image\fP="" \fB\-i\fP, \fB\-\-tiller\-image\fP=""
override tiller image override tiller image
.PP
\fB\-\-tiller\-tls\fP[=false]
install tiller with TLS enabled
.PP
\fB\-\-tiller\-tls\-cert\fP=""
path to TLS certificate file to install with tiller
.PP
\fB\-\-tiller\-tls\-key\fP=""
path to TLS key file to install with tiller
.PP
\fB\-\-tiller\-tls\-verify\fP[=false]
install tiller with TLS enabled and to verify remote certificates
.PP
\fB\-\-tls\-ca\-cert\fP=""
path to CA root certificate
.PP .PP
\fB\-\-upgrade\fP[=false] \fB\-\-upgrade\fP[=false]
upgrade if tiller is already installed upgrade if tiller is already installed
@ -90,4 +114,4 @@ To dump a manifest containing the Tiller deployment YAML, combine the
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

26
docs/man/man1/helm_install.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -150,6 +150,26 @@ charts in a repository, use 'helm search'.
\fB\-\-timeout\fP=300 \fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.PP .PP
\fB\-f\fP, \fB\-\-values\fP=[] \fB\-f\fP, \fB\-\-values\fP=[]
specify values in a YAML file (can specify multiple) specify values in a YAML file (can specify multiple)
@ -164,7 +184,7 @@ charts in a repository, use 'helm search'.
.PP .PP
\fB\-\-wait\fP[=false] \fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout 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
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -196,4 +216,4 @@ charts in a repository, use 'helm search'.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_list.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -98,6 +98,26 @@ flag with the '\-\-offset' flag allows you to page through results.
\fB\-q\fP, \fB\-\-short\fP[=false] \fB\-q\fP, \fB\-\-short\fP[=false]
output short (quiet) listing format output short (quiet) listing format
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -128,4 +148,4 @@ flag with the '\-\-offset' flag allows you to page through results.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

8
docs/man/man1/helm_package.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -28,6 +28,10 @@ Versioned chart archives are used by Helm package repositories.
.SH OPTIONS .SH OPTIONS
.PP
\fB\-d\fP, \fB\-\-destination\fP="."
location to write the chart.
.PP .PP
\fB\-\-key\fP="" \fB\-\-key\fP=""
name of the key to use when signing. Used if \-\-sign is true name of the key to use when signing. Used if \-\-sign is true
@ -78,4 +82,4 @@ Versioned chart archives are used by Helm package repositories.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

50
docs/man/man1/helm_plugin.1
Unescape View File

@ -0,0 +1,50 @@
.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-plugin \- add, list, or remove Helm plugins
.SH SYNOPSIS
.PP
\fBhelm plugin\fP
.SH DESCRIPTION
.PP
Manage client\-side Helm plugins.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm(1)\fP, \fBhelm\-plugin\-install(1)\fP, \fBhelm\-plugin\-list(1)\fP, \fBhelm\-plugin\-remove(1)\fP
.SH HISTORY
.PP
12\-Apr\-2017 Auto generated by spf13/cobra

56
docs/man/man1/helm_plugin_install.1
Unescape View File

@ -0,0 +1,56 @@
.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-plugin\-install \- install one or more Helm plugins
.SH SYNOPSIS
.PP
\fBhelm plugin install [options] <path|url>\&...\fP
.SH DESCRIPTION
.PP
install one or more Helm plugins
.SH OPTIONS
.PP
\fB\-\-version\fP=""
specify a version constraint. If this is not specified, the latest version is installed
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm\-plugin(1)\fP
.SH HISTORY
.PP
12\-Apr\-2017 Auto generated by spf13/cobra

50
docs/man/man1/helm_plugin_list.1
Unescape View File

@ -0,0 +1,50 @@
.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-plugin\-list \- list installed Helm plugins
.SH SYNOPSIS
.PP
\fBhelm plugin list\fP
.SH DESCRIPTION
.PP
list installed Helm plugins
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm\-plugin(1)\fP
.SH HISTORY
.PP
12\-Apr\-2017 Auto generated by spf13/cobra

50
docs/man/man1/helm_plugin_remove.1
Unescape View File

@ -0,0 +1,50 @@
.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-plugin\-remove \- remove one or more Helm plugins
.SH SYNOPSIS
.PP
\fBhelm plugin remove <plugin>\&...\fP
.SH DESCRIPTION
.PP
remove one or more Helm plugins
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm\-plugin(1)\fP
.SH HISTORY
.PP
12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_reset.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -29,6 +29,26 @@ $HELM\_HOME (default \~/.helm/)
\fB\-\-remove\-helm\-home\fP[=false] \fB\-\-remove\-helm\-home\fP[=false]
if set deletes $HELM\_HOME if set deletes $HELM\_HOME
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -59,4 +79,4 @@ $HELM\_HOME (default \~/.helm/)
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

26
docs/man/man1/helm_rollback.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -40,9 +40,29 @@ second is a revision (version) number. To see revision numbers, run
\fB\-\-timeout\fP=300 \fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.PP .PP
\fB\-\-wait\fP[=false] \fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout 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
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -74,4 +94,4 @@ second is a revision (version) number. To see revision numbers, run
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_status.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -30,6 +30,26 @@ The status consists of:
\fB\-\-revision\fP=0 \fB\-\-revision\fP=0
if set, display the status of the named release with revision if set, display the status of the named release with revision
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -60,4 +80,4 @@ The status consists of:
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

30
docs/man/man1/helm_upgrade.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -85,6 +85,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
\fB\-\-reset\-values\fP[=false] \fB\-\-reset\-values\fP[=false]
when upgrading, reset the values to the ones built into the chart when upgrading, reset the values to the ones built into the chart
.PP
\fB\-\-reuse\-values\fP[=false]
when upgrading, reuse the last release's values, and merge in any new values. If '\-\-reset\-values' is specified, this is ignored.
.PP .PP
\fB\-\-set\fP=[] \fB\-\-set\fP=[]
set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
@ -93,6 +97,26 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
\fB\-\-timeout\fP=300 \fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.PP .PP
\fB\-f\fP, \fB\-\-values\fP=[] \fB\-f\fP, \fB\-\-values\fP=[]
specify values in a YAML file (can specify multiple) specify values in a YAML file (can specify multiple)
@ -107,7 +131,7 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
.PP .PP
\fB\-\-wait\fP[=false] \fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout 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
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
@ -139,4 +163,4 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

24
docs/man/man1/helm_version.1
Unescape View File

@ -1,4 +1,4 @@
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" .TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh .nh
.ad l .ad l
@ -50,6 +50,26 @@ use '\-\-server'.
\fB\-\-short\fP[=false] \fB\-\-short\fP[=false]
print the version number print the version number
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS .SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP .PP
@ -80,4 +100,4 @@ use '\-\-server'.
.SH HISTORY .SH HISTORY
.PP .PP
11\-Mar\-2017 Auto generated by spf13/cobra 12\-Apr\-2017 Auto generated by spf13/cobra

307
scripts/completions.bash
Unescape View File

@ -289,6 +289,16 @@ _helm_delete()
local_nonpersistent_flags+=("--purge") local_nonpersistent_flags+=("--purge")
flags+=("--timeout=") flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=") local_nonpersistent_flags+=("--timeout=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
@ -529,6 +539,16 @@ _helm_get()
flags+=("--revision=") flags+=("--revision=")
local_nonpersistent_flags+=("--revision=") local_nonpersistent_flags+=("--revision=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
@ -553,6 +573,16 @@ _helm_history()
flags+=("--max=") flags+=("--max=")
local_nonpersistent_flags+=("--max=") local_nonpersistent_flags+=("--max=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
@ -604,9 +634,21 @@ _helm_init()
local_nonpersistent_flags+=("--client-only") local_nonpersistent_flags+=("--client-only")
flags+=("--dry-run") flags+=("--dry-run")
local_nonpersistent_flags+=("--dry-run") local_nonpersistent_flags+=("--dry-run")
flags+=("--skip-refresh")
local_nonpersistent_flags+=("--skip-refresh")
flags+=("--tiller-image=") flags+=("--tiller-image=")
two_word_flags+=("-i") two_word_flags+=("-i")
local_nonpersistent_flags+=("--tiller-image=") local_nonpersistent_flags+=("--tiller-image=")
flags+=("--tiller-tls")
local_nonpersistent_flags+=("--tiller-tls")
flags+=("--tiller-tls-cert=")
local_nonpersistent_flags+=("--tiller-tls-cert=")
flags+=("--tiller-tls-key=")
local_nonpersistent_flags+=("--tiller-tls-key=")
flags+=("--tiller-tls-verify")
local_nonpersistent_flags+=("--tiller-tls-verify")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--upgrade") flags+=("--upgrade")
local_nonpersistent_flags+=("--upgrade") local_nonpersistent_flags+=("--upgrade")
flags+=("--debug") flags+=("--debug")
@ -736,6 +778,16 @@ _helm_install()
local_nonpersistent_flags+=("--set=") local_nonpersistent_flags+=("--set=")
flags+=("--timeout=") flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=") local_nonpersistent_flags+=("--timeout=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--values=") flags+=("--values=")
two_word_flags+=("-f") two_word_flags+=("-f")
local_nonpersistent_flags+=("--values=") local_nonpersistent_flags+=("--values=")
@ -818,6 +870,16 @@ _helm_list()
flags+=("--short") flags+=("--short")
flags+=("-q") flags+=("-q")
local_nonpersistent_flags+=("--short") local_nonpersistent_flags+=("--short")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
@ -840,6 +902,9 @@ _helm_package()
flags_with_completion=() flags_with_completion=()
flags_completion=() flags_completion=()
flags+=("--destination=")
two_word_flags+=("-d")
local_nonpersistent_flags+=("--destination=")
flags+=("--key=") flags+=("--key=")
local_nonpersistent_flags+=("--key=") local_nonpersistent_flags+=("--key=")
flags+=("--keyring=") flags+=("--keyring=")
@ -861,6 +926,99 @@ _helm_package()
noun_aliases=() noun_aliases=()
} }
_helm_plugin_install()
{
last_command="helm_plugin_install"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--version=")
local_nonpersistent_flags+=("--version=")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_plugin_list()
{
last_command="helm_plugin_list"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_plugin_remove()
{
last_command="helm_plugin_remove"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_plugin()
{
last_command="helm_plugin"
commands=()
commands+=("install")
commands+=("list")
commands+=("remove")
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_repo_add() _helm_repo_add()
{ {
last_command="helm_repo_add" last_command="helm_repo_add"
@ -1037,6 +1195,43 @@ _helm_reset()
noun_aliases=() noun_aliases=()
} }
_helm_reset()
{
last_command="helm_reset"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--force")
flags+=("-f")
local_nonpersistent_flags+=("--force")
flags+=("--remove-helm-home")
local_nonpersistent_flags+=("--remove-helm-home")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_rollback() _helm_rollback()
{ {
last_command="helm_rollback" last_command="helm_rollback"
@ -1056,6 +1251,16 @@ _helm_rollback()
local_nonpersistent_flags+=("--recreate-pods") local_nonpersistent_flags+=("--recreate-pods")
flags+=("--timeout=") flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=") local_nonpersistent_flags+=("--timeout=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--wait") flags+=("--wait")
local_nonpersistent_flags+=("--wait") local_nonpersistent_flags+=("--wait")
flags+=("--debug") flags+=("--debug")
@ -1137,6 +1342,52 @@ _helm_status()
flags_completion=() flags_completion=()
flags+=("--revision=") flags+=("--revision=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_test()
{
last_command="helm_test"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--cleanup")
local_nonpersistent_flags+=("--cleanup")
flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug") flags+=("--debug")
flags+=("--home=") flags+=("--home=")
flags+=("--host=") flags+=("--host=")
@ -1202,10 +1453,22 @@ _helm_upgrade()
local_nonpersistent_flags+=("--recreate-pods") local_nonpersistent_flags+=("--recreate-pods")
flags+=("--reset-values") flags+=("--reset-values")
local_nonpersistent_flags+=("--reset-values") local_nonpersistent_flags+=("--reset-values")
flags+=("--reuse-values")
local_nonpersistent_flags+=("--reuse-values")
flags+=("--set=") flags+=("--set=")
local_nonpersistent_flags+=("--set=") local_nonpersistent_flags+=("--set=")
flags+=("--timeout=") flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=") local_nonpersistent_flags+=("--timeout=")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--values=") flags+=("--values=")
two_word_flags+=("-f") two_word_flags+=("-f")
local_nonpersistent_flags+=("--values=") local_nonpersistent_flags+=("--values=")
@ -1280,6 +1543,46 @@ _helm_version()
noun_aliases=() noun_aliases=()
} }
_helm_version()
{
last_command="helm_version"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--client")
flags+=("-c")
local_nonpersistent_flags+=("--client")
flags+=("--server")
flags+=("-s")
local_nonpersistent_flags+=("--server")
flags+=("--short")
local_nonpersistent_flags+=("--short")
flags+=("--tls")
local_nonpersistent_flags+=("--tls")
flags+=("--tls-ca-cert=")
local_nonpersistent_flags+=("--tls-ca-cert=")
flags+=("--tls-cert=")
local_nonpersistent_flags+=("--tls-cert=")
flags+=("--tls-key=")
local_nonpersistent_flags+=("--tls-key=")
flags+=("--tls-verify")
local_nonpersistent_flags+=("--tls-verify")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm() _helm()
{ {
last_command="helm" last_command="helm"
@ -1298,16 +1601,20 @@ _helm()
commands+=("lint") commands+=("lint")
commands+=("list") commands+=("list")
commands+=("package") commands+=("package")
commands+=("plugin")
commands+=("repo") commands+=("repo")
commands+=("reset") commands+=("reset")
commands+=("reset")
commands+=("rollback") commands+=("rollback")
commands+=("search") commands+=("search")
commands+=("serve") commands+=("serve")
commands+=("status") commands+=("status")
commands+=("test") commands+=("test")
commands+=("test")
commands+=("upgrade") commands+=("upgrade")
commands+=("verify") commands+=("verify")
commands+=("version") commands+=("version")
commands+=("version")
flags=() flags=()
two_word_flags=() two_word_flags=()

Write Preview
Loading…
Cancel
Save