msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

Tweeks per bacon review

Browse Source
pull/4486/head
smurfralf 6 years ago
parent eeb3a1454a
commit c4d6b5a434
3 changed files with 35 additions and 24 deletions
Show Stats Download Patch File Download Diff File

8
cmd/helm/upgrade.go
Unescape View File

@ -37,17 +37,17 @@ Required arguments are release and chart. The chart argument can be one of:
- a packaged chart, - a packaged chart,
- a fully qualified URL. - a fully qualified URL.
To customize the chart values use any of To customize the chart values, use any of
- '--values'/'-f' to pass in a yaml file holding settings, - '--values'/'-f' to pass in a yaml file holding settings,
- '--set' to provide one or more key=val pairs directly, - '--set' to provide one or more key=val pairs directly,
- '--set-string' to provide key=val forcing val to be stored as a string, - '--set-string' to provide key=val forcing val to be stored as a string,
- '--set-file' to provide key=path to read a single large value from a file at path. - '--set-file' to provide key=path to read a single large value from a file at path.
To edit or append to the existing customized values add the To edit or append to the existing customized values, add the
'--reuse-values' flag, otherwise any existing customized values are ignored. '--reuse-values' flag, otherwise any existing customized values are ignored.
If no chart value arguments are provided on the command line, any existing customized values are carried If no chart value arguments are provided on the command line, any existing customized values are carried
forward. To revert to use only values provided in the chart, use the '--reset-values' flag. forward. If you want to revert to just the values provided in the chart, use the '--reset-values' flag.
You can specify any of the chart value flags multiple times. The priority will be given to the last You can specify any of the chart value flags multiple times. The priority will be given to the last
(right-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key (right-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key
@ -61,7 +61,7 @@ structure elements. Examples:
- livenessProbe.timeoutSeconds=10 - livenessProbe.timeoutSeconds=10
- metrics.annotations[0]=hey,metrics.annotations[1]=ho - metrics.annotations[0]=hey,metrics.annotations[1]=ho
which sets the top level key mybool to true, the nested timeoutSeconds to 10 and two array values respectively. which sets the top level key mybool to true, the nested timeoutSeconds to 10, and two array values, respectively.
Note that the value side of the key=val provided to '--set' and '--set-string' flags will pass through Note that the value side of the key=val provided to '--set' and '--set-string' flags will pass through
shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with

10
docs/helm/helm_upgrade.md
Unescape View File

@ -13,17 +13,17 @@ Required arguments are release and chart. The chart argument can be one of:
- a packaged chart, - a packaged chart,
- a fully qualified URL. - a fully qualified URL.
To customize the chart values use any of To customize the chart values, use any of
- '--values'/'-f' to pass in a yaml file holding settings, - '--values'/'-f' to pass in a yaml file holding settings,
- '--set' to provide one or more key=val pairs directly, - '--set' to provide one or more key=val pairs directly,
- '--set-string' to provide key=val forcing val to be stored as a string, - '--set-string' to provide key=val forcing val to be stored as a string,
- '--set-file' to provide key=path to read a single large value from a file at path. - '--set-file' to provide key=path to read a single large value from a file at path.
To edit or append to the existing customized values add the To edit or append to the existing customized values, add the
'--reuse-values' flag, otherwise any existing customized values are ignored. '--reuse-values' flag, otherwise any existing customized values are ignored.
If no chart value arguments are provided on the command line, any existing customized values are carried If no chart value arguments are provided on the command line, any existing customized values are carried
forward. To revert to use only values provided in the chart, use the '--reset-values' flag. forward. If you want to revert to just the values provided in the chart, use the '--reset-values' flag.
You can specify any of the chart value flags multiple times. The priority will be given to the last You can specify any of the chart value flags multiple times. The priority will be given to the last
(right-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key (right-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key
@ -37,7 +37,7 @@ structure elements. Examples:
- livenessProbe.timeoutSeconds=10 - livenessProbe.timeoutSeconds=10
- metrics.annotations[0]=hey,metrics.annotations[1]=ho - metrics.annotations[0]=hey,metrics.annotations[1]=ho
which sets the top level key mybool to true, the nested timeoutSeconds to 10 and two array values respectively. which sets the top level key mybool to true, the nested timeoutSeconds to 10, and two array values, respectively.
Note that the value side of the key=val provided to '--set' and '--set-string' flags will pass through Note that the value side of the key=val provided to '--set' and '--set-string' flags will pass through
shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with
@ -115,4 +115,4 @@ helm upgrade [RELEASE] [CHART] [flags]
* [helm](helm.md) - The Helm package manager for Kubernetes. * [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 17-Aug-2018 ###### Auto generated by spf13/cobra on 24-Aug-2018

41
docs/man/man1/helm_upgrade.1
Unescape View File

@ -8,13 +8,12 @@ helm\-upgrade \- upgrade a release
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBhelm upgrade [RELEASE] [CHART]\fP \fBhelm upgrade [RELEASE] [CHART] [flags]\fP
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This command upgrades a release to a specified version of a chart This command upgrades a release to a specified version of a chart and/or updates chart values.
and/or updates chart values.
.PP .PP
Required arguments are release and chart. The chart argument can be one of: Required arguments are release and chart. The chart argument can be one of:
@ -24,21 +23,24 @@ Required arguments are release and chart. The chart argument can be one of:
\- a fully qualified URL. \- a fully qualified URL.
.PP .PP
To customize the chart values use any of To customize the chart values, use any of
\- '\-\-values'/'\-f' to pass in a yaml file holding settings, \- '\-\-values'/'\-f' to pass in a yaml file holding settings,
\- '\-\-set' to provide one or more key=val pairs directly, \- '\-\-set' to provide one or more key=val pairs directly,
\- '\-\-set\-string' to provide key=val forcing val to be stored as a string, \- '\-\-set\-string' to provide key=val forcing val to be stored as a string,
\- '\-\-set\-file' to provide key=path to read a single large value from a file at path. \- '\-\-set\-file' to provide key=path to read a single large value from a file at path.
.PP .PP
To edit or append to the existing customized values add the To edit or append to the existing customized values, add the
'\-\-reuse\-values' flag, otherwise any existing customized values are ignored. '\-\-reuse\-values' flag, otherwise any existing customized values are ignored.
.PP .PP
If no chart value arguments are provided on the command line, any existing customized values are carried forward. To revert to use only values provided in the chart, use the '\-\-reset\-values' flag. If no chart value arguments are provided on the command line, any existing customized values are carried
forward. If you want to revert to just the values provided in the chart, use the '\-\-reset\-values' flag.
.PP .PP
You can specify any of the chart value flags multiple times. The priority will be given to the last (right\-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key called 'Test', the value set in override.yaml would take precedence: You can specify any of the chart value flags multiple times. The priority will be given to the last
(right\-most) value specified. For example, if both myvalues.yaml and override.yaml contained a key
called 'Test', the value set in override.yaml would take precedence:
.PP .PP
.RS .RS
@ -50,16 +52,19 @@ $ helm upgrade \-f myvalues.yaml \-f override.yaml redis ./redis
.RE .RE
.PP .PP
Note that the key name provided to the '\-\-set', '\-\-set\-string' and '\-\-set\-file' flags can reference structure elements. Examples: Note that the key name provided to the '\-\-set', '\-\-set\-string' and '\-\-set\-file' flags can reference
structure elements. Examples:
\- mybool=TRUE \- mybool=TRUE
\- livenessProbe.timeoutSeconds=10 \- livenessProbe.timeoutSeconds=10
\- metrics.annotations[0]=hey,metrics.annotations[1]=ho \- metrics.annotations[0]=hey,metrics.annotations[1]=ho
.PP .PP
which sets the top level key mybool to true, the nested timeoutSeconds to 10 and two array values respectively. which sets the top level key mybool to true, the nested timeoutSeconds to 10, and two array values, respectively.
.PP .PP
Note that the value side of the key=val provided to '\-\-set' and '\-\-set\-string' flags will pass through shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with special characters in unexpected ways, for example Note that the value side of the key=val provided to '\-\-set' and '\-\-set\-string' flags will pass through
shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with
special characters in unexpected ways, for example
.PP .PP
.RS .RS
@ -71,7 +76,8 @@ $ helm upgrade \-\-set pwd=3jk$o2,z=f\\30.e redis ./redis
.RE .RE
.PP .PP
results in "pwd: 3jk" and "z: f30.e". Use single quotes to avoid shell evaulation and argument delimiters, and use backslash to escape yaml special characters: results in "pwd: 3jk" and "z: f30.e". Use single quotes to avoid shell evaluation and argument delimiters,
and use backslash to escape yaml special characters:
.PP .PP
.RS .RS
@ -83,7 +89,8 @@ $ helm upgrade \-\-set pwd='3jk$o2z=f\\\\30.e' redis ./redis
.RE .RE
.PP .PP
which results in the expected "pwd: 3jk$o2z=f\\30.e". If a single quote occurs in your value then follow your shell convention for escaping it; for example in bash: which results in the expected "pwd: 3jk$o2z=f\\30.e". If a single quote occurs in your value then follow
your shell convention for escaping it; for example in bash:
.PP .PP
.RS .RS
@ -123,6 +130,10 @@ which results in "pwd: 3jk$o2z=f\\30with'quote".
\fB\-\-force\fP[=false] \fB\-\-force\fP[=false]
force resource update through delete/recreate if needed force resource update through delete/recreate if needed
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for upgrade
.PP .PP
\fB\-i\fP, \fB\-\-install\fP[=false] \fB\-i\fP, \fB\-\-install\fP[=false]
if a release by this name doesn't already exist, run an install if a release by this name doesn't already exist, run an install
@ -132,7 +143,7 @@ which results in "pwd: 3jk$o2z=f\\30with'quote".
identify HTTPS client using this SSL key file identify HTTPS client using this SSL key file
.PP .PP
\fB\-\-keyring\fP="~/.gnupg/pubring.gpg" \fB\-\-keyring\fP="/Users/grapevine/.gnupg/pubring.gpg"
path to the keyring that contains public signing keys path to the keyring that contains public signing keys
.PP .PP
@ -230,7 +241,7 @@ which results in "pwd: 3jk$o2z=f\\30with'quote".
enable verbose output enable verbose output
.PP .PP
\fB\-\-home\fP="~/.helm" \fB\-\-home\fP="/Users/grapevine/.helm"
location of your Helm config. Overrides $HELM\_HOME location of your Helm config. Overrides $HELM\_HOME
.PP .PP
@ -261,4 +272,4 @@ which results in "pwd: 3jk$o2z=f\\30with'quote".
.SH HISTORY .SH HISTORY
.PP .PP
17\-Aug\-2018 Auto generated by spf13/cobra 24\-Aug\-2018 Auto generated by spf13/cobra

Write Preview
Loading…
Cancel
Save