From 0848d80e36a012f938d89500eefba01a40fbb6f1 Mon Sep 17 00:00:00 2001 From: Adam Reese Date: Wed, 1 Aug 2018 15:45:34 -0700 Subject: [PATCH] docs(generated): regenerate markdown docs --- docs/helm/helm.md | 5 +++-- docs/helm/helm_completion.md | 12 +++++++++--- docs/helm/helm_create.md | 7 ++++--- docs/helm/helm_delete.md | 5 +++-- docs/helm/helm_dependency.md | 10 ++++++++-- docs/helm/helm_dependency_build.md | 5 +++-- docs/helm/helm_dependency_list.md | 10 ++++++++-- docs/helm/helm_dependency_update.md | 5 +++-- docs/helm/helm_fetch.md | 5 +++-- docs/helm/helm_get.md | 5 +++-- docs/helm/helm_get_hooks.md | 5 +++-- docs/helm/helm_get_manifest.md | 5 +++-- docs/helm/helm_get_values.md | 5 +++-- docs/helm/helm_history.md | 5 +++-- docs/helm/helm_home.md | 12 +++++++++--- docs/helm/helm_init.md | 7 ++++--- docs/helm/helm_inspect.md | 7 ++++--- docs/helm/helm_inspect_chart.md | 7 ++++--- docs/helm/helm_inspect_readme.md | 7 ++++--- docs/helm/helm_inspect_values.md | 7 ++++--- docs/helm/helm_install.md | 7 ++++--- docs/helm/helm_lint.md | 5 +++-- docs/helm/helm_list.md | 5 +++-- docs/helm/helm_package.md | 5 +++-- docs/helm/helm_plugin.md | 10 ++++++++-- docs/helm/helm_plugin_install.md | 7 ++++--- docs/helm/helm_plugin_list.md | 12 +++++++++--- docs/helm/helm_plugin_remove.md | 12 +++++++++--- docs/helm/helm_plugin_update.md | 12 +++++++++--- docs/helm/helm_repo.md | 10 ++++++++-- docs/helm/helm_repo_add.md | 5 +++-- docs/helm/helm_repo_index.md | 5 +++-- docs/helm/helm_repo_list.md | 10 ++++++++-- docs/helm/helm_repo_remove.md | 10 ++++++++-- docs/helm/helm_repo_update.md | 12 +++++++++--- docs/helm/helm_reset.md | 7 ++++--- docs/helm/helm_rollback.md | 5 +++-- docs/helm/helm_search.md | 7 ++++--- docs/helm/helm_serve.md | 7 ++++--- docs/helm/helm_status.md | 5 +++-- docs/helm/helm_template.md | 5 +++-- docs/helm/helm_test.md | 7 ++++--- docs/helm/helm_upgrade.md | 7 ++++--- docs/helm/helm_verify.md | 5 +++-- docs/helm/helm_version.md | 7 ++++--- 45 files changed, 215 insertions(+), 110 deletions(-) diff --git a/docs/helm/helm.md b/docs/helm/helm.md index ae27de401..67ac9a4a2 100644 --- a/docs/helm/helm.md +++ b/docs/helm/helm.md @@ -4,7 +4,6 @@ The Helm package manager for Kubernetes. ### Synopsis - The Kubernetes package manager To begin working with Helm, run the 'helm init' command: @@ -33,6 +32,7 @@ Environment: ``` --debug enable verbose output + -h, --help help for helm --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 @@ -42,6 +42,7 @@ Environment: ``` ### SEE ALSO + * [helm completion](helm_completion.md) - Generate autocompletions script for the specified shell (bash or zsh) * [helm create](helm_create.md) - create a new chart with the given name * [helm delete](helm_delete.md) - given a release name, delete the release from Kubernetes @@ -69,4 +70,4 @@ Environment: * [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 -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_completion.md b/docs/helm/helm_completion.md index 64a6056f8..440393076 100644 --- a/docs/helm/helm_completion.md +++ b/docs/helm/helm_completion.md @@ -5,7 +5,6 @@ Generate autocompletions script for the specified shell (bash or zsh) ### Synopsis - Generate autocompletions script for Helm for the specified shell (bash or zsh). This command can generate shell autocompletions. e.g. @@ -18,7 +17,13 @@ Can be sourced as such ``` -helm completion SHELL +helm completion SHELL [flags] +``` + +### Options + +``` + -h, --help help for completion ``` ### Options inherited from parent commands @@ -34,6 +39,7 @@ helm completion SHELL ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_create.md b/docs/helm/helm_create.md index 7ae947ed7..0e20d9860 100644 --- a/docs/helm/helm_create.md +++ b/docs/helm/helm_create.md @@ -5,7 +5,6 @@ create a new chart with the given name ### Synopsis - This command creates a chart directory along with the common files and directories used in a chart. @@ -31,12 +30,13 @@ will be overwritten, but other files will be left alone. ``` -helm create NAME +helm create NAME [flags] ``` ### Options ``` + -h, --help help for create -p, --starter string the named Helm starter scaffold ``` @@ -53,6 +53,7 @@ helm create NAME ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_delete.md b/docs/helm/helm_delete.md index 442e5e96c..3c6a46844 100644 --- a/docs/helm/helm_delete.md +++ b/docs/helm/helm_delete.md @@ -5,7 +5,6 @@ given a release name, delete the release from Kubernetes ### Synopsis - This command takes a release name, and then deletes the release from Kubernetes. It removes all of the resources associated with the last release of the chart. @@ -22,6 +21,7 @@ helm delete [flags] RELEASE_NAME [...] ``` --description string specify a description for the release --dry-run simulate a delete + -h, --help help for 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) @@ -46,6 +46,7 @@ helm delete [flags] RELEASE_NAME [...] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_dependency.md b/docs/helm/helm_dependency.md index b0085c6c7..317860bdb 100644 --- a/docs/helm/helm_dependency.md +++ b/docs/helm/helm_dependency.md @@ -5,7 +5,6 @@ manage a chart's dependencies ### Synopsis - Manage the dependencies of a chart. Helm charts store their dependencies in 'charts/'. For chart developers, it is @@ -54,6 +53,12 @@ repository added to helm by "helm add repo". Version matching is also supported for this case. +### Options + +``` + -h, --help help for dependency +``` + ### Options inherited from parent commands ``` @@ -67,9 +72,10 @@ for this case. ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. * [helm dependency build](helm_dependency_build.md) - rebuild the charts/ directory based on the requirements.lock file * [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart * [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of requirements.yaml -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_dependency_build.md b/docs/helm/helm_dependency_build.md index eea2fa02c..fba70f2ec 100644 --- a/docs/helm/helm_dependency_build.md +++ b/docs/helm/helm_dependency_build.md @@ -5,7 +5,6 @@ rebuild the charts/ directory based on the requirements.lock file ### Synopsis - Build out the charts/ directory from the requirements.lock file. Build is used to reconstruct a chart's dependencies to the state specified in @@ -23,6 +22,7 @@ helm dependency build [flags] CHART ### Options ``` + -h, --help help for build --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --verify verify the packages against signatures ``` @@ -40,6 +40,7 @@ helm dependency build [flags] CHART ``` ### SEE ALSO + * [helm dependency](helm_dependency.md) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_dependency_list.md b/docs/helm/helm_dependency_list.md index d6bc0175a..da754c5d1 100644 --- a/docs/helm/helm_dependency_list.md +++ b/docs/helm/helm_dependency_list.md @@ -5,7 +5,6 @@ list the dependencies for the given chart ### Synopsis - List all of the dependencies declared in a chart. This can take chart archives and chart directories as input. It will not alter @@ -19,6 +18,12 @@ if it cannot find a requirements.yaml. helm dependency list [flags] CHART ``` +### Options + +``` + -h, --help help for list +``` + ### Options inherited from parent commands ``` @@ -32,6 +37,7 @@ helm dependency list [flags] CHART ``` ### SEE ALSO + * [helm dependency](helm_dependency.md) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_dependency_update.md b/docs/helm/helm_dependency_update.md index 90b81ecea..88bf3fafd 100644 --- a/docs/helm/helm_dependency_update.md +++ b/docs/helm/helm_dependency_update.md @@ -5,7 +5,6 @@ update charts/ based on the contents of requirements.yaml ### Synopsis - Update the on-disk dependencies to mirror the requirements.yaml file. This command verifies that the required charts, as expressed in 'requirements.yaml', @@ -27,6 +26,7 @@ helm dependency update [flags] CHART ### Options ``` + -h, --help help for update --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --skip-refresh do not refresh the local repository cache --verify verify the packages against signatures @@ -45,6 +45,7 @@ helm dependency update [flags] CHART ``` ### SEE ALSO + * [helm dependency](helm_dependency.md) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_fetch.md b/docs/helm/helm_fetch.md index c347d1620..81c0a9596 100644 --- a/docs/helm/helm_fetch.md +++ b/docs/helm/helm_fetch.md @@ -5,7 +5,6 @@ download a chart from a repository and (optionally) unpack it in local directory ### Synopsis - Retrieve a package from a package repository, and download it locally. This is useful for fetching packages to inspect, modify, or repackage. It can @@ -31,6 +30,7 @@ helm fetch [flags] [chart URL | repo/chartname] [...] --cert-file string identify HTTPS client using this SSL certificate file -d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".") --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. + -h, --help help for fetch --key-file string identify HTTPS client using this SSL key file --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --password string chart repository password @@ -56,6 +56,7 @@ helm fetch [flags] [chart URL | repo/chartname] [...] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_get.md b/docs/helm/helm_get.md index 3a1b3d442..e7337b533 100644 --- a/docs/helm/helm_get.md +++ b/docs/helm/helm_get.md @@ -5,7 +5,6 @@ download a named release ### Synopsis - This command shows the details of a named release. It can be used to get extended information about the release, including: @@ -25,6 +24,7 @@ helm get [flags] RELEASE_NAME ### Options ``` + -h, --help help for get --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") @@ -47,9 +47,10 @@ helm get [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. * [helm get hooks](helm_get_hooks.md) - download all hooks for a named release * [helm get manifest](helm_get_manifest.md) - download the manifest for a named release * [helm get values](helm_get_values.md) - download the values file for a named release -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_get_hooks.md b/docs/helm/helm_get_hooks.md index 9f3d5b0b2..d7097fd59 100644 --- a/docs/helm/helm_get_hooks.md +++ b/docs/helm/helm_get_hooks.md @@ -5,7 +5,6 @@ download all hooks for a named release ### Synopsis - This command downloads hooks for a given release. Hooks are formatted in YAML and separated by the YAML '---\n' separator. @@ -18,6 +17,7 @@ helm get hooks [flags] RELEASE_NAME ### Options ``` + -h, --help help for hooks --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") @@ -40,6 +40,7 @@ helm get hooks [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm get](helm_get.md) - download a named release -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_get_manifest.md b/docs/helm/helm_get_manifest.md index 6cae9001f..60bfeac0b 100644 --- a/docs/helm/helm_get_manifest.md +++ b/docs/helm/helm_get_manifest.md @@ -5,7 +5,6 @@ download the manifest for a named release ### Synopsis - This command fetches the generated manifest for a given release. A manifest is a YAML-encoded representation of the Kubernetes resources that @@ -20,6 +19,7 @@ helm get manifest [flags] RELEASE_NAME ### Options ``` + -h, --help help for manifest --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") @@ -42,6 +42,7 @@ helm get manifest [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm get](helm_get.md) - download a named release -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_get_values.md b/docs/helm/helm_get_values.md index 01fee2cd2..7208d5885 100644 --- a/docs/helm/helm_get_values.md +++ b/docs/helm/helm_get_values.md @@ -5,7 +5,6 @@ download the values file for a named release ### Synopsis - This command downloads a values file for a given release. @@ -17,6 +16,7 @@ helm get values [flags] RELEASE_NAME ``` -a, --all dump all (computed) values + -h, --help help for values --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") @@ -39,6 +39,7 @@ helm get values [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm get](helm_get.md) - download a named release -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_history.md b/docs/helm/helm_history.md index e5028f9cb..7f0a68928 100755 --- a/docs/helm/helm_history.md +++ b/docs/helm/helm_history.md @@ -5,7 +5,6 @@ fetch release history ### Synopsis - History prints historical revisions for a given release. A default maximum of 256 revisions will be returned. Setting '--max' @@ -29,6 +28,7 @@ helm history [flags] RELEASE_NAME ``` --col-width uint specifies the max column width of output (default 60) + -h, --help help for history --max int32 maximum number of revision to include in history (default 256) -o, --output string prints the output in the specified format (json|table|yaml) (default "table") --tls enable TLS for request @@ -52,6 +52,7 @@ helm history [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_home.md b/docs/helm/helm_home.md index 9af12c91a..192302424 100644 --- a/docs/helm/helm_home.md +++ b/docs/helm/helm_home.md @@ -5,13 +5,18 @@ displays the location of HELM_HOME ### Synopsis - This command displays the location of HELM_HOME. This is where any helm configuration files live. ``` -helm home +helm home [flags] +``` + +### Options + +``` + -h, --help help for home ``` ### Options inherited from parent commands @@ -27,6 +32,7 @@ helm home ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_init.md b/docs/helm/helm_init.md index ec775520a..430cc3d0e 100644 --- a/docs/helm/helm_init.md +++ b/docs/helm/helm_init.md @@ -5,7 +5,6 @@ initialize Helm on both client and server ### Synopsis - This command installs Tiller (the Helm server-side component) onto your Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/). @@ -27,7 +26,7 @@ To dump a manifest containing the Tiller deployment YAML, combine the ``` -helm init +helm init [flags] ``` ### Options @@ -37,6 +36,7 @@ helm init -c, --client-only if set does not install Tiller --dry-run do not install local or remote --force-upgrade force upgrade of Tiller to the current helm version + -h, --help help for init --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit. --local-repo-url string URL for local repository (default "http://127.0.0.1:8879/charts") --net-host install Tiller with net=host @@ -70,6 +70,7 @@ helm init ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_inspect.md b/docs/helm/helm_inspect.md index 4bc904f63..86689eeaa 100644 --- a/docs/helm/helm_inspect.md +++ b/docs/helm/helm_inspect.md @@ -5,7 +5,6 @@ inspect a chart ### Synopsis - This command inspects a chart and displays information. It takes a chart reference ('stable/drupal'), a full path to a directory or packaged chart, or a URL. @@ -13,7 +12,7 @@ Inspect prints the contents of the Chart.yaml file and the values.yaml file. ``` -helm inspect [CHART] +helm inspect [CHART] [flags] ``` ### Options @@ -21,6 +20,7 @@ helm inspect [CHART] ``` --ca-file string chart repository url where to locate the requested chart --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle + -h, --help help for inspect --key-file string identify HTTPS client using this SSL key file --keyring string path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg") --password string chart repository password where to locate the requested chart @@ -43,9 +43,10 @@ helm inspect [CHART] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. * [helm inspect chart](helm_inspect_chart.md) - shows inspect chart * [helm inspect readme](helm_inspect_readme.md) - shows inspect readme * [helm inspect values](helm_inspect_values.md) - shows inspect values -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_inspect_chart.md b/docs/helm/helm_inspect_chart.md index 257f26051..2b9adbb7e 100644 --- a/docs/helm/helm_inspect_chart.md +++ b/docs/helm/helm_inspect_chart.md @@ -5,13 +5,12 @@ shows inspect chart ### Synopsis - This command inspects a chart (directory, file, or URL) and displays the contents of the Charts.yaml file ``` -helm inspect chart [CHART] +helm inspect chart [CHART] [flags] ``` ### Options @@ -19,6 +18,7 @@ helm inspect chart [CHART] ``` --ca-file string chart repository url where to locate the requested chart --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle + -h, --help help for chart --key-file string identify HTTPS client using this SSL key file --keyring string path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg") --password string chart repository password where to locate the requested chart @@ -41,6 +41,7 @@ helm inspect chart [CHART] ``` ### SEE ALSO + * [helm inspect](helm_inspect.md) - inspect a chart -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_inspect_readme.md b/docs/helm/helm_inspect_readme.md index 8ff7d892e..d222cd53a 100644 --- a/docs/helm/helm_inspect_readme.md +++ b/docs/helm/helm_inspect_readme.md @@ -5,13 +5,12 @@ shows inspect readme ### Synopsis - This command inspects a chart (directory, file, or URL) and displays the contents of the README file ``` -helm inspect readme [CHART] +helm inspect readme [CHART] [flags] ``` ### Options @@ -19,6 +18,7 @@ helm inspect readme [CHART] ``` --ca-file string chart repository url where to locate the requested chart --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle + -h, --help help for readme --key-file string identify HTTPS client using this SSL key file --keyring string path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg") --repo string chart repository url where to locate the requested chart @@ -39,6 +39,7 @@ helm inspect readme [CHART] ``` ### SEE ALSO + * [helm inspect](helm_inspect.md) - inspect a chart -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_inspect_values.md b/docs/helm/helm_inspect_values.md index 50ff6ac24..9cca2fc32 100644 --- a/docs/helm/helm_inspect_values.md +++ b/docs/helm/helm_inspect_values.md @@ -5,13 +5,12 @@ shows inspect values ### Synopsis - This command inspects a chart (directory, file, or URL) and displays the contents of the values.yaml file ``` -helm inspect values [CHART] +helm inspect values [CHART] [flags] ``` ### Options @@ -19,6 +18,7 @@ helm inspect values [CHART] ``` --ca-file string chart repository url where to locate the requested chart --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle + -h, --help help for values --key-file string identify HTTPS client using this SSL key file --keyring string path to the keyring containing public verification keys (default "~/.gnupg/pubring.gpg") --password string chart repository password where to locate the requested chart @@ -41,6 +41,7 @@ helm inspect values [CHART] ``` ### SEE ALSO + * [helm inspect](helm_inspect.md) - inspect a chart -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_install.md b/docs/helm/helm_install.md index 6e0948e8f..05cdf1e4a 100644 --- a/docs/helm/helm_install.md +++ b/docs/helm/helm_install.md @@ -5,7 +5,6 @@ install a chart archive ### Synopsis - This command installs a chart archive. The install argument must be a chart reference, a path to a packaged chart, @@ -73,7 +72,7 @@ charts in a repository, use 'helm search'. ``` -helm install [CHART] +helm install [CHART] [flags] ``` ### Options @@ -85,6 +84,7 @@ helm install [CHART] --description string specify a description for the release --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. --dry-run simulate an install + -h, --help help for install --key-file string identify HTTPS client using this SSL key file --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") -n, --name string release name. If unspecified, it will autogenerate one for you @@ -125,6 +125,7 @@ helm install [CHART] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_lint.md b/docs/helm/helm_lint.md index 9c328a086..bf168184e 100644 --- a/docs/helm/helm_lint.md +++ b/docs/helm/helm_lint.md @@ -5,7 +5,6 @@ examines a chart for possible issues ### Synopsis - This command takes a path to a chart and runs a series of tests to verify that the chart is well-formed. @@ -21,6 +20,7 @@ helm lint [flags] PATH ### Options ``` + -h, --help help for lint --namespace string namespace to put the release into (default "default") --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) @@ -42,6 +42,7 @@ helm lint [flags] PATH ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 25-Jul-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_list.md b/docs/helm/helm_list.md index 17b2573b8..bf740239d 100755 --- a/docs/helm/helm_list.md +++ b/docs/helm/helm_list.md @@ -5,7 +5,6 @@ list releases ### Synopsis - This command lists all of the releases. By default, it lists only releases that are deployed or failed. Flags like @@ -46,6 +45,7 @@ helm list [flags] [FILTER] --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 + -h, --help help for list -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 @@ -74,6 +74,7 @@ helm list [flags] [FILTER] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_package.md b/docs/helm/helm_package.md index 30d06fcf0..b772fa70c 100644 --- a/docs/helm/helm_package.md +++ b/docs/helm/helm_package.md @@ -5,7 +5,6 @@ package a chart directory into a chart archive ### Synopsis - This command packages a chart into a versioned chart archive file. If a path is given, this will look at that path for a chart (which must contain a Chart.yaml file) and then package that directory. @@ -26,6 +25,7 @@ helm package [flags] [CHART_PATH] [...] --app-version string set the appVersion on the chart to this version -u, --dependency-update update dependencies from "requirements.yaml" to dir "charts/" before packaging -d, --destination string location to write the chart. (default ".") + -h, --help help for package --key string name of the key to use when signing. Used if --sign is true --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") --save save packaged chart to local chart repository (default true) @@ -46,6 +46,7 @@ helm package [flags] [CHART_PATH] [...] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_plugin.md b/docs/helm/helm_plugin.md index bb0498d87..5aa57b69c 100644 --- a/docs/helm/helm_plugin.md +++ b/docs/helm/helm_plugin.md @@ -5,10 +5,15 @@ add, list, or remove Helm plugins ### Synopsis - Manage client-side Helm plugins. +### Options + +``` + -h, --help help for plugin +``` + ### Options inherited from parent commands ``` @@ -22,10 +27,11 @@ Manage client-side Helm plugins. ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. * [helm plugin install](helm_plugin_install.md) - install one or more Helm plugins * [helm plugin list](helm_plugin_list.md) - list installed Helm plugins * [helm plugin remove](helm_plugin_remove.md) - remove one or more Helm plugins * [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_plugin_install.md b/docs/helm/helm_plugin_install.md index ab45850bf..f30bfff55 100644 --- a/docs/helm/helm_plugin_install.md +++ b/docs/helm/helm_plugin_install.md @@ -5,7 +5,6 @@ install one or more Helm plugins ### Synopsis - This command allows you to install a plugin from a url to a VCS repo or a local path. Example usage: @@ -13,12 +12,13 @@ Example usage: ``` -helm plugin install [options] ... +helm plugin install [options] ... [flags] ``` ### Options ``` + -h, --help help for install --version string specify a version constraint. If this is not specified, the latest version is installed ``` @@ -35,6 +35,7 @@ helm plugin install [options] ... ``` ### SEE ALSO + * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_plugin_list.md b/docs/helm/helm_plugin_list.md index dc13cdf7a..373462e2b 100644 --- a/docs/helm/helm_plugin_list.md +++ b/docs/helm/helm_plugin_list.md @@ -4,11 +4,16 @@ list installed Helm plugins ### Synopsis - list installed Helm plugins ``` -helm plugin list +helm plugin list [flags] +``` + +### Options + +``` + -h, --help help for list ``` ### Options inherited from parent commands @@ -24,6 +29,7 @@ helm plugin list ``` ### SEE ALSO + * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_plugin_remove.md b/docs/helm/helm_plugin_remove.md index 2ef833217..30f222c9f 100644 --- a/docs/helm/helm_plugin_remove.md +++ b/docs/helm/helm_plugin_remove.md @@ -4,11 +4,16 @@ remove one or more Helm plugins ### Synopsis - remove one or more Helm plugins ``` -helm plugin remove ... +helm plugin remove ... [flags] +``` + +### Options + +``` + -h, --help help for remove ``` ### Options inherited from parent commands @@ -24,6 +29,7 @@ helm plugin remove ... ``` ### SEE ALSO + * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_plugin_update.md b/docs/helm/helm_plugin_update.md index 93bc3e764..65b16cd9d 100644 --- a/docs/helm/helm_plugin_update.md +++ b/docs/helm/helm_plugin_update.md @@ -4,11 +4,16 @@ update one or more Helm plugins ### Synopsis - update one or more Helm plugins ``` -helm plugin update ... +helm plugin update ... [flags] +``` + +### Options + +``` + -h, --help help for update ``` ### Options inherited from parent commands @@ -24,6 +29,7 @@ helm plugin update ... ``` ### SEE ALSO + * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo.md b/docs/helm/helm_repo.md index 32e9d02b2..0b73fbcd0 100644 --- a/docs/helm/helm_repo.md +++ b/docs/helm/helm_repo.md @@ -5,7 +5,6 @@ add, list, remove, update, and index chart repositories ### Synopsis - This command consists of multiple subcommands to interact with chart repositories. It can be used to add, remove, list, and index chart repositories. @@ -13,6 +12,12 @@ Example usage: $ helm repo add [NAME] [REPO_URL] +### Options + +``` + -h, --help help for repo +``` + ### Options inherited from parent commands ``` @@ -26,6 +31,7 @@ Example usage: ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. * [helm repo add](helm_repo_add.md) - add a chart repository * [helm repo index](helm_repo_index.md) - generate an index file given a directory containing packaged charts @@ -33,4 +39,4 @@ Example usage: * [helm repo remove](helm_repo_remove.md) - remove a chart repository * [helm repo update](helm_repo_update.md) - update information of available charts locally from chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo_add.md b/docs/helm/helm_repo_add.md index 1deb0cb5c..29947147d 100644 --- a/docs/helm/helm_repo_add.md +++ b/docs/helm/helm_repo_add.md @@ -4,7 +4,6 @@ add a chart repository ### Synopsis - add a chart repository ``` @@ -16,6 +15,7 @@ helm repo add [flags] [NAME] [URL] ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for add --key-file string identify HTTPS client using this SSL key file --no-update raise error if repo is already registered --password string chart repository password @@ -35,6 +35,7 @@ helm repo add [flags] [NAME] [URL] ``` ### SEE ALSO + * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo_index.md b/docs/helm/helm_repo_index.md index baa1291de..4660489f9 100644 --- a/docs/helm/helm_repo_index.md +++ b/docs/helm/helm_repo_index.md @@ -5,7 +5,6 @@ generate an index file given a directory containing packaged charts ### Synopsis - Read the current directory and generate an index file based on the charts found. This tool is used for creating an 'index.yaml' file for a chart repository. To @@ -23,6 +22,7 @@ helm repo index [flags] [DIR] ### Options ``` + -h, --help help for index --merge string merge the generated index into the given index --url string url of chart repository ``` @@ -40,6 +40,7 @@ helm repo index [flags] [DIR] ``` ### SEE ALSO + * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo_list.md b/docs/helm/helm_repo_list.md index 00221ed24..bebaa6333 100644 --- a/docs/helm/helm_repo_list.md +++ b/docs/helm/helm_repo_list.md @@ -4,13 +4,18 @@ list chart repositories ### Synopsis - list chart repositories ``` helm repo list [flags] ``` +### Options + +``` + -h, --help help for list +``` + ### Options inherited from parent commands ``` @@ -24,6 +29,7 @@ helm repo list [flags] ``` ### SEE ALSO + * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo_remove.md b/docs/helm/helm_repo_remove.md index 272ecea47..89f43a130 100644 --- a/docs/helm/helm_repo_remove.md +++ b/docs/helm/helm_repo_remove.md @@ -4,13 +4,18 @@ remove a chart repository ### Synopsis - remove a chart repository ``` helm repo remove [flags] [NAME] ``` +### Options + +``` + -h, --help help for remove +``` + ### Options inherited from parent commands ``` @@ -24,6 +29,7 @@ helm repo remove [flags] [NAME] ``` ### SEE ALSO + * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_repo_update.md b/docs/helm/helm_repo_update.md index f0215da48..0d14f63ed 100644 --- a/docs/helm/helm_repo_update.md +++ b/docs/helm/helm_repo_update.md @@ -5,7 +5,6 @@ update information of available charts locally from chart repositories ### Synopsis - Update gets the latest information about charts from the respective chart repositories. Information is cached locally, where it is used by commands like 'helm search'. @@ -14,7 +13,13 @@ future releases. ``` -helm repo update +helm repo update [flags] +``` + +### Options + +``` + -h, --help help for update ``` ### Options inherited from parent commands @@ -30,6 +35,7 @@ helm repo update ``` ### SEE ALSO + * [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_reset.md b/docs/helm/helm_reset.md index 74d5ecc0e..772ac42c3 100644 --- a/docs/helm/helm_reset.md +++ b/docs/helm/helm_reset.md @@ -5,20 +5,20 @@ uninstalls Tiller from a cluster ### Synopsis - This command uninstalls Tiller (the Helm server-side component) from your Kubernetes Cluster and optionally deletes local configuration in $HELM_HOME (default ~/.helm/) ``` -helm reset +helm reset [flags] ``` ### Options ``` -f, --force forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state. Releases are not deleted.) + -h, --help help for reset --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") @@ -41,6 +41,7 @@ helm reset ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_rollback.md b/docs/helm/helm_rollback.md index 40d3ad83b..5862b180a 100644 --- a/docs/helm/helm_rollback.md +++ b/docs/helm/helm_rollback.md @@ -5,7 +5,6 @@ roll back a release to a previous revision ### Synopsis - This command rolls back a release to a previous revision. The first argument of the rollback command is the name of a release, and the @@ -23,6 +22,7 @@ helm rollback [flags] [RELEASE] [REVISION] --description string specify a description for the release --dry-run simulate a rollback --force force resource update through delete/recreate if needed + -h, --help help for rollback --no-hooks prevent hooks from running during rollback --recreate-pods performs pods restart for the resource if applicable --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) @@ -48,6 +48,7 @@ helm rollback [flags] [RELEASE] [REVISION] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_search.md b/docs/helm/helm_search.md index ffee22ce4..c45a397e3 100644 --- a/docs/helm/helm_search.md +++ b/docs/helm/helm_search.md @@ -5,7 +5,6 @@ search for a keyword in charts ### Synopsis - Search reads through all of the repositories configured on the system, and looks for matches. @@ -13,13 +12,14 @@ Repositories are managed with 'helm repo' commands. ``` -helm search [keyword] +helm search [keyword] [flags] ``` ### Options ``` --col-width uint specifies the max column width of output (default 60) + -h, --help help for search -r, --regexp use regular expressions for searching -v, --version string search using semantic versioning constraints -l, --versions show the long listing, with each version of each chart on its own line @@ -38,6 +38,7 @@ helm search [keyword] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_serve.md b/docs/helm/helm_serve.md index e300ee633..5e25f2a2f 100644 --- a/docs/helm/helm_serve.md +++ b/docs/helm/helm_serve.md @@ -5,7 +5,6 @@ start a local http web server ### Synopsis - This command starts a local chart repository server that serves charts from a local directory. The new server will provide HTTP access to a repository. By default, it will @@ -21,13 +20,14 @@ for more information on hosting chart repositories in a production setting. ``` -helm serve +helm serve [flags] ``` ### Options ``` --address string address to listen on (default "127.0.0.1:8879") + -h, --help help for serve --repo-path string local directory path from which to serve charts --url string external URL of chart repository ``` @@ -45,6 +45,7 @@ helm serve ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_status.md b/docs/helm/helm_status.md index 22b47c851..9dca005fd 100644 --- a/docs/helm/helm_status.md +++ b/docs/helm/helm_status.md @@ -5,7 +5,6 @@ displays the status of the named release ### Synopsis - This command shows the status of a named release. The status consists of: - last deployment time @@ -23,6 +22,7 @@ helm status [flags] RELEASE_NAME ### Options ``` + -h, --help help for status -o, --output string output the status in the specified format (json or yaml) --revision int32 if set, display the status of the named release with revision --tls enable TLS for request @@ -46,6 +46,7 @@ helm status [flags] RELEASE_NAME ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_template.md b/docs/helm/helm_template.md index f456f74be..d7770fb7f 100644 --- a/docs/helm/helm_template.md +++ b/docs/helm/helm_template.md @@ -5,7 +5,6 @@ locally render templates ### Synopsis - Render chart templates locally and display the output. This does not require Tiller. However, any values that would normally be @@ -26,6 +25,7 @@ helm template [flags] CHART ``` -x, --execute stringArray only execute the given templates + -h, --help help for template --is-upgrade set .Release.IsUpgrade instead of .Release.IsInstall --kube-version string kubernetes version used as Capabilities.KubeVersion.Major/Minor (default "1.9") -n, --name string release name (default "RELEASE-NAME") @@ -52,6 +52,7 @@ helm template [flags] CHART ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jul-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_test.md b/docs/helm/helm_test.md index 5a84c3b18..e55c5df68 100644 --- a/docs/helm/helm_test.md +++ b/docs/helm/helm_test.md @@ -5,7 +5,6 @@ test a release ### Synopsis - The test command runs the tests for a release. The argument this command takes is the name of a deployed release. @@ -13,13 +12,14 @@ The tests to be run are defined in the chart that was installed. ``` -helm test [RELEASE] +helm test [RELEASE] [flags] ``` ### Options ``` --cleanup delete test pods upon completion + -h, --help help for test --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) --tls enable TLS for request --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") @@ -42,6 +42,7 @@ helm test [RELEASE] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_upgrade.md b/docs/helm/helm_upgrade.md index 679070233..522464c6b 100644 --- a/docs/helm/helm_upgrade.md +++ b/docs/helm/helm_upgrade.md @@ -5,7 +5,6 @@ upgrade a release ### Synopsis - This command upgrades a release to a new version of a chart. The upgrade arguments must be a release and chart. The chart @@ -33,7 +32,7 @@ set for a key called 'foo', the 'newbar' value would take precedence: ``` -helm upgrade [RELEASE] [CHART] +helm upgrade [RELEASE] [CHART] [flags] ``` ### Options @@ -45,6 +44,7 @@ helm upgrade [RELEASE] [CHART] --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. --dry-run simulate an upgrade --force force resource update through delete/recreate if needed + -h, --help help for upgrade -i, --install if a release by this name doesn't already exist, run an install --key-file string identify HTTPS client using this SSL key file --keyring string path to the keyring that contains public signing keys (default "~/.gnupg/pubring.gpg") @@ -85,6 +85,7 @@ helm upgrade [RELEASE] [CHART] ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018 diff --git a/docs/helm/helm_verify.md b/docs/helm/helm_verify.md index 866b3fbd8..30ed43679 100644 --- a/docs/helm/helm_verify.md +++ b/docs/helm/helm_verify.md @@ -5,7 +5,6 @@ verify that a chart at the given path has been signed and is valid ### Synopsis - Verify that the given chart has a valid provenance file. Provenance files provide crytographic verification that a chart has not been @@ -23,6 +22,7 @@ helm verify [flags] PATH ### Options ``` + -h, --help help for verify --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") ``` @@ -39,6 +39,7 @@ helm verify [flags] PATH ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 17-Jun-2018 +###### Auto generated by spf13/cobra on 1-Aug-2018 diff --git a/docs/helm/helm_version.md b/docs/helm/helm_version.md index 3db529120..33d33cf12 100644 --- a/docs/helm/helm_version.md +++ b/docs/helm/helm_version.md @@ -5,7 +5,6 @@ print the client/server version information ### Synopsis - Show the client and server versions for Helm and tiller. This will print a representation of the client and server versions of Helm and @@ -24,13 +23,14 @@ use '--server'. ``` -helm version +helm version [flags] ``` ### Options ``` -c, --client client version only + -h, --help help for version -s, --server server version only --short print the version number --template string template for version string format @@ -55,6 +55,7 @@ helm version ``` ### SEE ALSO + * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 7-Aug-2018 +###### Auto generated by spf13/cobra on 10-Aug-2018