From c4d6b5a434bf87c33e5fd0ad5679af015c924844 Mon Sep 17 00:00:00 2001 From: smurfralf Date: Fri, 24 Aug 2018 14:40:30 -0400 Subject: [PATCH] Tweeks per bacon review --- cmd/helm/upgrade.go | 8 +++---- docs/helm/helm_upgrade.md | 10 ++++----- docs/man/man1/helm_upgrade.1 | 41 +++++++++++++++++++++++------------- 3 files changed, 35 insertions(+), 24 deletions(-) diff --git a/cmd/helm/upgrade.go b/cmd/helm/upgrade.go index 55ed63c13..23875289c 100644 --- a/cmd/helm/upgrade.go +++ b/cmd/helm/upgrade.go @@ -37,17 +37,17 @@ Required arguments are release and chart. The chart argument can be one of: - a packaged chart, - 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, - '--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-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. 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 (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 - 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 shell evaluation followed by yaml type parsing to produce the final value. This may alter inputs with diff --git a/docs/helm/helm_upgrade.md b/docs/helm/helm_upgrade.md index 6dcb25387..f18bcf6a7 100644 --- a/docs/helm/helm_upgrade.md +++ b/docs/helm/helm_upgrade.md @@ -13,17 +13,17 @@ Required arguments are release and chart. The chart argument can be one of: - a packaged chart, - 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, - '--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-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. 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 (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 - 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 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. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Aug-2018 diff --git a/docs/man/man1/helm_upgrade.1 b/docs/man/man1/helm_upgrade.1 index 202f3d8c1..602c3136f 100644 --- a/docs/man/man1/helm_upgrade.1 +++ b/docs/man/man1/helm_upgrade.1 @@ -8,13 +8,12 @@ helm\-upgrade \- upgrade a release .SH SYNOPSIS .PP -\fBhelm upgrade [RELEASE] [CHART]\fP +\fBhelm upgrade [RELEASE] [CHART] [flags]\fP .SH DESCRIPTION .PP -This command upgrades a release to a specified version of a chart -and/or updates chart values. +This command upgrades a release to a specified version of a chart and/or updates chart values. .PP 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. .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, \- '\-\-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\-file' to provide key=path to read a single large value from a file at path. .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. .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 -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 .RS @@ -50,16 +52,19 @@ $ helm upgrade \-f myvalues.yaml \-f override.yaml redis ./redis .RE .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 \- livenessProbe.timeoutSeconds=10 \- metrics.annotations[0]=hey,metrics.annotations[1]=ho .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 -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 .RS @@ -71,7 +76,8 @@ $ helm upgrade \-\-set pwd=3jk$o2,z=f\\30.e redis ./redis .RE .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 .RS @@ -83,7 +89,8 @@ $ helm upgrade \-\-set pwd='3jk$o2z=f\\\\30.e' redis ./redis .RE .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 .RS @@ -123,6 +130,10 @@ which results in "pwd: 3jk$o2z=f\\30with'quote". \fB\-\-force\fP[=false] force resource update through delete/recreate if needed +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for upgrade + .PP \fB\-i\fP, \fB\-\-install\fP[=false] 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 .PP -\fB\-\-keyring\fP="~/.gnupg/pubring.gpg" +\fB\-\-keyring\fP="/Users/grapevine/.gnupg/pubring.gpg" path to the keyring that contains public signing keys .PP @@ -230,7 +241,7 @@ which results in "pwd: 3jk$o2z=f\\30with'quote". enable verbose output .PP -\fB\-\-home\fP="~/.helm" +\fB\-\-home\fP="/Users/grapevine/.helm" location of your Helm config. Overrides $HELM\_HOME .PP @@ -261,4 +272,4 @@ which results in "pwd: 3jk$o2z=f\\30with'quote". .SH HISTORY .PP -17\-Aug\-2018 Auto generated by spf13/cobra +24\-Aug\-2018 Auto generated by spf13/cobra