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

Merge pull request #2458 from technosophos/ref/remove-man-pages

Browse Source 
ref(docs): remove unnecessary docs and clean up doc generator
pull/2496/head
Matt Butcher 7 years ago committed by GitHub
parent a0fcb00e16 3c97db803f
commit f250fce921
46 changed files with 12 additions and 5237 deletions
Show Stats Download Patch File Download Diff File

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

@ -1,85 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm \- The Helm package manager for Kubernetes.
.SH SYNOPSIS
.PP
\fBhelm\fP
.SH DESCRIPTION
.PP
The Kubernetes package manager
.PP
To begin working with Helm, run the 'helm init' command:
.PP
.RS
.nf
$ helm init
.fi
.RE
.PP
This will install Tiller to your running Kubernetes cluster.
It will also set up any necessary local configuration.
.PP
Common actions from this point include:
.IP \(bu 2
helm search: search for charts
.IP \(bu 2
helm fetch: download a chart to your local directory to view
.IP \(bu 2
helm install: upload the chart to Kubernetes
.IP \(bu 2
helm list: list releases of charts
.PP
Environment:
$HELM\_HOME set an alternative location for Helm files. By default, these are stored in \~/.helm
$HELM\_HOST set an alternative Tiller host. The format is host:port
$HELM\_NO\_PLUGINS disable plugins. Set HELM\_NO\_PLUGINS=1 to disable plugins.
$TILLER\_NAMESPACE set an alternative Tiller namespace (default "kube\-namespace")
$KUBECONFIG set an alternative Kubernetes configuration file (default "\~/.kube/config")
.SH OPTIONS
.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\-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\-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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

74
docs/man/man1/helm_completion.1
Unescape View File

@ -1,74 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-completion \- Generate autocompletions script for the specified shell (bash or zsh)
.SH SYNOPSIS
.PP
\fBhelm completion SHELL\fP
.SH DESCRIPTION
.PP
Generate autocompletions script for Helm for the specified shell (bash or zsh).
.PP
This command can generate shell autocompletions. e.g.
.PP
.RS
.nf
$ helm completion bash
.fi
.RE
.PP
Can be sourced as such
.PP
.RS
.nf
$ source <(helm completion bash)
.fi
.RE
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

86
docs/man/man1/helm_create.1
Unescape View File

@ -1,86 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-create \- create a new chart with the given name
.SH SYNOPSIS
.PP
\fBhelm create NAME\fP
.SH DESCRIPTION
.PP
This command creates a chart directory along with the common files and
directories used in a chart.
.PP
For example, 'helm create foo' will create a directory structure that looks
something like this:
.PP
.RS
.nf
foo/
|
|\- .helmignore # Contains patterns to ignore when packaging Helm charts.
|
|\- Chart.yaml # Information about your chart
|
|\- values.yaml # The default values for your templates
|
|\- charts/ # Charts that this chart depends on
|
|\- templates/ # The template files
.fi
.RE
.PP
\&'helm create' takes a path for an argument. If directories in the given path
do not exist, Helm will attempt to create them as it goes. If the given
destination exists and there are files in that directory, conflicting files
will be overwritten, but other files will be left alone.
.SH OPTIONS
.PP
\fB\-p\fP, \fB\-\-starter\fP=""
the named Helm starter scaffold
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,93 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-delete \- given a release name, delete the release from Kubernetes
.SH SYNOPSIS
.PP
\fBhelm delete [flags] RELEASE\_NAME [...]\fP
.SH DESCRIPTION
.PP
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.
.PP
Use the '\-\-dry\-run' flag to see which releases will be deleted without actually
deleting them.
.SH OPTIONS
.PP
\fB\-\-dry\-run\fP[=false]
simulate a delete
.PP
\fB\-\-no\-hooks\fP[=false]
prevent hooks from running during deletion
.PP
\fB\-\-purge\fP[=false]
remove the release from the store and make its name free for later use
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,117 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-dependency \- manage a chart's dependencies
.SH SYNOPSIS
.PP
\fBhelm dependency update|build|list\fP
.SH DESCRIPTION
.PP
Manage the dependencies of a chart.
.PP
Helm charts store their dependencies in 'charts/'. For chart developers, it is
often easier to manage a single dependency file ('requirements.yaml')
which declares all dependencies.
.PP
The dependency commands operate on that file, making it easy to synchronize
between the desired dependencies and the actual dependencies stored in the
'charts/' directory.
.PP
A 'requirements.yaml' file is a YAML file in which developers can declare chart
dependencies, along with the location of the chart and the desired version.
For example, this requirements file declares two dependencies:
.PP
.RS
.nf
# requirements.yaml
dependencies:
\- name: nginx
version: "1.2.3"
repository: "https://example.com/charts"
\- name: memcached
version: "3.2.1"
repository: "https://another.example.com/charts"
.fi
.RE
.PP
The 'name' should be the name of a chart, where that name must match the name
in that chart's 'Chart.yaml' file.
.PP
The 'version' field should contain a semantic version or version range.
.PP
The 'repository' URL should point to a Chart Repository. Helm expects that by
appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL.
.PP
Starting from 2.2.0, repository can be defined as the path to the directory of
the dependency charts stored locally. The path should start with a prefix of
"file://". For example,
.PP
.RS
.nf
# requirements.yaml
dependencies:
\- name: nginx
version: "1.2.3"
repository: "file://../dependency\_chart/nginx"
.fi
.RE
.PP
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.
.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\-dependency\-build(1)\fP, \fBhelm\-dependency\-list(1)\fP, \fBhelm\-dependency\-update(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

69
docs/man/man1/helm_dependency_build.1
Unescape View File

@ -1,69 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-dependency\-build \- rebuild the charts/ directory based on the requirements.lock file
.SH SYNOPSIS
.PP
\fBhelm dependency build [flags] CHART\fP
.SH DESCRIPTION
.PP
Build out the charts/ directory from the requirements.lock file.
.PP
Build is used to reconstruct a chart's dependencies to the state specified in
the lock file. This will not re\-negotiate dependencies, as 'helm dependency update'
does.
.PP
If no lock file is found, 'helm dependency build' will mirror the behavior
of 'helm dependency update'.
.SH OPTIONS
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
keyring containing public keys
.PP
\fB\-\-verify\fP[=false]
verify the packages against signatures
.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\-dependency(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

58
docs/man/man1/helm_dependency_list.1
Unescape View File

@ -1,58 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-dependency\-list \- list the dependencies for the given chart
.SH SYNOPSIS
.PP
\fBhelm dependency list [flags] CHART\fP
.SH DESCRIPTION
.PP
List all of the dependencies declared in a chart.
.PP
This can take chart archives and chart directories as input. It will not alter
the contents of a chart.
.PP
This will produce an error if the chart cannot be loaded. It will emit a warning
if it cannot find a requirements.yaml.
.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\-dependency(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

78
docs/man/man1/helm_dependency_update.1
Unescape View File

@ -1,78 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-dependency\-update \- update charts/ based on the contents of requirements.yaml
.SH SYNOPSIS
.PP
\fBhelm dependency update [flags] CHART\fP
.SH DESCRIPTION
.PP
Update the on\-disk dependencies to mirror the requirements.yaml file.
.PP
This command verifies that the required charts, as expressed in 'requirements.yaml',
are present in 'charts/' and are at an acceptable version. It will pull down
the latest charts that satisfy the dependencies, and clean up old dependencies.
.PP
On successful update, this will generate a lock file that can be used to
rebuild the requirements to an exact version.
.PP
Dependencies are not required to be represented in 'requirements.yaml'. For that
reason, an update command will not remove charts unless they are (a) present
in the requirements.yaml file, but (b) at the wrong version.
.SH OPTIONS
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
keyring containing public keys
.PP
\fB\-\-skip\-refresh\fP[=false]
do not refresh the local repository cache
.PP
\fB\-\-verify\fP[=false]
verify the packages against signatures
.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\-dependency(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

114
docs/man/man1/helm_fetch.1
Unescape View File

@ -1,114 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-fetch \- download a chart from a repository and (optionally) unpack it in local directory
.SH SYNOPSIS
.PP
\fBhelm fetch [flags] [chart URL | repo/chartname] [...]\fP
.SH DESCRIPTION
.PP
Retrieve a package from a package repository, and download it locally.
.PP
This is useful for fetching packages to inspect, modify, or repackage. It can
also be used to perform cryptographic verification of a chart without installing
the chart.
.PP
There are options for unpacking the chart after download. This will create a
directory for the chart and uncomparess into that directory.
.PP
If the \-\-verify flag is specified, the requested chart MUST have a provenance
file, and MUST pass the verification process. Failure in any part of this will
result in an error, and the chart will not be saved locally.
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-cert\-file\fP=""
identify HTTPS client using this SSL certificate file
.PP
\fB\-d\fP, \fB\-\-destination\fP="."
location to write the chart. If this and tardir are specified, tardir is appended to this
.PP
\fB\-\-devel\fP[=false]
use development versions, too. Equivalent to version '>0.0.0\-a'. If \-\-version is set, this is ignored.
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
keyring containing public keys
.PP
\fB\-\-prov\fP[=false]
fetch the provenance file, but don't perform verification
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-untar\fP[=false]
if set to true, will untar the chart after downloading it
.PP
\fB\-\-untardir\fP="."
if untar is specified, this flag specifies the name of the directory into which the chart is expanded
.PP
\fB\-\-verify\fP[=false]
verify the package against its signature
.PP
\fB\-\-version\fP=""
specific version of a chart. Without this, the latest version is fetched
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,89 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-get \- download a named release
.SH SYNOPSIS
.PP
\fBhelm get [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
This command shows the details of a named release.
.PP
It can be used to get extended information about the release, including:
.IP \(bu 2
The values used to generate the release
.IP \(bu 2
The chart used to generate the release
.IP \(bu 2
The generated manifest file
.PP
By default, this prints a human readable collection of information about the
chart, the supplied values, and the generated manifest file.
.SH OPTIONS
.PP
\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
\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\-get\-hooks(1)\fP, \fBhelm\-get\-manifest(1)\fP, \fBhelm\-get\-values(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

59
docs/man/man1/helm_get_hooks.1
Unescape View File

@ -1,59 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-get\-hooks \- download all hooks for a named release
.SH SYNOPSIS
.PP
\fBhelm get hooks [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
This command downloads hooks for a given release.
.PP
Hooks are formatted in YAML and separated by the YAML '\-\-\-\\n' separator.
.SH OPTIONS
.PP
\fB\-\-revision\fP=0
get the named release with revision
.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\-get(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

61
docs/man/man1/helm_get_manifest.1
Unescape View File

@ -1,61 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-get\-manifest \- download the manifest for a named release
.SH SYNOPSIS
.PP
\fBhelm get manifest [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
This command fetches the generated manifest for a given release.
.PP
A manifest is a YAML\-encoded representation of the Kubernetes resources that
were generated from this release's chart(s). If a chart is dependent on other
charts, those resources will also be included in the manifest.
.SH OPTIONS
.PP
\fB\-\-revision\fP=0
get the named release with revision
.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\-get(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

60
docs/man/man1/helm_get_values.1
Unescape View File

@ -1,60 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-get\-values \- download the values file for a named release
.SH SYNOPSIS
.PP
\fBhelm get values [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
This command downloads a values file for a given release.
.SH OPTIONS
.PP
\fB\-a\fP, \fB\-\-all\fP[=false]
dump all (computed) values
.PP
\fB\-\-revision\fP=0
get the named release with revision
.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\-get(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,97 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-history \- fetch release history
.SH SYNOPSIS
.PP
\fBhelm history [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
History prints historical revisions for a given release.
.PP
A default maximum of 256 revisions will be returned. Setting '\-\-max'
configures the maximum length of the revision list returned.
.PP
The historical release set is printed as a formatted table, e.g:
.PP
.RS
.nf
$ helm history angry\-bird \-\-max=4
REVISION UPDATED STATUS CHART DESCRIPTION
1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Initial install
2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Upgraded successfully
3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine\-0.1.0 Rolled back to 2
4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine\-0.1.0 Upgraded successfully
.fi
.RE
.SH OPTIONS
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

51
docs/man/man1/helm_home.1
Unescape View File

@ -1,51 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-home \- displays the location of HELM\_HOME
.SH SYNOPSIS
.PP
\fBhelm home\fP
.SH DESCRIPTION
.PP
This command displays the location of HELM\_HOME. This is where
any helm configuration files live.
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,135 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-init \- initialize Helm on both client and server
.SH SYNOPSIS
.PP
\fBhelm init\fP
.SH DESCRIPTION
.PP
This command installs Tiller (the helm server side component) onto your
Kubernetes Cluster and sets up local configuration in $HELM\_HOME (default \~/.helm/)
.PP
As with the rest of the Helm commands, 'helm init' discovers Kubernetes clusters
by reading $KUBECONFIG (default '\~/.kube/config') and using the default context.
.PP
To set up just a local environment, use '\-\-client\-only'. That will configure
$HELM\_HOME, but not attempt to connect to a remote cluster and install the Tiller
deployment.
.PP
When installing Tiller, 'helm init' will attempt to install the latest released
version. You can specify an alternative image with '\-\-tiller\-image'. For those
frequently working on the latest code, the flag '\-\-canary\-image' will install
the latest pre\-release version of Tiller (e.g. the HEAD commit in the GitHub
repository on the master branch).
.PP
To dump a manifest containing the Tiller deployment YAML, combine the
'\-\-dry\-run' and '\-\-debug' flags.
.SH OPTIONS
.PP
\fB\-\-canary\-image\fP[=false]
use the canary tiller image
.PP
\fB\-c\fP, \fB\-\-client\-only\fP[=false]
if set does not install tiller
.PP
\fB\-\-dry\-run\fP[=false]
do not install local or remote
.PP
\fB\-\-local\-repo\-url\fP="
\[la]http://127.0.0.1:8879/charts"\[ra]
URL for local repository
.PP
\fB\-\-net\-host\fP[=false]
install tiller with net=host
.PP
\fB\-\-service\-account\fP=""
name of service account
.PP
\fB\-\-skip\-refresh\fP[=false]
do not refresh (download) the local repository cache
.PP
\fB\-\-stable\-repo\-url\fP="
\[la]https://kubernetes-charts.storage.googleapis.com"\[ra]
URL for stable repository
.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
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

84
docs/man/man1/helm_inspect.1
Unescape View File

@ -1,84 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-inspect \- inspect a chart
.SH SYNOPSIS
.PP
\fBhelm inspect [CHART]\fP
.SH DESCRIPTION
.PP
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.
.PP
Inspect prints the contents of the Chart.yaml file and the values.yaml file.
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-cert\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
path to the keyring containing public verification keys
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-verify\fP[=false]
verify the provenance data for this chart
.PP
\fB\-\-version\fP=""
version of the chart. By default, the newest chart is shown
.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\-inspect\-chart(1)\fP, \fBhelm\-inspect\-values(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

81
docs/man/man1/helm_inspect_chart.1
Unescape View File

@ -1,81 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-inspect\-chart \- shows inspect chart
.SH SYNOPSIS
.PP
\fBhelm inspect chart [CHART]\fP
.SH DESCRIPTION
.PP
This command inspects a chart (directory, file, or URL) and displays the contents
of the Charts.yaml file
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-cert\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
path to the keyring containing public verification keys
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-verify\fP[=false]
verify the provenance data for this chart
.PP
\fB\-\-version\fP=""
version of the chart. By default, the newest chart is shown
.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\-inspect(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

81
docs/man/man1/helm_inspect_values.1
Unescape View File

@ -1,81 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-inspect\-values \- shows inspect values
.SH SYNOPSIS
.PP
\fBhelm inspect values [CHART]\fP
.SH DESCRIPTION
.PP
This command inspects a chart (directory, file, or URL) and displays the contents
of the values.yaml file
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-cert\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
path to the keyring containing public verification keys
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-verify\fP[=false]
verify the provenance data for this chart
.PP
\fB\-\-version\fP=""
version of the chart. By default, the newest chart is shown
.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\-inspect(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,239 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-install \- install a chart archive
.SH SYNOPSIS
.PP
\fBhelm install [CHART]\fP
.SH DESCRIPTION
.PP
This command installs a chart archive.
.PP
The install argument must be either a relative path to a chart directory or the
name of a chart in the current working directory.
.PP
To override values in a chart, use either the '\-\-values' flag and pass in a file
or use the '\-\-set' flag and pass configuration from the command line.
.PP
.RS
.nf
$ helm install \-f myvalues.yaml ./redis
.fi
.RE
.PP
or
.PP
.RS
.nf
$ helm install \-\-set name=prod ./redis
.fi
.RE
.PP
You can specify the '\-\-values'/'\-f' flag multiple times. The priority will be given to the
last (right\-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:
.PP
.RS
.nf
$ helm install \-f myvalues.yaml \-f override.yaml ./redis
.fi
.RE
.PP
You can specify the '\-\-set' flag multiple times. The priority will be given to the
last (right\-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:
.PP
.RS
.nf
$ helm install \-\-set foo=bar \-\-set foo=newbar ./redis
.fi
.RE
.PP
To check the generated manifests of a release without installing the chart,
the '\-\-debug' and '\-\-dry\-run' flags can be combined. This will still require a
round\-trip to the Tiller server.
.PP
If \-\-verify is set, the chart MUST have a provenance file, and the provenenace
fall MUST pass all verification steps.
.PP
There are four different ways you can express the chart you want to install:
.IP " 1." 5
By chart reference: helm install stable/mariadb
.IP " 2." 5
By path to a packaged chart: helm install ./nginx\-1.2.3.tgz
.IP " 3." 5
By path to an unpacked chart directory: helm install ./nginx
.IP " 4." 5
By absolute URL: helm install
\[la]https://example.com/charts/nginx-1.2.3.tgz\[ra]
.PP
CHART REFERENCES
.PP
A chart reference is a convenient way of reference a chart in a chart repository.
.PP
When you use a chart reference ('stable/mariadb'), Helm will look in the local
configuration for a chart repository named 'stable', and will then look for a
chart in that repository whose name is 'mariadb'. It will install the latest
version of that chart unless you also supply a version number with the
'\-\-version' flag.
.PP
To see the list of chart repositories, use 'helm repo list'. To search for
charts in a repository, use 'helm search'.
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-cert\-file\fP=""
identify HTTPS client using this SSL certificate file
.PP
\fB\-\-devel\fP[=false]
use development versions, too. Equivalent to version '>0.0.0\-a'. If \-\-version is set, this is ignored.
.PP
\fB\-\-dry\-run\fP[=false]
simulate an install
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
location of public keys used for verification
.PP
\fB\-n\fP, \fB\-\-name\fP=""
release name. If unspecified, it will autogenerate one for you
.PP
\fB\-\-name\-template\fP=""
specify template used to name the release
.PP
\fB\-\-namespace\fP=""
namespace to install the release into
.PP
\fB\-\-no\-hooks\fP[=false]
prevent hooks from running during install
.PP
\fB\-\-replace\fP[=false]
re\-use the given name, even if that name is already used. This is unsafe in production
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\fB\-\-set\fP=[]
set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
.PP
\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)
.PP
\fB\-\-verify\fP[=false]
verify the package before installing it
.PP
\fB\-\-version\fP=""
specify the exact chart version to install. If this is not specified, the latest version is installed
.PP
\fB\-\-wait\fP[=false]
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
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

62
docs/man/man1/helm_lint.1
Unescape View File

@ -1,62 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-lint \- examines a chart for possible issues
.SH SYNOPSIS
.PP
\fBhelm lint [flags] PATH\fP
.SH DESCRIPTION
.PP
This command takes a path to a chart and runs a series of tests to verify that
the chart is well\-formed.
.PP
If the linter encounters things that will cause the chart to fail installation,
it will emit [ERROR] messages. If it encounters issues that break with convention
or recommendation, it will emit [WARNING] messages.
.SH OPTIONS
.PP
\fB\-\-strict\fP[=false]
fail on lint warnings
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,151 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-list \- list releases
.SH SYNOPSIS
.PP
\fBhelm list [flags] [FILTER]\fP
.SH DESCRIPTION
.PP
This command lists all of the releases.
.PP
By default, it lists only releases that are deployed or failed. Flags like
'\-\-deleted' and '\-\-all' will alter this behavior. Such flags can be combined:
'\-\-deleted \-\-failed'.
.PP
By default, items are sorted alphabetically. Use the '\-d' flag to sort by
release date.
.PP
If an argument is provided, it will be treated as a filter. Filters are
regular expressions (Perl compatible) that are applied to the list of releases.
Only items that match the filter will be returned.
.PP
.RS
.nf
$ helm list 'ara[a\-z]+'
NAME UPDATED CHART
maudlin\-arachnid Mon May 9 16:07:08 2016 alpine\-0.1.0
.fi
.RE
.PP
If no results are found, 'helm list' will exit 0, but with no output (or in
the case of no '\-q' flag, only headers).
.PP
By default, up to 256 items may be returned. To limit this, use the '\-\-max' flag.
Setting '\-\-max' to 0 will not return all results. Rather, it will return the
server's default, which may be much higher than 256. Pairing the '\-\-max'
flag with the '\-\-offset' flag allows you to page through results.
.SH OPTIONS
.PP
\fB\-\-all\fP[=false]
show all releases, not just the ones marked DEPLOYED
.PP
\fB\-d\fP, \fB\-\-date\fP[=false]
sort by release date
.PP
\fB\-\-deleted\fP[=false]
show deleted releases
.PP
\fB\-\-deleting\fP[=false]
show releases that are currently being deleted
.PP
\fB\-\-deployed\fP[=false]
show deployed releases. If no other is specified, this will be automatically enabled
.PP
\fB\-\-failed\fP[=false]
show failed releases
.PP
\fB\-m\fP, \fB\-\-max\fP=256
maximum number of releases to fetch
.PP
\fB\-\-namespace\fP=""
show releases within a specific namespace
.PP
\fB\-o\fP, \fB\-\-offset\fP=""
next release name in the list, used to offset from start value
.PP
\fB\-r\fP, \fB\-\-reverse\fP[=false]
reverse the sort order
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,85 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-package \- package a chart directory into a chart archive
.SH SYNOPSIS
.PP
\fBhelm package [flags] [CHART\_PATH] [...]\fP
.SH DESCRIPTION
.PP
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.
.PP
If no path is given, this will look in the present working directory for a
Chart.yaml file, and (if found) build the current directory into a chart.
.PP
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
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
location of a public keyring
.PP
\fB\-\-save\fP[=true]
save packaged chart to local chart repository
.PP
\fB\-\-sign\fP[=false]
use a PGP private key to sign this package
.PP
\fB\-\-version\fP=""
set the version on the chart to this semver version
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,50 +0,0 @@
.TH "HELM" "1" "May 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, \fBhelm\-plugin\-update(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

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

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

@ -1,50 +0,0 @@
.TH "HELM" "1" "May 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
17\-May\-2017 Auto generated by spf13/cobra

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

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

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

@ -1,50 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-plugin\-update \- update one or more Helm plugins
.SH SYNOPSIS
.PP
\fBhelm plugin update <plugin>\&...\fP
.SH DESCRIPTION
.PP
update 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
17\-May\-2017 Auto generated by spf13/cobra

55
docs/man/man1/helm_repo.1
Unescape View File

@ -1,55 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo \- add, list, remove, update, and index chart repositories
.SH SYNOPSIS
.PP
\fBhelm repo [FLAGS] add|remove|list|index|update [ARGS]\fP
.SH DESCRIPTION
.PP
This command consists of multiple subcommands to interact with chart repositories.
.PP
It can be used to add, remove, list, and index chart repositories.
Example usage:
$ helm repo add [NAME] [REPO\_URL]
.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\-repo\-add(1)\fP, \fBhelm\-repo\-index(1)\fP, \fBhelm\-repo\-list(1)\fP, \fBhelm\-repo\-remove(1)\fP, \fBhelm\-repo\-update(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

68
docs/man/man1/helm_repo_add.1
Unescape View File

@ -1,68 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo\-add \- add a chart repository
.SH SYNOPSIS
.PP
\fBhelm repo add [flags] [NAME] [URL]\fP
.SH DESCRIPTION
.PP
add a chart repository
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-cert\-file\fP=""
identify HTTPS client using this SSL certificate file
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-no\-update\fP[=false]
raise error if repo is already registered
.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\-repo(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

69
docs/man/man1/helm_repo_index.1
Unescape View File

@ -1,69 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo\-index \- generate an index file given a directory containing packaged charts
.SH SYNOPSIS
.PP
\fBhelm repo index [flags] [DIR]\fP
.SH DESCRIPTION
.PP
Read the current directory and generate an index file based on the charts found.
.PP
This tool is used for creating an 'index.yaml' file for a chart repository. To
set an absolute URL to the charts, use '\-\-url' flag.
.PP
To merge the generated index with an existing index file, use the '\-\-merge'
flag. In this case, the charts found in the current directory will be merged
into the existing index, with local charts taking priority over existing charts.
.SH OPTIONS
.PP
\fB\-\-merge\fP=""
merge the generated index into the given index
.PP
\fB\-\-url\fP=""
url of chart repository
.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\-repo(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,50 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo\-list \- list chart repositories
.SH SYNOPSIS
.PP
\fBhelm repo list [flags]\fP
.SH DESCRIPTION
.PP
list chart repositories
.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\-repo(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,50 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo\-remove \- remove a chart repository
.SH SYNOPSIS
.PP
\fBhelm repo remove [flags] [NAME]\fP
.SH DESCRIPTION
.PP
remove a chart repository
.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\-repo(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

55
docs/man/man1/helm_repo_update.1
Unescape View File

@ -1,55 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-repo\-update \- update information on available charts in the chart repositories
.SH SYNOPSIS
.PP
\fBhelm repo update\fP
.SH DESCRIPTION
.PP
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'.
.PP
\&'helm update' is the deprecated form of 'helm repo update'. It will be removed in
future releases.
.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\-repo(1)\fP
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,82 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-reset \- uninstalls Tiller from a cluster
.SH SYNOPSIS
.PP
\fBhelm reset\fP
.SH DESCRIPTION
.PP
This command uninstalls Tiller (the helm server side component) from your
Kubernetes Cluster and optionally deletes local configuration in
$HELM\_HOME (default \~/.helm/)
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-force\fP[=false]
forces Tiller uninstall even if there are releases installed
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,97 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-rollback \- roll back a release to a previous revision
.SH SYNOPSIS
.PP
\fBhelm rollback [flags] [RELEASE] [REVISION]\fP
.SH DESCRIPTION
.PP
This command rolls back a release to a previous revision.
.PP
The first argument of the rollback command is the name of a release, and the
second is a revision (version) number. To see revision numbers, run
'helm history RELEASE'.
.SH OPTIONS
.PP
\fB\-\-dry\-run\fP[=false]
simulate a rollback
.PP
\fB\-\-no\-hooks\fP[=false]
prevent hooks from running during rollback
.PP
\fB\-\-recreate\-pods\fP[=false]
performs pods restart for the resource if applicable
.PP
\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, 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
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

68
docs/man/man1/helm_search.1
Unescape View File

@ -1,68 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-search \- search for a keyword in charts
.SH SYNOPSIS
.PP
\fBhelm search [keyword]\fP
.SH DESCRIPTION
.PP
Search reads through all of the repositories configured on the system, and
looks for matches.
.PP
Repositories are managed with 'helm repo' commands.
.SH OPTIONS
.PP
\fB\-r\fP, \fB\-\-regexp\fP[=false]
use regular expressions for searching
.PP
\fB\-v\fP, \fB\-\-version\fP=""
search using semantic versioning constraints
.PP
\fB\-l\fP, \fB\-\-versions\fP[=false]
show the long listing, with each version of each chart on its own line
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

79
docs/man/man1/helm_serve.1
Unescape View File

@ -1,79 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-serve \- start a local http web server
.SH SYNOPSIS
.PP
\fBhelm serve\fP
.SH DESCRIPTION
.PP
This command starts a local chart repository server that serves charts from a local directory.
.PP
The new server will provide HTTP access to a repository. By default, it will
scan all of the charts in '$HELM\_HOME/repository/local' and serve those over
the local IPv4 TCP port (default '127.0.0.1:8879').
.PP
This command is intended to be used for educational and testing purposes only.
It is best to rely on a dedicated web server or a cloud\-hosted solution like
Google Cloud Storage for production use.
.PP
See
\[la]https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories\[ra]
for more information on hosting chart repositories in a production setting.
.SH OPTIONS
.PP
\fB\-\-address\fP="127.0.0.1:8879"
address to listen on
.PP
\fB\-\-repo\-path\fP=""
local directory path from which to serve charts
.PP
\fB\-\-url\fP=""
external URL of chart repository
.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
.SH HISTORY
.PP
18\-May\-2017 Auto generated by spf13/cobra

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

@ -1,83 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-status \- displays the status of the named release
.SH SYNOPSIS
.PP
\fBhelm status [flags] RELEASE\_NAME\fP
.SH DESCRIPTION
.PP
This command shows the status of a named release.
The status consists of:
\- last deployment time
\- k8s namespace in which the release lives
\- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING)
\- list of resources that this release consists of, sorted by kind
\- details on last test suite run, if applicable
\- additional notes provided by the chart
.SH OPTIONS
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

84
docs/man/man1/helm_test.1
Unescape View File

@ -1,84 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-test \- test a release
.SH SYNOPSIS
.PP
\fBhelm test [RELEASE]\fP
.SH DESCRIPTION
.PP
The test command runs the tests for a release.
.PP
The argument this command takes is the name of a deployed release.
The tests to be run are defined in the chart that was installed.
.SH OPTIONS
.PP
\fB\-\-cleanup\fP[=false]
delete test pods upon completion
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,186 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-upgrade \- upgrade a release
.SH SYNOPSIS
.PP
\fBhelm upgrade [RELEASE] [CHART]\fP
.SH DESCRIPTION
.PP
This command upgrades a release to a new version of a chart.
.PP
The upgrade arguments must be a release and chart. The chart
argument can be either: a chart reference('stable/mariadb'), a path to a chart directory,
a packaged chart, or a fully qualified URL. For chart references, the latest
version will be specified unless the '\-\-version' flag is set.
.PP
To override values in a chart, use either the '\-\-values' flag and pass in a file
or use the '\-\-set' flag and pass configuration from the command line.
.PP
You can specify the '\-\-values'/'\-f' flag multiple times. The priority will be given to the
last (right\-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:
.PP
.RS
.nf
$ helm upgrade \-f myvalues.yaml \-f override.yaml redis ./redis
.fi
.RE
.PP
You can specify the '\-\-set' flag multiple times. The priority will be given to the
last (right\-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:
.PP
.RS
.nf
$ helm upgrade \-\-set foo=bar \-\-set foo=newbar redis ./redis
.fi
.RE
.SH OPTIONS
.PP
\fB\-\-ca\-file\fP=""
verify certificates of HTTPS\-enabled servers using this CA bundle
.PP
\fB\-\-cert\-file\fP=""
identify HTTPS client using this SSL certificate file
.PP
\fB\-\-devel\fP[=false]
use development versions, too. Equivalent to version '>0.0.0\-a'. If \-\-version is set, this is ignored.
.PP
\fB\-\-dry\-run\fP[=false]
simulate an upgrade
.PP
\fB\-i\fP, \fB\-\-install\fP[=false]
if a release by this name doesn't already exist, run an install
.PP
\fB\-\-key\-file\fP=""
identify HTTPS client using this SSL key file
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
path to the keyring that contains public signing keys
.PP
\fB\-\-namespace\fP="default"
namespace to install the release into (only used if \-\-install is set)
.PP
\fB\-\-no\-hooks\fP[=false]
disable pre/post upgrade hooks
.PP
\fB\-\-recreate\-pods\fP[=false]
performs pods restart for the resource if applicable
.PP
\fB\-\-repo\fP=""
chart repository url where to locate the requested chart
.PP
\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)
.PP
\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)
.PP
\fB\-\-verify\fP[=false]
verify the provenance of the chart before upgrading
.PP
\fB\-\-version\fP=""
specify the exact chart version to use. If this is not specified, the latest version is used
.PP
\fB\-\-wait\fP[=false]
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
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

65
docs/man/man1/helm_verify.1
Unescape View File

@ -1,65 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-verify \- verify that a chart at the given path has been signed and is valid
.SH SYNOPSIS
.PP
\fBhelm verify [flags] PATH\fP
.SH DESCRIPTION
.PP
Verify that the given chart has a valid provenance file.
.PP
Provenance files provide crytographic verification that a chart has not been
tampered with, and was packaged by a trusted provider.
.PP
This command can be used to verify a local chart. Several other commands provide
'\-\-verify' flags that run the same validation. To generate a signed package, use
the 'helm package \-\-sign' command.
.SH OPTIONS
.PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
keyring containing public keys
.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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

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

@ -1,103 +0,0 @@
.TH "HELM" "1" "May 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-version \- print the client/server version information
.SH SYNOPSIS
.PP
\fBhelm version\fP
.SH DESCRIPTION
.PP
Show the client and server versions for Helm and tiller.
.PP
This will print a representation of the client and server versions of Helm and
Tiller. The output will look something like this:
.PP
Client: \&version.Version{SemVer:"v2.0.0", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"clean"}
Server: \&version.Version{SemVer:"v2.0.0", GitCommit:"b0c113dfb9f612a9add796549da66c0d294508a3", GitTreeState:"clean"}
.IP \(bu 2
SemVer is the semantic version of the release.
.IP \(bu 2
GitCommit is the SHA for the commit that this version was built from.
.IP \(bu 2
GitTreeState is "clean" if there are no local code changes when this binary was
built, and "dirty" if the binary was built from locally modified code.
.PP
To print just the client version, use '\-\-client'. To print just the server version,
use '\-\-server'.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-client\fP[=false]
client version only
.PP
\fB\-s\fP, \fB\-\-server\fP[=false]
server version only
.PP
\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
\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
.SH HISTORY
.PP
17\-May\-2017 Auto generated by spf13/cobra

1671
scripts/completions.bash
View File

File diff suppressed because it is too large Load Diff

10
scripts/update-docs.sh
Unescape View File

@ -31,11 +31,13 @@ kube::util::ensure-temp-dir
export HELM_NO_PLUGINS=1
mkdir -p ${KUBE_TEMP}/docs/helm ${KUBE_TEMP}/docs/man/man1 ${KUBE_TEMP}/scripts
# Reset Helm Home because it is used in the generation of docs.
OLD_HELM_HOME=${HELM_HOME:-}
HELM_HOME="$HOME/.helm"
bin/helm init --client-only
mkdir -p ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/man/man1 --type man
bin/helm docs --dir ${KUBE_TEMP}/scripts --type bash
HELM_HOME=$OLD_HELM_HOME
FILES=$(find ${KUBE_TEMP} -type f)

9
scripts/verify-docs.sh
Unescape View File

@ -31,10 +31,13 @@ kube::util::ensure-temp-dir
export HELM_NO_PLUGINS=1
mkdir -p ${KUBE_TEMP}/docs/helm ${KUBE_TEMP}/docs/man/man1 ${KUBE_TEMP}/scripts
# Reset Helm Home because it is used in the generation of docs.
OLD_HELM_HOME=${HELM_HOME:-}
HELM_HOME="$HOME/.helm"
bin/helm init --client-only
mkdir -p ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/man/man1 --type man
bin/helm docs --dir ${KUBE_TEMP}/scripts --type bash
HELM_HOME=$OLD_HELM_HOME
FILES=$(find ${KUBE_TEMP} -type f)

Write Preview
Loading…
Cancel
Save