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

docs(generated): remove generated docs

Browse Source
pull/3945/head
Adam Reese 6 years ago
parent 358746fee6
commit 5048ed8f5c
No known key found for this signature in database
GPG Key ID: 06F35E60A7A18DD6
90 changed files with 4 additions and 5755 deletions
Show Stats Download Patch File Download Diff File

6
.circleci/test.sh
Unescape View File

@ -37,11 +37,6 @@ run_style_check() {
make test-style
}
run_docs_check() {
echo "Running 'make verify-docs'"
make verify-docs
}
# Build to ensure packages are compiled
echo "Running 'make build'"
make build
@ -49,5 +44,4 @@ make build
case "${CIRCLE_NODE_INDEX-0}" in
0) run_unit_test ;;
1) run_style_check ;;
2) run_docs_check ;;
esac

9
.gitignore vendored
Unescape View File

@ -1,12 +1,11 @@
*.exe
.DS_Store
.coverage/
.idea/
.vimrc
.vscode/
/docs/helm
/docs/man
_dist/
_proto/*.pb.go
bin/
rootfs/tiller
rootfs/rudder
vendor/
*.exe
.idea/

71
docs/helm/helm.md
Unescape View File

@ -1,71 +0,0 @@
## helm
The Helm package manager for Kubernetes.
### Synopsis
The Kubernetes package manager
To begin working with Helm, run the 'helm init' command:
$ helm init
This will install Tiller to your running Kubernetes cluster.
It will also set up any necessary local configuration.
Common actions from this point include:
- helm search: search for charts
- helm fetch: download a chart to your local directory to view
- helm install: upload the chart to Kubernetes
- helm list: list releases of charts
Environment:
$HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm
$HELM_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-system")
$KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config")
### Options
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### 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
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
* [helm fetch](helm_fetch.md) - download a chart from a repository and (optionally) unpack it in local directory
* [helm get](helm_get.md) - download a named release
* [helm history](helm_history.md) - fetch release history
* [helm home](helm_home.md) - displays the location of HELM_HOME
* [helm init](helm_init.md) - initialize Helm on both client and server
* [helm inspect](helm_inspect.md) - inspect a chart
* [helm install](helm_install.md) - install a chart archive
* [helm lint](helm_lint.md) - examines a chart for possible issues
* [helm list](helm_list.md) - list releases
* [helm package](helm_package.md) - package a chart directory into a chart archive
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm rollback](helm_rollback.md) - roll back a release to a previous revision
* [helm search](helm_search.md) - search for a keyword in charts
* [helm serve](helm_serve.md) - start a local http web server
* [helm status](helm_status.md) - displays the status of the named release
* [helm template](helm_template.md) - locally render templates
* [helm test](helm_test.md) - test a release
* [helm upgrade](helm_upgrade.md) - upgrade a release
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client/server version information
###### Auto generated by spf13/cobra on 14-Mar-2018

38
docs/helm/helm_completion.md
Unescape View File

@ -1,38 +0,0 @@
## helm completion
Generate autocompletions script for the specified shell (bash or zsh)
### Synopsis
Generate autocompletions script for Helm for the specified shell (bash or zsh).
This command can generate shell autocompletions. e.g.
$ helm completion bash
Can be sourced as such
$ source <(helm completion bash)
```
helm completion SHELL
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

57
docs/helm/helm_create.md
Unescape View File

@ -1,57 +0,0 @@
## helm create
create a new chart with the given name
### Synopsis
This command creates a chart directory along with the common files and
directories used in a chart.
For example, 'helm create foo' will create a directory structure that looks
something like this:
foo/
|
|- .helmignore # Contains patterns to ignore when packaging Helm charts.
|
|- Chart.yaml # Information about your chart
|
|- values.yaml # The default values for your templates
|
|- charts/ # Charts that this chart depends on
|
|- templates/ # The template files
'helm create' takes a path for an argument. If directories in the given path
do not exist, Helm will attempt to create them as it goes. If the given
destination exists and there are files in that directory, conflicting files
will be overwritten, but other files will be left alone.
```
helm create NAME
```
### Options
```
-p, --starter string the named Helm starter scaffold
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

48
docs/helm/helm_delete.md
Unescape View File

@ -1,48 +0,0 @@
## helm delete
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.
Use the '--dry-run' flag to see which releases will be deleted without actually
deleting them.
```
helm delete [flags] RELEASE_NAME [...]
```
### Options
```
--dry-run simulate a delete
--no-hooks prevent hooks from running during deletion
--purge remove the release from the store and make its name free for later use
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

74
docs/helm/helm_dependency.md
Unescape View File

@ -1,74 +0,0 @@
## helm dependency
manage a chart's dependencies
### Synopsis
Manage the dependencies of a chart.
Helm charts store their dependencies in 'charts/'. For chart developers, it is
often easier to manage a single dependency file ('requirements.yaml')
which declares all dependencies.
The dependency commands operate on that file, making it easy to synchronize
between the desired dependencies and the actual dependencies stored in the
'charts/' directory.
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:
# 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"
The 'name' should be the name of a chart, where that name must match the name
in that chart's 'Chart.yaml' file.
The 'version' field should contain a semantic version or version range.
The 'repository' URL should point to a Chart Repository. Helm expects that by
appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. Note: 'repository' can be an alias. The alias must start
with 'alias:' or '@'.
Starting from 2.2.0, repository can be defined as the path to the directory of
the dependency charts stored locally. The path should start with a prefix of
"file://". For example,
# requirements.yaml
dependencies:
- name: nginx
version: "1.2.3"
repository: "file://../dependency_chart/nginx"
If the dependency chart is retrieved locally, it is not required to have the
repository added to helm by "helm add repo". Version matching is also supported
for this case.
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### 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 8-Mar-2018

44
docs/helm/helm_dependency_build.md
Unescape View File

@ -1,44 +0,0 @@
## helm dependency build
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
the lock file. This will not re-negotiate dependencies, as 'helm dependency update'
does.
If no lock file is found, 'helm dependency build' will mirror the behavior
of 'helm dependency update'.
```
helm dependency build [flags] CHART
```
### Options
```
--keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg")
--verify verify the packages against signatures
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 8-Mar-2018

36
docs/helm/helm_dependency_list.md
Unescape View File

@ -1,36 +0,0 @@
## helm dependency list
list the dependencies for the given chart
### Synopsis
List all of the dependencies declared in a chart.
This can take chart archives and chart directories as input. It will not alter
the contents of a chart.
This will produce an error if the chart cannot be loaded. It will emit a warning
if it cannot find a requirements.yaml.
```
helm dependency list [flags] CHART
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 8-Mar-2018

49
docs/helm/helm_dependency_update.md
Unescape View File

@ -1,49 +0,0 @@
## helm dependency update
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',
are present in 'charts/' and are at an acceptable version. It will pull down
the latest charts that satisfy the dependencies, and clean up old dependencies.
On successful update, this will generate a lock file that can be used to
rebuild the requirements to an exact version.
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.
```
helm dependency update [flags] CHART
```
### Options
```
--keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg")
--skip-refresh do not refresh the local repository cache
--verify verify the packages against signatures
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 8-Mar-2018

58
docs/helm/helm_fetch.md
Unescape View File

@ -1,58 +0,0 @@
## helm fetch
download a chart from a repository and (optionally) unpack it in local directory
### Synopsis
Retrieve a package from a package repository, and download it locally.
This is useful for fetching packages to inspect, modify, or repackage. It can
also be used to perform cryptographic verification of a chart without installing
the chart.
There are options for unpacking the chart after download. This will create a
directory for the chart and uncompress into that directory.
If the --verify flag is specified, the requested chart MUST have a provenance
file, and MUST pass the verification process. Failure in any part of this will
result in an error, and the chart will not be saved locally.
```
helm fetch [flags] [chart URL | repo/chartname] [...]
```
### Options
```
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
-d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".")
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
--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
--prov fetch the provenance file, but don't perform verification
--repo string chart repository url where to locate the requested chart
--untar if set to true, will untar the chart after downloading it
--untardir string if untar is specified, this flag specifies the name of the directory into which the chart is expanded (default ".")
--username string chart repository username
--verify verify the package against its signature
--version string specific version of a chart. Without this, the latest version is fetched
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.

53
docs/helm/helm_get.md
Unescape View File

@ -1,53 +0,0 @@
## helm get
download a named release
### Synopsis
This command shows the details of a named release.
It can be used to get extended information about the release, including:
- The values used to generate the release
- The chart used to generate the release
- The generated manifest file
By default, this prints a human readable collection of information about the
chart, the supplied values, and the generated manifest file.
```
helm get [flags] RELEASE_NAME
```
### Options
```
--revision int32 get the named release with revision
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### 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 8-Mar-2018

43
docs/helm/helm_get_hooks.md
Unescape View File

@ -1,43 +0,0 @@
## helm get hooks
download all hooks for a named release
### Synopsis
This command downloads hooks for a given release.
Hooks are formatted in YAML and separated by the YAML '---\n' separator.
```
helm get hooks [flags] RELEASE_NAME
```
### Options
```
--revision int32 get the named release with revision
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 8-Mar-2018

45
docs/helm/helm_get_manifest.md
Unescape View File

@ -1,45 +0,0 @@
## helm get manifest
download the manifest for a named release
### Synopsis
This command fetches the generated manifest for a given release.
A manifest is a YAML-encoded representation of the Kubernetes resources that
were generated from this release's chart(s). If a chart is dependent on other
charts, those resources will also be included in the manifest.
```
helm get manifest [flags] RELEASE_NAME
```
### Options
```
--revision int32 get the named release with revision
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 8-Mar-2018

42
docs/helm/helm_get_values.md
Unescape View File

@ -1,42 +0,0 @@
## helm get values
download the values file for a named release
### Synopsis
This command downloads a values file for a given release.
```
helm get values [flags] RELEASE_NAME
```
### Options
```
-a, --all dump all (computed) 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")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 8-Mar-2018

55
docs/helm/helm_history.md
Unescape View File

@ -1,55 +0,0 @@
## helm history
fetch release history
### Synopsis
History prints historical revisions for a given release.
A default maximum of 256 revisions will be returned. Setting '--max'
configures the maximum length of the revision list returned.
The historical release set is printed as a formatted table, e.g:
$ helm history angry-bird --max=4
REVISION UPDATED STATUS CHART DESCRIPTION
1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Initial install
2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Upgraded successfully
3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Rolled back to 2
4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine-0.1.0 Upgraded successfully
```
helm history [flags] RELEASE_NAME
```
### Options
```
--col-width uint specifies the max column width of output (default 60)
--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
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 14-Mar-2018

31
docs/helm/helm_home.md
Unescape View File

@ -1,31 +0,0 @@
## helm home
displays the location of HELM_HOME
### Synopsis
This command displays the location of HELM_HOME. This is where
any helm configuration files live.
```
helm home
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

74
docs/helm/helm_init.md
Unescape View File

@ -1,74 +0,0 @@
## helm init
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/).
As with the rest of the Helm commands, 'helm init' discovers Kubernetes clusters
by reading $KUBECONFIG (default '~/.kube/config') and using the default context.
To set up just a local environment, use '--client-only'. That will configure
$HELM_HOME, but not attempt to connect to a Kubernetes cluster and install the Tiller
deployment.
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).
To dump a manifest containing the Tiller deployment YAML, combine the
'--dry-run' and '--debug' flags.
```
helm init
```
### Options
```
--canary-image use the canary Tiller image
-c, --client-only if set does not install Tiller
--dry-run do not install local or remote
--force-upgrade force upgrade of Tiller to the current helm version
--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
--node-selectors string labels to specify the node on which Tiller is installed (app=tiller,helm=rocks)
-o, --output OutputFormat skip installation and output Tiller's manifest in specified format (json or yaml)
--override stringArray override values for the Tiller Deployment manifest (can specify multiple or separate values with commas: key1=val1,key2=val2)
--replicas int amount of tiller instances to run on the cluster (default 1)
--service-account string name of service account
--skip-refresh do not refresh (download) the local repository cache
--stable-repo-url string URL for stable repository (default "https://kubernetes-charts.storage.googleapis.com")
-i, --tiller-image string override Tiller image
--tiller-tls install Tiller with TLS enabled
--tiller-tls-cert string path to TLS certificate file to install with Tiller
--tiller-tls-key string path to TLS key file to install with Tiller
--tiller-tls-verify install Tiller with TLS enabled and to verify remote certificates
--tls-ca-cert string path to CA root certificate
--upgrade upgrade if Tiller is already installed
--wait block until Tiller is running and ready to receive requests
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

50
docs/helm/helm_inspect.md
Unescape View File

@ -1,50 +0,0 @@
## helm inspect
inspect a chart
### Synopsis
This command inspects a chart and displays information. It takes a chart reference
('stable/drupal'), a full path to a directory or packaged chart, or a URL.
Inspect prints the contents of the Chart.yaml file and the values.yaml file.
```
helm inspect [CHART]
```
### Options
```
--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
--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
--repo string chart repository url where to locate the requested chart
--username string chart repository username where to locate the requested chart
--verify verify the provenance data for this chart
--version string version of the chart. By default, the newest chart is shown
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### 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 14-Mar-2018

45
docs/helm/helm_inspect_chart.md
Unescape View File

@ -1,45 +0,0 @@
## helm inspect chart
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]
```
### Options
```
--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
--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
--repo string chart repository url where to locate the requested chart
--username string chart repository username where to locate the requested chart
--verify verify the provenance data for this chart
--version string version of the chart. By default, the newest chart is shown
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 8-Mar-2018

43
docs/helm/helm_inspect_readme.md
Unescape View File

@ -1,43 +0,0 @@
## helm inspect readme
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]
```
### Options
```
--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
--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
--verify verify the provenance data for this chart
--version string version of the chart. By default, the newest chart is shown
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 14-Mar-2018

45
docs/helm/helm_inspect_values.md
Unescape View File

@ -1,45 +0,0 @@
## helm inspect values
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]
```
### Options
```
--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
--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
--repo string chart repository url where to locate the requested chart
--username string chart repository username where to locate the requested chart
--verify verify the provenance data for this chart
--version string version of the chart. By default, the newest chart is shown
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 8-Mar-2018

120
docs/helm/helm_install.md
Unescape View File

@ -1,120 +0,0 @@
## helm install
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,
a path to an unpacked chart directory or a URL.
To override values in a chart, use either the '--values' flag and pass in a file
or use the '--set' flag and pass configuration from the command line, to force
a string value use '--set-string'.
$ helm install -f myvalues.yaml ./redis
or
$ helm install --set name=prod ./redis
or
$ helm install --set-string long_int=1234567890 ./redis
You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:
$ helm install -f myvalues.yaml -f override.yaml ./redis
You can specify the '--set' flag multiple times. The priority will be given to the
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:
$ helm install --set foo=bar --set foo=newbar ./redis
To check the generated manifests of a release without installing the chart,
the '--debug' and '--dry-run' flags can be combined. This will still require a
round-trip to the Tiller server.
If --verify is set, the chart MUST have a provenance file, and the provenance
file MUST pass all verification steps.
There are five different ways you can express the chart you want to install:
1. By chart reference: helm install stable/mariadb
2. By path to a packaged chart: helm install ./nginx-1.2.3.tgz
3. By path to an unpacked chart directory: helm install ./nginx
4. By absolute URL: helm install https://example.com/charts/nginx-1.2.3.tgz
5. By chart reference and repo url: helm install --repo https://example.com/charts/ nginx
CHART REFERENCES
A chart reference is a convenient way of reference a chart in a chart repository.
When you use a chart reference with a repo prefix ('stable/mariadb'), Helm will look in the local
configuration for a chart repository named 'stable', and will then look for a
chart in that repository whose name is 'mariadb'. It will install the latest
version of that chart unless you also supply a version number with the
'--version' flag.
To see the list of chart repositories, use 'helm repo list'. To search for
charts in a repository, use 'helm search'.
```
helm install [CHART]
```
### Options
```
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
--dep-up run helm dependency update before installing the chart
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
--dry-run simulate an install
--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
--name-template string specify template used to name the release
--namespace string namespace to install the release into. Defaults to the current kube config namespace.
--no-hooks prevent hooks from running during install
--password string chart repository password where to locate the requested chart
--replace re-use the given name, even if that name is already used. This is unsafe in production
--repo string chart repository url where to locate the requested chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
--username string chart repository username where to locate the requested chart
-f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default [])
--verify verify the package before installing it
--version string specify the exact chart version to install. If this is not specified, the latest version is installed
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 20-Mar-2018

45
docs/helm/helm_lint.md
Unescape View File

@ -1,45 +0,0 @@
## helm lint
examines a chart for possible issues
### Synopsis
This command takes a path to a chart and runs a series of tests to verify that
the chart is well-formed.
If the linter encounters things that will cause the chart to fail installation,
it will emit [ERROR] messages. If it encounters issues that break with convention
or recommendation, it will emit [WARNING] messages.
```
helm lint [flags] PATH
```
### Options
```
--namespace string namespace to install the release into (only used if --install is set) (default "default")
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--strict fail on lint warnings
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 9-Mar-2018

76
docs/helm/helm_list.md
Unescape View File

@ -1,76 +0,0 @@
## helm list
list releases
### Synopsis
This command lists all of the releases.
By default, it lists only releases that are deployed or failed. Flags like
'--deleted' and '--all' will alter this behavior. Such flags can be combined:
'--deleted --failed'.
By default, items are sorted alphabetically. Use the '-d' flag to sort by
release date.
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.
$ helm list 'ara[a-z]+'
NAME UPDATED CHART
maudlin-arachnid Mon May 9 16:07:08 2016 alpine-0.1.0
If no results are found, 'helm list' will exit 0, but with no output (or in
the case of no '-q' flag, only headers).
By default, up to 256 items may be returned. To limit this, use the '--max' flag.
Setting '--max' to 0 will not return all results. Rather, it will return the
server's default, which may be much higher than 256. Pairing the '--max'
flag with the '--offset' flag allows you to page through results.
```
helm list [flags] [FILTER]
```
### Options
```
-a, --all show all releases, not just the ones marked DEPLOYED
--col-width uint specifies the max column width of output (default 60)
-d, --date sort by release date
--deleted show deleted releases
--deleting show releases that are currently being deleted
--deployed show deployed releases. If no other is specified, this will be automatically enabled
--failed show failed releases
-m, --max int maximum number of releases to fetch (default 256)
--namespace string show releases within a specific namespace
-o, --offset string next release name in the list, used to offset from start value
--pending show pending releases
-r, --reverse reverse the sort order
-q, --short output short (quiet) listing format
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

53
docs/helm/helm_package.md
Unescape View File

@ -1,53 +0,0 @@
## helm package
package a chart directory into a chart archive
### Synopsis
This command packages a chart into a versioned chart archive file. If a path
is given, this will look at that path for a chart (which must contain a
Chart.yaml file) and then package that directory.
If no path is given, this will look in the present working directory for a
Chart.yaml file, and (if found) build the current directory into a chart.
Versioned chart archives are used by Helm package repositories.
```
helm package [flags] [CHART_PATH] [...]
```
### Options
```
--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 ".")
--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)
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--sign use a PGP private key to sign this package
-f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default [])
--version string set the version on the chart to this semver version
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 6-Apr-2018

30
docs/helm/helm_plugin.md
Unescape View File

@ -1,30 +0,0 @@
## helm plugin
add, list, or remove Helm plugins
### Synopsis
Manage client-side Helm plugins.
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
* [helm plugin install](helm_plugin_install.md) - install one or more Helm plugins
* [helm plugin list](helm_plugin_list.md) - list installed Helm plugins
* [helm plugin remove](helm_plugin_remove.md) - remove one or more Helm plugins
* [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins
###### Auto generated by spf13/cobra on 8-Mar-2018

39
docs/helm/helm_plugin_install.md
Unescape View File

@ -1,39 +0,0 @@
## helm plugin install
install one or more Helm plugins
### Synopsis
This command allows you to install a plugin from a url to a VCS repo or a local path.
Example usage:
$ helm plugin install https://github.com/technosophos/helm-template
```
helm plugin install [options] <path|url>...
```
### Options
```
--version string specify a version constraint. If this is not specified, the latest version is installed
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 8-Mar-2018

28
docs/helm/helm_plugin_list.md
Unescape View File

@ -1,28 +0,0 @@
## helm plugin list
list installed Helm plugins
### Synopsis
list installed Helm plugins
```
helm plugin list
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 8-Mar-2018

28
docs/helm/helm_plugin_remove.md
Unescape View File

@ -1,28 +0,0 @@
## helm plugin remove
remove one or more Helm plugins
### Synopsis
remove one or more Helm plugins
```
helm plugin remove <plugin>...
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 8-Mar-2018

28
docs/helm/helm_plugin_update.md
Unescape View File

@ -1,28 +0,0 @@
## helm plugin update
update one or more Helm plugins
### Synopsis
update one or more Helm plugins
```
helm plugin update <plugin>...
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 8-Mar-2018

35
docs/helm/helm_repo.md
Unescape View File

@ -1,35 +0,0 @@
## helm repo
add, list, remove, update, and index chart repositories
### Synopsis
This command consists of multiple subcommands to interact with chart repositories.
It can be used to add, remove, list, and index chart repositories.
Example usage:
$ helm repo add [NAME] [REPO_URL]
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
* [helm repo add](helm_repo_add.md) - add a chart repository
* [helm repo index](helm_repo_index.md) - generate an index file given a directory containing packaged charts
* [helm repo list](helm_repo_list.md) - list chart repositories
* [helm repo remove](helm_repo_remove.md) - remove a chart repository
* [helm repo update](helm_repo_update.md) - update information of available charts locally from chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

39
docs/helm/helm_repo_add.md
Unescape View File

@ -1,39 +0,0 @@
## helm repo add
add a chart repository
### Synopsis
add a chart repository
```
helm repo add [flags] [NAME] [URL]
```
### Options
```
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
--key-file string identify HTTPS client using this SSL key file
--no-update raise error if repo is already registered
--password string chart repository password
--username string chart repository username
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

44
docs/helm/helm_repo_index.md
Unescape View File

@ -1,44 +0,0 @@
## helm repo index
generate an index file given a directory containing packaged charts
### Synopsis
Read the current directory and generate an index file based on the charts found.
This tool is used for creating an 'index.yaml' file for a chart repository. To
set an absolute URL to the charts, use '--url' flag.
To merge the generated index with an existing index file, use the '--merge'
flag. In this case, the charts found in the current directory will be merged
into the existing index, with local charts taking priority over existing charts.
```
helm repo index [flags] [DIR]
```
### Options
```
--merge string merge the generated index into the given index
--url string url of chart repository
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

28
docs/helm/helm_repo_list.md
Unescape View File

@ -1,28 +0,0 @@
## helm repo list
list chart repositories
### Synopsis
list chart repositories
```
helm repo list [flags]
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

28
docs/helm/helm_repo_remove.md
Unescape View File

@ -1,28 +0,0 @@
## helm repo remove
remove a chart repository
### Synopsis
remove a chart repository
```
helm repo remove [flags] [NAME]
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

34
docs/helm/helm_repo_update.md
Unescape View File

@ -1,34 +0,0 @@
## helm repo update
update information of available charts locally from chart repositories
### Synopsis
Update gets the latest information about charts from the respective chart repositories.
Information is cached locally, where it is used by commands like 'helm search'.
'helm update' is the deprecated form of 'helm repo update'. It will be removed in
future releases.
```
helm repo update
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 8-Mar-2018

44
docs/helm/helm_reset.md
Unescape View File

@ -1,44 +0,0 @@
## helm reset
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
```
### Options
```
-f, --force forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state. Releases are not deleted.)
--remove-helm-home if set deletes $HELM_HOME
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

50
docs/helm/helm_rollback.md
Unescape View File

@ -1,50 +0,0 @@
## helm rollback
roll back a release to a previous revision
### Synopsis
This command rolls back a release to a previous revision.
The first argument of the rollback command is the name of a release, and the
second is a revision (version) number. To see revision numbers, run
'helm history RELEASE'.
```
helm rollback [flags] [RELEASE] [REVISION]
```
### Options
```
--dry-run simulate a rollback
--force force resource update through delete/recreate if needed
--no-hooks prevent hooks from running during rollback
--recreate-pods performs pods restart for the resource if applicable
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

41
docs/helm/helm_search.md
Unescape View File

@ -1,41 +0,0 @@
## helm search
search for a keyword in charts
### Synopsis
Search reads through all of the repositories configured on the system, and
looks for matches.
Repositories are managed with 'helm repo' commands.
```
helm search [keyword]
```
### Options
```
-r, --regexp use regular expressions for searching
-v, --version string search using semantic versioning constraints
-l, --versions show the long listing, with each version of each chart on its own line
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

49
docs/helm/helm_serve.md
Unescape View File

@ -1,49 +0,0 @@
## helm serve
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
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').
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.
See https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories
for more information on hosting chart repositories in a production setting.
```
helm serve
```
### Options
```
--address string address to listen on (default "127.0.0.1:8879")
--repo-path string local directory path from which to serve charts
--url string external URL of chart repository
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

49
docs/helm/helm_status.md
Unescape View File

@ -1,49 +0,0 @@
## helm status
displays the status of the named release
### Synopsis
This command shows the status of a named release.
The status consists of:
- last deployment time
- k8s namespace in which the release lives
- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING)
- list of resources that this release consists of, sorted by kind
- details on last test suite run, if applicable
- additional notes provided by the chart
```
helm status [flags] RELEASE_NAME
```
### Options
```
-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
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

54
docs/helm/helm_template.md
Unescape View File

@ -1,54 +0,0 @@
## helm template
locally render templates
### Synopsis
Render chart templates locally and display the output.
This does not require Tiller. However, any values that would normally be
looked up or retrieved in-cluster will be faked locally. Additionally, none
of the server-side testing of chart validity (e.g. whether an API is supported)
is done.
To render just one template in a chart, use '-x':
$ helm template mychart -x templates/deployment.yaml
```
helm template [flags] CHART
```
### Options
```
-x, --execute stringArray only execute the given templates
--kube-version string kubernetes version used as Capabilities.KubeVersion.Major/Minor (default "1.9")
-n, --name string release name (default "RELEASE-NAME")
--name-template string specify template used to name the release
--namespace string namespace to install the release into
--notes show the computed NOTES.txt file as well
--output-dir string writes the executed templates to files in output-dir instead of stdout
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
-f, --values valueFiles specify values in a YAML file (can specify multiple) (default [])
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 9-Mar-2018

45
docs/helm/helm_test.md
Unescape View File

@ -1,45 +0,0 @@
## helm test
test a release
### Synopsis
The test command runs the tests for a release.
The argument this command takes is the name of a deployed release.
The tests to be run are defined in the chart that was installed.
```
helm test [RELEASE]
```
### Options
```
--cleanup delete test pods upon completion
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

84
docs/helm/helm_upgrade.md
Unescape View File

@ -1,84 +0,0 @@
## helm upgrade
upgrade a release
### Synopsis
This command upgrades a release to a new version of a chart.
The upgrade arguments must be a release and chart. The chart
argument can be either: a chart reference('stable/mariadb'), a path to a chart directory,
a packaged chart, or a fully qualified URL. For chart references, the latest
version will be specified unless the '--version' flag is set.
To override values in a chart, use either the '--values' flag and pass in a file
or use the '--set' flag and pass configuration from the command line, to force string
values, use '--set-string'.
You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:
$ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis
You can specify the '--set' flag multiple times. The priority will be given to the
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:
$ helm upgrade --set foo=bar --set foo=newbar redis ./redis
```
helm upgrade [RELEASE] [CHART]
```
### Options
```
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
--dry-run simulate an upgrade
--force force resource update through delete/recreate if needed
-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")
--namespace string namespace to install the release into (only used if --install is set). Defaults to the current kube config namespace
--no-hooks disable pre/post upgrade hooks
--password string chart repository password where to locate the requested chart
--recreate-pods performs pods restart for the resource if applicable
--repo string chart repository url where to locate the requested chart
--reset-values when upgrading, reset the values to the ones built into the chart
--reuse-values when upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored.
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
--username string chart repository username where to locate the requested chart
-f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default [])
--verify verify the provenance of the chart before upgrading
--version string specify the exact chart version to use. If this is not specified, the latest version is used
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 4-Apr-2018

43
docs/helm/helm_verify.md
Unescape View File

@ -1,43 +0,0 @@
## helm verify
verify that a chart at the given path has been signed and is valid
### Synopsis
Verify that the given chart has a valid provenance file.
Provenance files provide crytographic verification that a chart has not been
tampered with, and was packaged by a trusted provider.
This command can be used to verify a local chart. Several other commands provide
'--verify' flags that run the same validation. To generate a signed package, use
the 'helm package --sign' command.
```
helm verify [flags] PATH
```
### Options
```
--keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg")
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

58
docs/helm/helm_version.md
Unescape View File

@ -1,58 +0,0 @@
## helm version
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
Tiller. The output will look something like this:
Client: &version.Version{SemVer:"v2.0.0", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.0.0", GitCommit:"b0c113dfb9f612a9add796549da66c0d294508a3", GitTreeState:"clean"}
- SemVer is the semantic version of the release.
- GitCommit is the SHA for the commit that this version was built from.
- GitTreeState is "clean" if there are no local code changes when this binary was
built, and "dirty" if the binary was built from locally modified code.
To print just the client version, use '--client'. To print just the server version,
use '--server'.
```
helm version
```
### Options
```
-c, --client client version only
-s, --server server version only
--short print the version number
--template string template for version string format
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300)
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 8-Mar-2018

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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-May\-2017 Auto generated by spf13/cobra

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

@ -1,243 +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 a chart reference, a path to a packaged chart,
a path to an unpacked chart directory or a URL.
.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\-\-dep\-up\fP[=false]
run helm dependency update before installing the chart.
.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 or a URL(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="localhost:44134"
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
31\-Oct\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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 of available charts locally from 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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-May\-2017 Auto generated by spf13/cobra

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

@ -1,101 +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\-\-force\fP[=false]
force resource update through delete/recreate if needed
.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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-May\-2017 Auto generated by spf13/cobra

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

@ -1,190 +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\-\-force\fP[=false]
force resource update through delete/recreate if needed
.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 or a URL(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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-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="localhost:44134"
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
19\-May\-2017 Auto generated by spf13/cobra
Write Preview
Loading…
Cancel
Save