github.com/sgoings/helm@v2.0.0-alpha.2.0.20170406211108-734e92851ac3+incompatible/docs/man/man1/helm_install.1 (about)

     1  .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" 
     2  .nh
     3  .ad l
     4  
     5  
     6  .SH NAME
     7  .PP
     8  helm\-install \- install a chart archive
     9  
    10  
    11  .SH SYNOPSIS
    12  .PP
    13  \fBhelm install [CHART]\fP
    14  
    15  
    16  .SH DESCRIPTION
    17  .PP
    18  This command installs a chart archive.
    19  
    20  .PP
    21  The install argument must be either a relative path to a chart directory or the
    22  name of a chart in the current working directory.
    23  
    24  .PP
    25  To override values in a chart, use either the '\-\-values' flag and pass in a file
    26  or use the '\-\-set' flag and pass configuration from the command line.
    27  
    28  .PP
    29  .RS
    30  
    31  .nf
    32  $ helm install \-f myvalues.yaml ./redis
    33  
    34  .fi
    35  .RE
    36  
    37  .PP
    38  or
    39  
    40  .PP
    41  .RS
    42  
    43  .nf
    44  $ helm install \-\-set name=prod ./redis
    45  
    46  .fi
    47  .RE
    48  
    49  .PP
    50  You can specify the '\-\-values'/'\-f' flag multiple times. The priority will be given to the
    51  last (right\-most) file specified. For example, if both myvalues.yaml and override.yaml
    52  contained a key called 'Test', the value set in override.yaml would take precedence:
    53  
    54  .PP
    55  .RS
    56  
    57  .nf
    58  $ helm install \-f myvalues.yaml \-f override.yaml ./redis
    59  
    60  .fi
    61  .RE
    62  
    63  .PP
    64  You can specify the '\-\-set' flag multiple times. The priority will be given to the
    65  last (right\-most) set specified. For example, if both 'bar' and 'newbar' values are
    66  set for a key called 'foo', the 'newbar' value would take precedence:
    67  
    68  .PP
    69  .RS
    70  
    71  .nf
    72  $ helm install \-\-set foo=bar \-\-set foo=newbar ./redis
    73  
    74  .fi
    75  .RE
    76  
    77  .PP
    78  To check the generated manifests of a release without installing the chart,
    79  the '\-\-debug' and '\-\-dry\-run' flags can be combined. This will still require a
    80  round\-trip to the Tiller server.
    81  
    82  .PP
    83  If \-\-verify is set, the chart MUST have a provenance file, and the provenenace
    84  fall MUST pass all verification steps.
    85  
    86  .PP
    87  There are four different ways you can express the chart you want to install:
    88  .IP "  1." 5
    89  By chart reference: helm install stable/mariadb
    90  .IP "  2." 5
    91  By path to a packaged chart: helm install ./nginx\-1.2.3.tgz
    92  .IP "  3." 5
    93  By path to an unpacked chart directory: helm install ./nginx
    94  .IP "  4." 5
    95  By absolute URL: helm install 
    96  \[la]https://example.com/charts/nginx-1.2.3.tgz\[ra]
    97  
    98  .PP
    99  CHART REFERENCES
   100  
   101  .PP
   102  A chart reference is a convenient way of reference a chart in a chart repository.
   103  
   104  .PP
   105  When you use a chart reference ('stable/mariadb'), Helm will look in the local
   106  configuration for a chart repository named 'stable', and will then look for a
   107  chart in that repository whose name is 'mariadb'. It will install the latest
   108  version of that chart unless you also supply a version number with the
   109  '\-\-version' flag.
   110  
   111  .PP
   112  To see the list of chart repositories, use 'helm repo list'. To search for
   113  charts in a repository, use 'helm search'.
   114  
   115  
   116  .SH OPTIONS
   117  .PP
   118  \fB\-\-dry\-run\fP[=false]
   119      simulate an install
   120  
   121  .PP
   122  \fB\-\-keyring\fP="~/.gnupg/pubring.gpg"
   123      location of public keys used for verification
   124  
   125  .PP
   126  \fB\-n\fP, \fB\-\-name\fP=""
   127      release name. If unspecified, it will autogenerate one for you
   128  
   129  .PP
   130  \fB\-\-name\-template\fP=""
   131      specify template used to name the release
   132  
   133  .PP
   134  \fB\-\-namespace\fP=""
   135      namespace to install the release into
   136  
   137  .PP
   138  \fB\-\-no\-hooks\fP[=false]
   139      prevent hooks from running during install
   140  
   141  .PP
   142  \fB\-\-replace\fP[=false]
   143      re\-use the given name, even if that name is already used. This is unsafe in production
   144  
   145  .PP
   146  \fB\-\-set\fP=[]
   147      set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
   148  
   149  .PP
   150  \fB\-\-timeout\fP=300
   151      time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
   152  
   153  .PP
   154  \fB\-f\fP, \fB\-\-values\fP=[]
   155      specify values in a YAML file (can specify multiple)
   156  
   157  .PP
   158  \fB\-\-verify\fP[=false]
   159      verify the package before installing it
   160  
   161  .PP
   162  \fB\-\-version\fP=""
   163      specify the exact chart version to install. If this is not specified, the latest version is installed
   164  
   165  .PP
   166  \fB\-\-wait\fP[=false]
   167      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
   168  
   169  
   170  .SH OPTIONS INHERITED FROM PARENT COMMANDS
   171  .PP
   172  \fB\-\-debug\fP[=false]
   173      enable verbose output
   174  
   175  .PP
   176  \fB\-\-home\fP="~/.helm"
   177      location of your Helm config. Overrides $HELM\_HOME
   178  
   179  .PP
   180  \fB\-\-host\fP=""
   181      address of tiller. Overrides $HELM\_HOST
   182  
   183  .PP
   184  \fB\-\-kube\-context\fP=""
   185      name of the kubeconfig context to use
   186  
   187  .PP
   188  \fB\-\-tiller\-namespace\fP="kube\-system"
   189      namespace of tiller
   190  
   191  
   192  .SH SEE ALSO
   193  .PP
   194  \fBhelm(1)\fP
   195  
   196  
   197  .SH HISTORY
   198  .PP
   199  11\-Mar\-2017 Auto generated by spf13/cobra