You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
helm/docs/man/man1/helm_install.1

200 lines
4.4 KiB

.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
.SH NAME
.PP
helm\-install \- install a chart archive
.SH SYNOPSIS
.PP
\fBhelm install [CHART]\fP
.SH DESCRIPTION
.PP
This command installs a chart archive.
.PP
The install argument must be either a relative path to a chart directory or the
name of a chart in the current working directory.
.PP
To override values in a chart, use either the '\-\-values' flag and pass in a file
or use the '\-\-set' flag and pass configuration from the command line.
.PP
.RS
.nf
$ helm install \-f myvalues.yaml ./redis
.fi
.RE
.PP
or
.PP
.RS
.nf
$ helm install \-\-set name=prod ./redis
.fi
.RE
.PP
You can specify the '\-\-values'/'\-f' flag multiple times. The priority will be given to the
last (right\-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:
.PP
.RS
.nf
$ helm install \-f myvalues.yaml \-f override.yaml ./redis
.fi
.RE
.PP
You can specify the '\-\-set' flag multiple times. The priority will be given to the
last (right\-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:
.PP
.RS
.nf
$ helm install \-\-set foo=bar \-\-set foo=newbar ./redis
.fi
.RE
.PP
To check the generated manifests of a release without installing the chart,
the '\-\-debug' and '\-\-dry\-run' flags can be combined. This will still require a
round\-trip to the Tiller server.
.PP
If \-\-verify is set, the chart MUST have a provenance file, and the provenenace
fall MUST pass all verification steps.
.PP
There are four different ways you can express the chart you want to install:
.IP " 1." 5
By chart reference: helm install stable/mariadb
.IP " 2." 5
By path to a packaged chart: helm install ./nginx\-1.2.3.tgz
.IP " 3." 5
By path to an unpacked chart directory: helm install ./nginx
.IP " 4." 5
By absolute URL: helm install
\[la]https://example.com/charts/nginx-1.2.3.tgz\[ra]
.PP
CHART REFERENCES
.PP
A chart reference is a convenient way of reference a chart in a chart repository.
.PP
When you use a chart reference ('stable/mariadb'), Helm will look in the local
configuration for a chart repository named 'stable', and will then look for a
chart in that repository whose name is 'mariadb'. It will install the latest
version of that chart unless you also supply a version number with the
'\-\-version' flag.
.PP
To see the list of chart repositories, use 'helm repo list'. To search for
charts in a repository, use 'helm search'.
.SH OPTIONS
.PP
\fB\-\-dry\-run\fP[=false]
simulate an install
.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\-\-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\-f\fP, \fB\-\-values\fP=[]
specify values in a YAML file (can specify multiple)
.PP
\fB\-\-verify\fP[=false]
verify the package before installing it
.PP
\fB\-\-version\fP=""
specify the exact chart version to install. If this is not specified, the latest version is installed
.PP
\fB\-\-wait\fP[=false]
if set, will wait until all Pods, PVCs, and Services are in a ready state before marking the release as successful. It will wait for as long as \-\-timeout
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-debug\fP[=false]
enable verbose output
.PP
\fB\-\-home\fP="~/.helm"
location of your Helm config. Overrides $HELM\_HOME
.PP
\fB\-\-host\fP=""
address of tiller. Overrides $HELM\_HOST
.PP
\fB\-\-kube\-context\fP=""
name of the kubeconfig context to use
.PP
\fB\-\-tiller\-namespace\fP="kube\-system"
namespace of tiller
.SH SEE ALSO
.PP
\fBhelm(1)\fP
.SH HISTORY
.PP
11\-Mar\-2017 Auto generated by spf13/cobra