github.com/koderover/helm@v2.17.0+incompatible/docs/man/man1/helm_upgrade.1 (about)

     1  .TH "HELM" "1" "Aug 2018" "Auto generated by spf13/cobra" ""  ""
     2  
     3  
     4  .SH NAME
     5  .PP
     6  helm\-upgrade \- upgrade a release
     7  
     8  
     9  .SH SYNOPSIS
    10  .PP
    11  \fBhelm upgrade [RELEASE] [CHART] [flags]\fP
    12  
    13  
    14  .SH DESCRIPTION
    15  .PP
    16  This command upgrades a release to a specified version of a chart and/or updates chart values.
    17  
    18  .PP
    19  Required arguments are release and chart. The chart argument can be one of:
    20   \- a chart reference('stable/mariadb'); use '\-\-version' and '\-\-devel' flags for versions other than latest,
    21   \- a path to a chart directory,
    22   \- a packaged chart,
    23   \- a fully qualified URL.
    24  
    25  .PP
    26  To customize the chart values, use any of
    27   \- '\-\-values'/'\-f' to pass in a yaml file holding settings,
    28   \- '\-\-set' to provide one or more key=val pairs directly,
    29   \- '\-\-set\-string' to provide key=val forcing val to be stored as a string,
    30   \- '\-\-set\-file' to provide key=path to read a single large value from a file at path.
    31  
    32  .PP
    33  To edit or append to the existing customized values, add the
    34   '\-\-reuse\-values' flag, otherwise any existing customized values are ignored.
    35  
    36  .PP
    37  If no chart value arguments are provided on the command line, any existing customized values are carried
    38  forward. If you want to revert to just the values provided in the chart, use the '\-\-reset\-values' flag.
    39  
    40  .PP
    41  You can specify any of the chart value flags multiple times. The priority will be given to the last
    42  (right\-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key
    43  called 'Test', the value set in override.yaml would take precedence:
    44  
    45  .PP
    46  .RS
    47  
    48  .nf
    49  $ helm upgrade \-f myvalues.yaml \-f override.yaml redis ./redis
    50  
    51  .fi
    52  .RE
    53  
    54  .PP
    55  Note that the key name provided to the '\-\-set', '\-\-set\-string' and '\-\-set\-file' flags can reference
    56  structure elements. Examples:
    57    \- mybool=TRUE
    58    \- livenessProbe.timeoutSeconds=10
    59    \- metrics.annotations[0]=hey,metrics.annotations[1]=ho
    60  
    61  .PP
    62  which sets the top level key mybool to true, the nested timeoutSeconds to 10, and two array values, respectively.
    63  
    64  .PP
    65  Note that the value side of the key=val provided to '\-\-set' and '\-\-set\-string' flags will pass through
    66  shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with
    67  special characters in unexpected ways, for example
    68  
    69  .PP
    70  .RS
    71  
    72  .nf
    73  $ helm upgrade \-\-set pwd=3jk$o2,z=f\\30.e redis ./redis
    74  
    75  .fi
    76  .RE
    77  
    78  .PP
    79  results in "pwd: 3jk" and "z: f30.e". Use single quotes to avoid shell evaluation and argument delimiters,
    80  and use backslash to escape yaml special characters:
    81  
    82  .PP
    83  .RS
    84  
    85  .nf
    86  $ helm upgrade \-\-set pwd='3jk$o2z=f\\\\30.e' redis ./redis
    87  
    88  .fi
    89  .RE
    90  
    91  .PP
    92  which results in the expected "pwd: 3jk$o2z=f\\30.e". If a single quote occurs in your value then follow
    93  your shell convention for escaping it; for example in bash:
    94  
    95  .PP
    96  .RS
    97  
    98  .nf
    99  $ helm upgrade \-\-set pwd='3jk$o2z=f\\\\30with'\\''quote'
   100  
   101  .fi
   102  .RE
   103  
   104  .PP
   105  which results in "pwd: 3jk$o2z=f\\30with'quote".
   106  
   107  
   108  .SH OPTIONS
   109  .PP
   110  \fB\-\-ca\-file\fP=""
   111      verify certificates of HTTPS\-enabled servers using this CA bundle
   112  
   113  .PP
   114  \fB\-\-cert\-file\fP=""
   115      identify HTTPS client using this SSL certificate file
   116  
   117  .PP
   118  \fB\-\-description\fP=""
   119      specify the description to use for the upgrade, rather than the default
   120  
   121  .PP
   122  \fB\-\-devel\fP[=false]
   123      use development versions, too. Equivalent to version '>0.0.0\-0'. If \-\-version is set, this is ignored.
   124  
   125  .PP
   126  \fB\-\-dry\-run\fP[=false]
   127      simulate an upgrade
   128  
   129  .PP
   130  \fB\-\-force\fP[=false]
   131      force resource update through delete/recreate if needed
   132  
   133  .PP
   134  \fB\-h\fP, \fB\-\-help\fP[=false]
   135      help for upgrade
   136  
   137  .PP
   138  \fB\-i\fP, \fB\-\-install\fP[=false]
   139      if a release by this name doesn't already exist, run an install
   140  
   141  .PP
   142  \fB\-\-key\-file\fP=""
   143      identify HTTPS client using this SSL key file
   144  
   145  .PP
   146  \fB\-\-keyring\fP="/Users/grapevine/.gnupg/pubring.gpg"
   147      path to the keyring that contains public signing keys
   148  
   149  .PP
   150  \fB\-\-namespace\fP=""
   151      namespace to install the release into (only used if \-\-install is set). Defaults to the current kube config namespace
   152  
   153  .PP
   154  \fB\-\-no\-hooks\fP[=false]
   155      disable pre/post upgrade hooks
   156  
   157  .PP
   158  \fB\-\-password\fP=""
   159      chart repository password where to locate the requested chart
   160  
   161  .PP
   162  \fB\-\-recreate\-pods\fP[=false]
   163      performs pods restart for the resource if applicable
   164  
   165  .PP
   166  \fB\-\-repo\fP=""
   167      chart repository url where to locate the requested chart
   168  
   169  .PP
   170  \fB\-\-reset\-values\fP[=false]
   171      when upgrading, reset the values to the ones built into the chart
   172  
   173  .PP
   174  \fB\-\-reuse\-values\fP[=false]
   175      when upgrading, reuse the last release's values and merge in any overrides from the command line via \-\-set and \-f. If '\-\-reset\-values' is specified, this is ignored.
   176  
   177  .PP
   178  \fB\-\-set\fP=[]
   179      set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
   180  
   181  .PP
   182  \fB\-\-set\-file\fP=[]
   183      set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
   184  
   185  .PP
   186  \fB\-\-set\-string\fP=[]
   187      set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
   188  
   189  .PP
   190  \fB\-\-timeout\fP=300
   191      time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)
   192  
   193  .PP
   194  \fB\-\-tls\fP[=false]
   195      enable TLS for request
   196  
   197  .PP
   198  \fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
   199      path to TLS CA certificate file
   200  
   201  .PP
   202  \fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
   203      path to TLS certificate file
   204  
   205  .PP
   206  \fB\-\-tls\-hostname\fP=""
   207      the server name used to verify the hostname on the returned certificates from the server
   208  
   209  .PP
   210  \fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
   211      path to TLS key file
   212  
   213  .PP
   214  \fB\-\-tls\-verify\fP[=false]
   215      enable TLS for request and verify remote
   216  
   217  .PP
   218  \fB\-\-username\fP=""
   219      chart repository username where to locate the requested chart
   220  
   221  .PP
   222  \fB\-f\fP, \fB\-\-values\fP=[]
   223      specify values in a YAML file or a URL(can specify multiple)
   224  
   225  .PP
   226  \fB\-\-verify\fP[=false]
   227      verify the provenance of the chart before upgrading
   228  
   229  .PP
   230  \fB\-\-version\fP=""
   231      specify the exact chart version to use. If this is not specified, the latest version is used
   232  
   233  .PP
   234  \fB\-\-wait\fP[=false]
   235      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
   236  
   237  
   238  .SH OPTIONS INHERITED FROM PARENT COMMANDS
   239  .PP
   240  \fB\-\-debug\fP[=false]
   241      enable verbose output
   242  
   243  .PP
   244  \fB\-\-home\fP="/Users/grapevine/.helm"
   245      location of your Helm config. Overrides $HELM\_HOME
   246  
   247  .PP
   248  \fB\-\-host\fP=""
   249      address of Tiller. Overrides $HELM\_HOST
   250  
   251  .PP
   252  \fB\-\-kube\-context\fP=""
   253      name of the kubeconfig context to use
   254  
   255  .PP
   256  \fB\-\-kubeconfig\fP=""
   257      absolute path to the kubeconfig file to use
   258  
   259  .PP
   260  \fB\-\-tiller\-connection\-timeout\fP=300
   261      the duration (in seconds) Helm will wait to establish a connection to tiller
   262  
   263  .PP
   264  \fB\-\-tiller\-namespace\fP="kube\-system"
   265      namespace of Tiller
   266  
   267  
   268  .SH SEE ALSO
   269  .PP
   270  \fBhelm(1)\fP
   271  
   272  
   273  .SH HISTORY
   274  .PP
   275  24\-Aug\-2018 Auto generated by spf13/cobra