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'. You can use '–set-file' to set individual values from a file when the value itself is too long for the command line or is dynamically generated.
$ helm install -f myvalues.yaml myredis ./redis
or
$ helm install --set name=prod myredis ./redis
or
$ helm install --set-string long_int=1234567890 myredis ./redis
or
$ helm install --set-file my_script=[dothings.sh](dothings.sh) myredis ./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 myredis ./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 myredis ./redis
To check the generated manifests of a release without installing the chart, the '–debug' and '–dry-run' flags can be combined.
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:
- By chart reference: helm install mymaria example/mariadb
- By path to a packaged chart: helm install mynginx ./nginx-1.2.3.tgz
- By path to an unpacked chart directory: helm install mynginx ./nginx
- By absolute URL: helm install mynginx https://example.com/charts/nginx-1.2.3.tgz
- By chart reference and repo url: helm install –repo https://example.com/charts/ mynginx nginx
CHART REFERENCES
A chart reference is a convenient way of referencing a chart in a chart repository.
When you use a chart reference with a repo prefix ('example/mariadb'), Helm will look in the local configuration for a chart repository named 'example', and will then look for a chart in that repository whose name is 'mariadb'. It will install the latest stable version of that chart until you specify '–devel' flag to also include development version (alpha, beta, and release candidate releases), or 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'.
Syntax
werf helm install [NAME] [CHART] [flags] [options]
Options
--add-annotation=[]
Add annotation to deploying resources (can specify multiple).
Format: annoName=annoValue.
Also, can be specified with $WERF_ADD_ANNOTATION_* (e.g.
$WERF_ADD_ANNOTATION_1=annoName1=annoValue1,
$WERF_ADD_ANNOTATION_2=annoName2=annoValue2)
--add-label=[]
Add label to deploying resources (can specify multiple).
Format: labelName=labelValue.
Also, can be specified with $WERF_ADD_LABEL_* (e.g.
$WERF_ADD_LABEL_1=labelName1=labelValue1, $WERF_ADD_LABEL_2=labelName2=labelValue2)
--atomic=false
if set, the installation process deletes the installation on failure. The --wait flag
will be set automatically if --atomic is used
--ca-file=''
verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file=''
identify HTTPS client using this SSL certificate file
--cleanup-on-fail=false
allow deletion of new resources created in this installation when install fails
--create-namespace=false
create the release namespace if not present
--dependency-update=false
update dependencies if they are missing before installing the chart
--description=''
add a custom description
--devel=false
use development versions, too. Equivalent to version `>0.0.0-0`. If --version is set,
this is ignored
--disable-openapi-validation=false
if set, the installation process will not validate rendered templates against the
Kubernetes OpenAPI Schema
--dry-run=false
simulate an install
-g, --generate-name=false
generate the name (and omit the NAME parameter)
--ignore-secret-key=false
Disable secrets decryption (default $WERF_IGNORE_SECRET_KEY)
--insecure-skip-tls-verify=false
skip tls certificate checks for the chart download
--key-file=''
identify HTTPS client using this SSL key file
--keyring='~/.gnupg/pubring.gpg'
location of public keys used for verification
--name-template=''
specify template used to name the release
--no-hooks=false
prevent hooks from running during install
-o, --output=table
prints the output in the specified format. Allowed values: table, json, yaml
--pass-credentials=false
pass credentials to all domains
--password=''
chart repository password where to locate the requested chart
--post-renderer=exec
the path to an executable to be used for post rendering. If it exists in $PATH, the
binary will be used, otherwise it will try to look for the executable at the given path
--render-subchart-notes=false
if set, render subchart notes along with the parent
--replace=false
re-use the given name, only if that name is a deleted release which remains in the
history. This is unsafe in production
--repo=''
chart repository url where to locate the requested chart
--secret-values=[]
Specify helm secret values in a YAML file (can specify multiple).
Also, can be defined with $WERF_SECRET_VALUES_* (e.g.
$WERF_SECRET_VALUES_ENV=.helm/secret_values_test.yaml,
$WERF_SECRET_VALUES_DB=.helm/secret_values_db.yaml)
--set=[]
set values on the command line (can specify multiple or separate values with commas:
key1=val1,key2=val2)
--set-file=[]
set values from respective files specified via the command line (can specify multiple
or separate values with commas: key1=path1,key2=path2)
--set-string=[]
set STRING values on the command line (can specify multiple or separate values with
commas: key1=val1,key2=val2)
--skip-crds=false
if set, no CRDs will be installed. By default, CRDs are installed if not already present
--timeout=5m0s
time to wait for any individual Kubernetes operation (like Jobs for hooks)
--username=''
chart repository username where to locate the requested chart
-f, --values=[]
specify values in a YAML file or a URL (can specify multiple)
--verify=false
verify the package before using it
--version=''
specify a version constraint for the chart version to use. This constraint can be a
specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is
not specified, the latest version is used
--wait=false
if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a
Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release
as successful. It will wait for as long as --timeout
--wait-for-jobs=false
if set and --wait enabled, will wait until all Jobs have been completed before marking
the release as successful. It will wait for as long as --timeout
Options inherited from parent commands
--hooks-status-progress-period=5
Hooks status progress period in seconds. Set 0 to stop showing hooks status progress.
Defaults to $WERF_HOOKS_STATUS_PROGRESS_PERIOD_SECONDS or status progress period value
--kube-config=''
Kubernetes config file path (default $WERF_KUBE_CONFIG, or $WERF_KUBECONFIG, or
$KUBECONFIG)
--kube-config-base64=''
Kubernetes config data as base64 string (default $WERF_KUBE_CONFIG_BASE64 or
$WERF_KUBECONFIG_BASE64 or $KUBECONFIG_BASE64)
--kube-context=''
Kubernetes config context (default $WERF_KUBE_CONTEXT)
--log-color-mode='auto'
Set log color mode.
Supported on, off and auto (based on the stdout’s file descriptor referring to a
terminal) modes.
Default $WERF_LOG_COLOR_MODE or auto mode.
--log-debug=false
Enable debug (default $WERF_LOG_DEBUG).
--log-pretty=true
Enable emojis, auto line wrapping and log process border (default $WERF_LOG_PRETTY or
true).
--log-quiet=false
Disable explanatory output (default $WERF_LOG_QUIET).
--log-terminal-width=-1
Set log terminal width.
Defaults to:
* $WERF_LOG_TERMINAL_WIDTH
* interactive terminal width or 140
--log-verbose=false
Enable verbose output (default $WERF_LOG_VERBOSE).
-n, --namespace=''
namespace scope for this request
--status-progress-period=5
Status progress period in seconds. Set -1 to stop showing status progress. Defaults to
$WERF_STATUS_PROGRESS_PERIOD_SECONDS or 5 seconds