github.com/koderover/helm@v2.17.0+incompatible/docs/helm/helm_install.md (about)

     1  ## helm install
     2  
     3  Install a chart archive
     4  
     5  ### Synopsis
     6  
     7  
     8  This command installs a chart archive.
     9  
    10  The install argument must be a chart reference, a path to a packaged chart,
    11  a path to an unpacked chart directory or a URL.
    12  
    13  To override values in a chart, use either the '--values' flag and pass in a file
    14  or use the '--set' flag and pass configuration from the command line.  To force string
    15  values in '--set', use '--set-string' instead. In case a value is large and therefore
    16  you want not to use neither '--values' nor '--set', use '--set-file' to read the
    17  single large value from file.
    18  
    19  	$ helm install -f myvalues.yaml ./redis
    20  
    21  or
    22  
    23  	$ helm install --set name=prod ./redis
    24  
    25  or
    26  
    27  	$ helm install --set-string long_int=1234567890 ./redis
    28  
    29  or
    30      $ helm install --set-file multiline_text=path/to/textfile
    31  
    32  You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
    33  last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
    34  contained a key called 'Test', the value set in override.yaml would take precedence:
    35  
    36  	$ helm install -f myvalues.yaml -f override.yaml ./redis
    37  
    38  You can specify the '--set' flag multiple times. The priority will be given to the
    39  last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
    40  set for a key called 'foo', the 'newbar' value would take precedence:
    41  
    42  	$ helm install --set foo=bar --set foo=newbar ./redis
    43  
    44  
    45  To check the generated manifests of a release without installing the chart,
    46  the '--debug' and '--dry-run' flags can be combined. This will still require a
    47  round-trip to the Tiller server.
    48  
    49  If --verify is set, the chart MUST have a provenance file, and the provenance
    50  file MUST pass all verification steps.
    51  
    52  There are five different ways you can express the chart you want to install:
    53  
    54  1. By chart reference: helm install stable/mariadb
    55  2. By path to a packaged chart: helm install ./nginx-1.2.3.tgz
    56  3. By path to an unpacked chart directory: helm install ./nginx
    57  4. By absolute URL: helm install https://example.com/charts/nginx-1.2.3.tgz
    58  5. By chart reference and repo url: helm install --repo https://example.com/charts/ nginx
    59  
    60  CHART REFERENCES
    61  
    62  A chart reference is a convenient way of reference a chart in a chart repository.
    63  
    64  When you use a chart reference with a repo prefix ('stable/mariadb'), Helm will look in the local
    65  configuration for a chart repository named 'stable', and will then look for a
    66  chart in that repository whose name is 'mariadb'. It will install the latest
    67  version of that chart unless you also supply a version number with the
    68  '--version' flag.
    69  
    70  To see the list of chart repositories, use 'helm repo list'. To search for
    71  charts in a repository, use 'helm search'.
    72  
    73  
    74  ```
    75  helm install [CHART] [flags]
    76  ```
    77  
    78  ### Options
    79  
    80  ```
    81        --atomic                   If set, installation process purges chart on fail, also sets --wait flag
    82        --ca-file string           Verify certificates of HTTPS-enabled servers using this CA bundle
    83        --cert-file string         Identify HTTPS client using this SSL certificate file
    84        --dep-up                   Run helm dependency update before installing the chart
    85        --description string       Specify a description for the release
    86        --devel                    Use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
    87        --dry-run                  Simulate an install
    88    -h, --help                     help for install
    89        --key-file string          Identify HTTPS client using this SSL key file
    90        --keyring string           Location of public keys used for verification (default "~/.gnupg/pubring.gpg")
    91    -n, --name string              The release name. If unspecified, it will autogenerate one for you
    92        --name-template string     Specify template used to name the release
    93        --namespace string         Namespace to install the release into. Defaults to the current kube config namespace.
    94        --no-crd-hook              Prevent CRD hooks from running, but run other hooks
    95        --no-hooks                 Prevent hooks from running during install
    96    -o, --output string            Prints the output in the specified format. Allowed values: table, json, yaml (default "table")
    97        --password string          Chart repository password where to locate the requested chart
    98        --render-subchart-notes    Render subchart notes along with the parent
    99        --replace                  Re-use the given name, even if that name is already used. This is unsafe in production
   100        --repo string              Chart repository url where to locate the requested chart
   101        --set stringArray          Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
   102        --set-file stringArray     Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
   103        --set-string stringArray   Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
   104        --timeout int              Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
   105        --tls                      Enable TLS for request
   106        --tls-ca-cert string       Path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
   107        --tls-cert string          Path to TLS certificate file (default "$HELM_HOME/cert.pem")
   108        --tls-hostname string      The server name used to verify the hostname on the returned certificates from the server
   109        --tls-key string           Path to TLS key file (default "$HELM_HOME/key.pem")
   110        --tls-verify               Enable TLS for request and verify remote
   111        --username string          Chart repository username where to locate the requested chart
   112    -f, --values valueFiles        Specify values in a YAML file or a URL(can specify multiple) (default [])
   113        --verify                   Verify the package before installing it
   114        --version string           Specify the exact chart version to install. If this is not specified, the latest version is installed
   115        --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
   116  ```
   117  
   118  ### Options inherited from parent commands
   119  
   120  ```
   121        --debug                           Enable verbose output
   122        --home string                     Location of your Helm config. Overrides $HELM_HOME (default "~/.helm")
   123        --host string                     Address of Tiller. Overrides $HELM_HOST
   124        --kube-context string             Name of the kubeconfig context to use
   125        --kubeconfig string               Absolute path of the kubeconfig file to be used
   126        --tiller-connection-timeout int   The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300)
   127        --tiller-namespace string         Namespace of Tiller (default "kube-system")
   128  ```
   129  
   130  ### SEE ALSO
   131  
   132  * [helm](helm.md)	 - The Helm package manager for Kubernetes.
   133  
   134  ###### Auto generated by spf13/cobra on 24-Sep-2019