github.com/felipejfc/helm@v2.1.2+incompatible/docs/man/man1/helm_install.1 (about)

     1  .TH "HELM" "1" "Nov 2016" "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  To check the generated manifests of a release without installing the chart,
    51  the '\-\-debug' and '\-\-dry\-run' flags can be combined. This will still require a
    52  round\-trip to the Tiller server.
    53  
    54  .PP
    55  If \-\-verify is set, the chart MUST have a provenance file, and the provenenace
    56  fall MUST pass all verification steps.
    57  
    58  .PP
    59  There are four different ways you can express the chart you want to install:
    60  .IP "  1." 5
    61  By chart reference: helm install stable/mariadb
    62  .IP "  2." 5
    63  By path to a packaged chart: helm install ./nginx\-1.2.3.tgz
    64  .IP "  3." 5
    65  By path to an unpacked chart directory: helm install ./nginx
    66  .IP "  4." 5
    67  By absolute URL: helm install 
    68  \[la]https://example.com/charts/nginx-1.2.3.tgz\[ra]
    69  
    70  .PP
    71  CHART REFERENCES
    72  
    73  .PP
    74  A chart reference is a convenient way of reference a chart in a chart repository.
    75  
    76  .PP
    77  When you use a chart reference ('stable/mariadb'), Helm will look in the local
    78  configuration for a chart repository named 'stable', and will then look for a
    79  chart in that repository whose name is 'mariadb'. It will install the latest
    80  version of that chart unless you also supply a version number with the
    81  '\-\-version' flag.
    82  
    83  .PP
    84  To see the list of chart repositories, use 'helm repo list'. To search for
    85  charts in a repository, use 'helm search'.
    86  
    87  
    88  .SH OPTIONS
    89  .PP
    90  \fB\-\-dry\-run\fP[=false]
    91      simulate an install
    92  
    93  .PP
    94  \fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
    95      location of public keys used for verification
    96  
    97  .PP
    98  \fB\-n\fP, \fB\-\-name\fP=""
    99      release name. If unspecified, it will autogenerate one for you
   100  
   101  .PP
   102  \fB\-\-name\-template\fP=""
   103      specify template used to name the release
   104  
   105  .PP
   106  \fB\-\-namespace\fP=""
   107      namespace to install the release into
   108  
   109  .PP
   110  \fB\-\-no\-hooks\fP[=false]
   111      prevent hooks from running during install
   112  
   113  .PP
   114  \fB\-\-replace\fP[=false]
   115      re\-use the given name, even if that name is already used. This is unsafe in production
   116  
   117  .PP
   118  \fB\-\-set\fP=null
   119  
   120  .PP
   121  .RS
   122  
   123  .nf
   124  set values on the command line. Separate values with commas: key1=val1,key2=val2
   125  
   126  .fi
   127  .RE
   128  
   129  .PP
   130  \fB\-f\fP, \fB\-\-values\fP=""
   131      specify values in a YAML file
   132  
   133  .PP
   134  \fB\-\-verify\fP[=false]
   135      verify the package before installing it
   136  
   137  .PP
   138  \fB\-\-version\fP=""
   139      specify the exact chart version to install. If this is not specified, the latest version is installed
   140  
   141  
   142  .SH OPTIONS INHERITED FROM PARENT COMMANDS
   143  .PP
   144  \fB\-\-debug\fP[=false]
   145      enable verbose output
   146  
   147  .PP
   148  \fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
   149      location of your Helm config. Overrides $HELM\_HOME
   150  
   151  .PP
   152  \fB\-\-host\fP=""
   153      address of tiller. Overrides $HELM\_HOST
   154  
   155  .PP
   156  \fB\-\-kube\-context\fP=""
   157      name of the kubeconfig context to use
   158  
   159  
   160  .SH SEE ALSO
   161  .PP
   162  \fBhelm(1)\fP
   163  
   164  
   165  .SH HISTORY
   166  .PP
   167  1\-Nov\-2016 Auto generated by spf13/cobra