From 190e5c82dd6eb536bcb751c1a8a02f7935906cac Mon Sep 17 00:00:00 2001 From: Christoph Blecker Date: Wed, 12 Apr 2017 12:24:40 -0700 Subject: [PATCH] Update docs --- docs/helm/helm.md | 6 +- docs/helm/helm_delete.md | 15 +- docs/helm/helm_dependency.md | 23 +-- docs/helm/helm_get.md | 9 +- docs/helm/helm_history.md | 9 +- docs/helm/helm_init.md | 18 +- docs/helm/helm_install.md | 9 +- docs/helm/helm_list.md | 29 +-- docs/helm/helm_package.md | 13 +- docs/helm/helm_plugin.md | 28 +++ docs/helm/helm_plugin_install.md | 33 +++ docs/helm/helm_plugin_list.md | 27 +++ docs/helm/helm_plugin_remove.md | 27 +++ docs/helm/helm_reset.md | 11 +- docs/helm/helm_rollback.md | 17 +- docs/helm/helm_status.md | 9 +- docs/helm/helm_upgrade.md | 34 +-- docs/helm/helm_version.md | 13 +- docs/man/man1/helm.1 | 6 +- docs/man/man1/helm_delete.1 | 24 ++- docs/man/man1/helm_dependency.1 | 8 +- docs/man/man1/helm_get.1 | 24 ++- docs/man/man1/helm_history.1 | 24 ++- docs/man/man1/helm_init.1 | 28 ++- docs/man/man1/helm_install.1 | 26 ++- docs/man/man1/helm_list.1 | 24 ++- docs/man/man1/helm_package.1 | 8 +- docs/man/man1/helm_plugin.1 | 50 +++++ docs/man/man1/helm_plugin_install.1 | 56 +++++ docs/man/man1/helm_plugin_list.1 | 50 +++++ docs/man/man1/helm_plugin_remove.1 | 50 +++++ docs/man/man1/helm_reset.1 | 24 ++- docs/man/man1/helm_rollback.1 | 26 ++- docs/man/man1/helm_status.1 | 24 ++- docs/man/man1/helm_upgrade.1 | 30 ++- docs/man/man1/helm_version.1 | 24 ++- scripts/completions.bash | 307 ++++++++++++++++++++++++++++ 37 files changed, 1027 insertions(+), 116 deletions(-) create mode 100644 docs/helm/helm_plugin.md create mode 100644 docs/helm/helm_plugin_install.md create mode 100644 docs/helm/helm_plugin_list.md create mode 100644 docs/helm/helm_plugin_remove.md create mode 100644 docs/man/man1/helm_plugin.1 create mode 100644 docs/man/man1/helm_plugin_install.1 create mode 100644 docs/man/man1/helm_plugin_list.1 create mode 100644 docs/man/man1/helm_plugin_remove.1 diff --git a/docs/helm/helm.md b/docs/helm/helm.md index 4c1ddef03..33ee4f200 100644 --- a/docs/helm/helm.md +++ b/docs/helm/helm.md @@ -54,15 +54,19 @@ Environment: * [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 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 rollback](helm_rollback.md) - roll back a release to a previous revision * [helm search](helm_search.md) - search for a keyword in charts * [helm serve](helm_serve.md) - start a local http web server * [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 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/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 diff --git a/docs/helm/helm_delete.md b/docs/helm/helm_delete.md index b5abd4c16..52fff4fa1 100644 --- a/docs/helm/helm_delete.md +++ b/docs/helm/helm_delete.md @@ -20,10 +20,15 @@ helm delete [flags] RELEASE_NAME [...] ### Options ``` - --dry-run simulate a delete - --no-hooks prevent hooks from running during deletion - --purge remove the release from the store and make its name free for later use - --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) + --dry-run simulate a delete + --no-hooks prevent hooks from running during deletion + --purge remove the release from the store and make its name free for later use + --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) + --tls enable TLS for request + --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") + --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") + --tls-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 @@ -39,4 +44,4 @@ helm delete [flags] RELEASE_NAME [...] ### SEE ALSO * [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 diff --git a/docs/helm/helm_dependency.md b/docs/helm/helm_dependency.md index c2a46e39e..1156705da 100644 --- a/docs/helm/helm_dependency.md +++ b/docs/helm/helm_dependency.md @@ -24,10 +24,10 @@ For example, this requirements file declares two dependencies: dependencies: - name: nginx version: "1.2.3" - repository: "https://example.com/charts" + repository: "https://example.com/charts" - name: memcached 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 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 appending '/index.yaml' to the URL, it should be able to retrieve the chart -repository's index. - -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 '@'. +repository's index. Note: 'repository' cannot be a repository alias. It must be +a URL. 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 @@ -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 for this case. + ### 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 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 diff --git a/docs/helm/helm_get.md b/docs/helm/helm_get.md index 824bad9a6..fc334ed7d 100644 --- a/docs/helm/helm_get.md +++ b/docs/helm/helm_get.md @@ -25,7 +25,12 @@ helm get [flags] RELEASE_NAME ### 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 @@ -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 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 diff --git a/docs/helm/helm_history.md b/docs/helm/helm_history.md index 24677658c..d6df08b83 100644 --- a/docs/helm/helm_history.md +++ b/docs/helm/helm_history.md @@ -28,7 +28,12 @@ helm history [flags] RELEASE_NAME ### 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 @@ -44,4 +49,4 @@ helm history [flags] RELEASE_NAME ### SEE ALSO * [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 diff --git a/docs/helm/helm_init.md b/docs/helm/helm_init.md index a5b970ebd..9e57ba4db 100644 --- a/docs/helm/helm_init.md +++ b/docs/helm/helm_init.md @@ -33,11 +33,17 @@ helm init ### Options ``` - --canary-image use the canary tiller image - -c, --client-only if set does not install tiller - --dry-run do not install local or remote - -i, --tiller-image string override tiller image - --upgrade upgrade if tiller is already installed + --canary-image use the canary tiller image + -c, --client-only if set does not install tiller + --dry-run do not install local or remote + --skip-refresh do not refresh (download) the local repository cache + -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 @@ -53,4 +59,4 @@ helm init ### SEE ALSO * [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 diff --git a/docs/helm/helm_install.md b/docs/helm/helm_install.md index 2da6c576a..7ae886aa8 100644 --- a/docs/helm/helm_install.md +++ b/docs/helm/helm_install.md @@ -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 --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) + --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 []) --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, 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 @@ -96,4 +101,4 @@ helm install [CHART] ### SEE ALSO * [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 diff --git a/docs/helm/helm_list.md b/docs/helm/helm_list.md index f1427b81a..622c0700a 100644 --- a/docs/helm/helm_list.md +++ b/docs/helm/helm_list.md @@ -39,17 +39,22 @@ helm list [flags] [FILTER] ### Options ``` - --all show all releases, not just the ones marked DEPLOYED - -d, --date sort by release date - --deleted show deleted releases - --deleting show releases that are currently being deleted - --deployed show deployed releases. If no other is specified, this will be automatically enabled - --failed show failed releases - -m, --max int maximum number of releases to fetch (default 256) - --namespace string show releases within a specific namespace - -o, --offset string next release name in the list, used to offset from start value - -r, --reverse reverse the sort order - -q, --short output short (quiet) listing format + --all show all releases, not just the ones marked DEPLOYED + -d, --date sort by release date + --deleted show deleted releases + --deleting show releases that are currently being deleted + --deployed show deployed releases. If no other is specified, this will be automatically enabled + --failed show failed releases + -m, --max int maximum number of releases to fetch (default 256) + --namespace string show releases within a specific namespace + -o, --offset string next release name in the list, used to offset from start value + -r, --reverse reverse the sort order + -q, --short output short (quiet) listing format + --tls enable TLS for request + --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") + --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") + --tls-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 @@ -65,4 +70,4 @@ helm list [flags] [FILTER] ### SEE ALSO * [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 diff --git a/docs/helm/helm_package.md b/docs/helm/helm_package.md index 1a83b136e..9b524c6d5 100644 --- a/docs/helm/helm_package.md +++ b/docs/helm/helm_package.md @@ -23,11 +23,12 @@ helm package [flags] [CHART_PATH] [...] ### Options ``` - --key string name of the key to use when signing. Used if --sign is true - --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") - --save save packaged chart to local chart repository (default true) - --sign use a PGP private key to sign this package - --version string set the version on the chart to this semver version + -d, --destination string location to write the chart. (default ".") + --key string name of the key to use when signing. Used if --sign is true + --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") + --save save packaged chart to local chart repository (default true) + --sign use a PGP private key to sign this package + --version string set the version on the chart to this semver version ``` ### Options inherited from parent commands @@ -43,4 +44,4 @@ helm package [flags] [CHART_PATH] [...] ### SEE ALSO * [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 diff --git a/docs/helm/helm_plugin.md b/docs/helm/helm_plugin.md new file mode 100644 index 000000000..d224a9f7e --- /dev/null +++ b/docs/helm/helm_plugin.md @@ -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 diff --git a/docs/helm/helm_plugin_install.md b/docs/helm/helm_plugin_install.md new file mode 100644 index 000000000..c81f1f8e5 --- /dev/null +++ b/docs/helm/helm_plugin_install.md @@ -0,0 +1,33 @@ +## helm plugin install + +install one or more Helm plugins + +### Synopsis + + +install one or more Helm plugins + +``` +helm plugin install [options] ... +``` + +### 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 diff --git a/docs/helm/helm_plugin_list.md b/docs/helm/helm_plugin_list.md new file mode 100644 index 000000000..4cb022870 --- /dev/null +++ b/docs/helm/helm_plugin_list.md @@ -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 diff --git a/docs/helm/helm_plugin_remove.md b/docs/helm/helm_plugin_remove.md new file mode 100644 index 000000000..ea21f1762 --- /dev/null +++ b/docs/helm/helm_plugin_remove.md @@ -0,0 +1,27 @@ +## helm plugin remove + +remove one or more Helm plugins + +### Synopsis + + +remove one or more Helm plugins + +``` +helm plugin remove ... +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use + --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 diff --git a/docs/helm/helm_reset.md b/docs/helm/helm_reset.md index b817ef79f..73bfc74e8 100644 --- a/docs/helm/helm_reset.md +++ b/docs/helm/helm_reset.md @@ -18,8 +18,13 @@ helm reset ### Options ``` - -f, --force forces Tiller uninstall even if there are releases installed - --remove-helm-home if set deletes $HELM_HOME + -f, --force forces Tiller uninstall even if there are releases installed + --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 @@ -35,4 +40,4 @@ helm reset ### SEE ALSO * [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 diff --git a/docs/helm/helm_rollback.md b/docs/helm/helm_rollback.md index 95e1ac19d..425936a58 100644 --- a/docs/helm/helm_rollback.md +++ b/docs/helm/helm_rollback.md @@ -20,11 +20,16 @@ helm rollback [flags] [RELEASE] [REVISION] ### Options ``` - --dry-run simulate a 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) - --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 + --dry-run simulate a rollback + --no-hooks prevent hooks from running during rollback + --recreate-pods performs pods restart for the resource if applicable + --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) + --tls enable TLS for request + --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") + --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") + --tls-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 @@ -40,4 +45,4 @@ helm rollback [flags] [RELEASE] [REVISION] ### SEE ALSO * [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 diff --git a/docs/helm/helm_status.md b/docs/helm/helm_status.md index 6402a49fe..282ddaf63 100644 --- a/docs/helm/helm_status.md +++ b/docs/helm/helm_status.md @@ -23,7 +23,12 @@ helm status [flags] RELEASE_NAME ### 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 @@ -39,4 +44,4 @@ helm status [flags] RELEASE_NAME ### SEE ALSO * [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 diff --git a/docs/helm/helm_upgrade.md b/docs/helm/helm_upgrade.md index b1a611558..b49a035cf 100644 --- a/docs/helm/helm_upgrade.md +++ b/docs/helm/helm_upgrade.md @@ -36,19 +36,25 @@ helm upgrade [RELEASE] [CHART] ### Options ``` - --dry-run simulate an upgrade - -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") - --namespace string namespace to install the release into (only used if --install is set) (default "default") - --no-hooks disable pre/post upgrade hooks - --recreate-pods performs pods restart for the resource if applicable - --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) - --timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300) - -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, and Services are in a ready state before marking the release as successful. It will wait for as long as --timeout + --dry-run simulate an upgrade + -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") + --namespace string namespace to install the release into (only used if --install is set) (default "default") + --no-hooks disable pre/post upgrade hooks + --recreate-pods performs pods restart for the resource if applicable + --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 new values. 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) + --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 []) + --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 @@ -64,4 +70,4 @@ helm upgrade [RELEASE] [CHART] ### SEE ALSO * [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 diff --git a/docs/helm/helm_version.md b/docs/helm/helm_version.md index a6580fed7..ec536c54b 100644 --- a/docs/helm/helm_version.md +++ b/docs/helm/helm_version.md @@ -30,9 +30,14 @@ helm version ### Options ``` - -c, --client client version only - -s, --server server version only - --short print the version number + -c, --client client version only + -s, --server server version only + --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 @@ -48,4 +53,4 @@ helm version ### SEE ALSO * [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 diff --git a/docs/man/man1/helm.1 b/docs/man/man1/helm.1 index f2f1dc1ee..60e168fb6 100644 --- a/docs/man/man1/helm.1 +++ b/docs/man/man1/helm.1 @@ -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 .ad l @@ -77,9 +77,9 @@ Environment: .SH SEE ALSO .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 .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_delete.1 b/docs/man/man1/helm_delete.1 index e21742643..548e4885b 100644 --- a/docs/man/man1/helm_delete.1 +++ b/docs/man/man1/helm_delete.1 @@ -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 .ad l @@ -40,6 +40,26 @@ deleting them. \fB\-\-timeout\fP=300 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 .PP @@ -70,4 +90,4 @@ deleting them. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_dependency.1 b/docs/man/man1/helm_dependency.1 index 55398bb74..70da6f2b5 100644 --- a/docs/man/man1/helm_dependency.1 +++ b/docs/man/man1/helm_dependency.1 @@ -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 .ad l @@ -40,10 +40,10 @@ For example, this requirements file declares two dependencies: dependencies: \- name: nginx version: "1.2.3" -repository: "https://example.com/charts" + repository: "https://example.com/charts" \- name: memcached version: "3.2.1" -repository: "https://another.example.com/charts" + repository: "https://another.example.com/charts" .fi .RE @@ -114,4 +114,4 @@ for this case. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_get.1 b/docs/man/man1/helm_get.1 index 0746cde2e..bbc8515ca 100644 --- a/docs/man/man1/helm_get.1 +++ b/docs/man/man1/helm_get.1 @@ -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 .ad l @@ -36,6 +36,26 @@ chart, the supplied values, and the generated manifest file. \fB\-\-revision\fP=0 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 .PP @@ -66,4 +86,4 @@ chart, the supplied values, and the generated manifest file. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_history.1 b/docs/man/man1/helm_history.1 index 2ad7a753a..e4915c45a 100644 --- a/docs/man/man1/helm_history.1 +++ b/docs/man/man1/helm_history.1 @@ -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 .ad l @@ -44,6 +44,26 @@ REVISION UPDATED STATUS CHART DESCRIPTIO \fB\-\-max\fP=256 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 .PP @@ -74,4 +94,4 @@ REVISION UPDATED STATUS CHART DESCRIPTIO .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_init.1 b/docs/man/man1/helm_init.1 index db8d03c49..d22aa5623 100644 --- a/docs/man/man1/helm_init.1 +++ b/docs/man/man1/helm_init.1 @@ -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 .ad l @@ -52,10 +52,34 @@ To dump a manifest containing the Tiller deployment YAML, combine the \fB\-\-dry\-run\fP[=false] do not install local or remote +.PP +\fB\-\-skip\-refresh\fP[=false] + do not refresh (download) the local repository cache + .PP \fB\-i\fP, \fB\-\-tiller\-image\fP="" 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 \fB\-\-upgrade\fP[=false] upgrade if tiller is already installed @@ -90,4 +114,4 @@ To dump a manifest containing the Tiller deployment YAML, combine the .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_install.1 b/docs/man/man1/helm_install.1 index 7e094cbcf..d97ff0058 100644 --- a/docs/man/man1/helm_install.1 +++ b/docs/man/man1/helm_install.1 @@ -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 .ad l @@ -150,6 +150,26 @@ charts in a repository, use 'helm search'. \fB\-\-timeout\fP=300 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 \fB\-f\fP, \fB\-\-values\fP=[] specify values in a YAML file (can specify multiple) @@ -164,7 +184,7 @@ charts in a repository, use 'helm search'. .PP \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 @@ -196,4 +216,4 @@ charts in a repository, use 'helm search'. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_list.1 b/docs/man/man1/helm_list.1 index af33db626..8fbdf09c4 100644 --- a/docs/man/man1/helm_list.1 +++ b/docs/man/man1/helm_list.1 @@ -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 .ad l @@ -98,6 +98,26 @@ flag with the '\-\-offset' flag allows you to page through results. \fB\-q\fP, \fB\-\-short\fP[=false] 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 .PP @@ -128,4 +148,4 @@ flag with the '\-\-offset' flag allows you to page through results. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_package.1 b/docs/man/man1/helm_package.1 index 94f375dbc..205d52980 100644 --- a/docs/man/man1/helm_package.1 +++ b/docs/man/man1/helm_package.1 @@ -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 .ad l @@ -28,6 +28,10 @@ Versioned chart archives are used by Helm package repositories. .SH OPTIONS +.PP +\fB\-d\fP, \fB\-\-destination\fP="." + location to write the chart. + .PP \fB\-\-key\fP="" 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 .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_plugin.1 b/docs/man/man1/helm_plugin.1 new file mode 100644 index 000000000..2a126161e --- /dev/null +++ b/docs/man/man1/helm_plugin.1 @@ -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 diff --git a/docs/man/man1/helm_plugin_install.1 b/docs/man/man1/helm_plugin_install.1 new file mode 100644 index 000000000..ea987eb70 --- /dev/null +++ b/docs/man/man1/helm_plugin_install.1 @@ -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] \&...\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 diff --git a/docs/man/man1/helm_plugin_list.1 b/docs/man/man1/helm_plugin_list.1 new file mode 100644 index 000000000..d68023d81 --- /dev/null +++ b/docs/man/man1/helm_plugin_list.1 @@ -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 diff --git a/docs/man/man1/helm_plugin_remove.1 b/docs/man/man1/helm_plugin_remove.1 new file mode 100644 index 000000000..ed876d58b --- /dev/null +++ b/docs/man/man1/helm_plugin_remove.1 @@ -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 \&...\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 diff --git a/docs/man/man1/helm_reset.1 b/docs/man/man1/helm_reset.1 index 7420d3930..0284a068a 100644 --- a/docs/man/man1/helm_reset.1 +++ b/docs/man/man1/helm_reset.1 @@ -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 .ad l @@ -29,6 +29,26 @@ $HELM\_HOME (default \~/.helm/) \fB\-\-remove\-helm\-home\fP[=false] 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 .PP @@ -59,4 +79,4 @@ $HELM\_HOME (default \~/.helm/) .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_rollback.1 b/docs/man/man1/helm_rollback.1 index b5a9d8821..0346790b6 100644 --- a/docs/man/man1/helm_rollback.1 +++ b/docs/man/man1/helm_rollback.1 @@ -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 .ad l @@ -40,9 +40,29 @@ second is a revision (version) number. To see revision numbers, run \fB\-\-timeout\fP=300 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 \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 @@ -74,4 +94,4 @@ second is a revision (version) number. To see revision numbers, run .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_status.1 b/docs/man/man1/helm_status.1 index bec005997..9709917c7 100644 --- a/docs/man/man1/helm_status.1 +++ b/docs/man/man1/helm_status.1 @@ -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 .ad l @@ -30,6 +30,26 @@ The status consists of: \fB\-\-revision\fP=0 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 .PP @@ -60,4 +80,4 @@ The status consists of: .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_upgrade.1 b/docs/man/man1/helm_upgrade.1 index 6b6e35fd1..c458a84ef 100644 --- a/docs/man/man1/helm_upgrade.1 +++ b/docs/man/man1/helm_upgrade.1 @@ -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 .ad l @@ -85,6 +85,10 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis \fB\-\-reset\-values\fP[=false] 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 \fB\-\-set\fP=[] 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 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 \fB\-f\fP, \fB\-\-values\fP=[] specify values in a YAML file (can specify multiple) @@ -107,7 +131,7 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis .PP \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 @@ -139,4 +163,4 @@ $ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/docs/man/man1/helm_version.1 b/docs/man/man1/helm_version.1 index ee73941f0..5e3e9dd62 100644 --- a/docs/man/man1/helm_version.1 +++ b/docs/man/man1/helm_version.1 @@ -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 .ad l @@ -50,6 +50,26 @@ use '\-\-server'. \fB\-\-short\fP[=false] 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 .PP @@ -80,4 +100,4 @@ use '\-\-server'. .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra diff --git a/scripts/completions.bash b/scripts/completions.bash index 89080f9a1..7e95df555 100644 --- a/scripts/completions.bash +++ b/scripts/completions.bash @@ -289,6 +289,16 @@ _helm_delete() local_nonpersistent_flags+=("--purge") 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+=("--home=") flags+=("--host=") @@ -529,6 +539,16 @@ _helm_get() 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+=("--home=") flags+=("--host=") @@ -553,6 +573,16 @@ _helm_history() 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+=("--home=") flags+=("--host=") @@ -604,9 +634,21 @@ _helm_init() local_nonpersistent_flags+=("--client-only") flags+=("--dry-run") local_nonpersistent_flags+=("--dry-run") + flags+=("--skip-refresh") + local_nonpersistent_flags+=("--skip-refresh") flags+=("--tiller-image=") two_word_flags+=("-i") 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") local_nonpersistent_flags+=("--upgrade") flags+=("--debug") @@ -736,6 +778,16 @@ _helm_install() local_nonpersistent_flags+=("--set=") 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=") two_word_flags+=("-f") local_nonpersistent_flags+=("--values=") @@ -818,6 +870,16 @@ _helm_list() flags+=("--short") flags+=("-q") 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=") @@ -840,6 +902,9 @@ _helm_package() flags_with_completion=() flags_completion=() + flags+=("--destination=") + two_word_flags+=("-d") + local_nonpersistent_flags+=("--destination=") flags+=("--key=") local_nonpersistent_flags+=("--key=") flags+=("--keyring=") @@ -861,6 +926,99 @@ _helm_package() 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() { last_command="helm_repo_add" @@ -1037,6 +1195,43 @@ _helm_reset() 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() { last_command="helm_rollback" @@ -1056,6 +1251,16 @@ _helm_rollback() local_nonpersistent_flags+=("--recreate-pods") 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") local_nonpersistent_flags+=("--wait") flags+=("--debug") @@ -1137,6 +1342,52 @@ _helm_status() flags_completion=() 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+=("--home=") flags+=("--host=") @@ -1202,10 +1453,22 @@ _helm_upgrade() local_nonpersistent_flags+=("--recreate-pods") flags+=("--reset-values") local_nonpersistent_flags+=("--reset-values") + flags+=("--reuse-values") + local_nonpersistent_flags+=("--reuse-values") flags+=("--set=") local_nonpersistent_flags+=("--set=") 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=") two_word_flags+=("-f") local_nonpersistent_flags+=("--values=") @@ -1280,6 +1543,46 @@ _helm_version() 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() { last_command="helm" @@ -1298,16 +1601,20 @@ _helm() commands+=("lint") commands+=("list") commands+=("package") + commands+=("plugin") commands+=("repo") commands+=("reset") + commands+=("reset") commands+=("rollback") commands+=("search") commands+=("serve") commands+=("status") commands+=("test") + commands+=("test") commands+=("upgrade") commands+=("verify") commands+=("version") + commands+=("version") flags=() two_word_flags=()