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

fix(cmd): clean up helpstring formatting

Browse Source 
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
pull/6806/head
Matthew Fisher 5 years ago
parent ce494146a4
commit e2233bb571
No known key found for this signature in database
GPG Key ID: 92AA783CBAAE8E3B
12 changed files with 42 additions and 50 deletions
Show Stats Download Patch File Download Diff File

4
cmd/helm/chart.go
Unescape View File

@ -26,9 +26,7 @@ import (
const chartHelp = ` const chartHelp = `
This command consists of multiple subcommands to work with the chart cache. This command consists of multiple subcommands to work with the chart cache.
It can be used to push, pull, tag, list, or remove Helm charts. The subcommands can be used to push, pull, tag, list, or remove Helm charts.
Example usage:
$ helm chart pull [URL]
` `
func newChartCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newChartCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

4
cmd/helm/completion.go
Unescape View File

@ -30,11 +30,11 @@ Generate autocompletions script for Helm for the specified shell (bash or zsh).
This command can generate shell autocompletions. e.g. This command can generate shell autocompletions. e.g.
$ helm completion bash $ helm completion bash
Can be sourced as such Can be sourced as such
$ source <(helm completion bash) $ source <(helm completion bash)
` `
var ( var (

2
cmd/helm/docs.go
Unescape View File

@ -35,8 +35,6 @@ This command can generate documentation for Helm in the following formats:
- Man pages - Man pages
It can also generate bash autocompletions. It can also generate bash autocompletions.
$ helm docs markdown -dir mydocs/
` `
type docsOptions struct { type docsOptions struct {

8
cmd/helm/get.go
Unescape View File

@ -29,10 +29,10 @@ var getHelp = `
This command consists of multiple subcommands which can be used to This command consists of multiple subcommands which can be used to
get extended information about the release, including: get extended information about the release, including:
- The values used to generate the release - The values used to generate the release
- The generated manifest file - The generated manifest file
- The notes provided by the chart of the release - The notes provided by the chart of the release
- The hooks associated with the release - The hooks associated with the release
` `
func newGetCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newGetCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

2
cmd/helm/history.go
Unescape View File

@ -41,7 +41,7 @@ configures the maximum length of the revision list returned.
The historical release set is printed as a formatted table, e.g: The historical release set is printed as a formatted table, e.g:
$ helm history angry-bird --max=4 $ helm history angry-bird
REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION
1 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Initial install 1 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Initial install
2 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Upgraded successfully 2 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Upgraded successfully

16
cmd/helm/install.go
Unescape View File

@ -47,30 +47,30 @@ a string value use '--set-string'. In case a value is large and therefore
you want not to use neither '--values' nor '--set', use '--set-file' to read the you want not to use neither '--values' nor '--set', use '--set-file' to read the
single large value from file. single large value from file.
$ helm install -f myvalues.yaml myredis ./redis $ helm install -f myvalues.yaml myredis ./redis
or or
$ helm install --set name=prod myredis ./redis $ helm install --set name=prod myredis ./redis
or or
$ helm install --set-string long_int=1234567890 myredis ./redis $ helm install --set-string long_int=1234567890 myredis ./redis
or or
$ helm install --set-file my_script=dothings.sh myredis ./redis $ helm install --set-file my_script=dothings.sh myredis ./redis
You can specify the '--values'/'-f' flag multiple times. The priority will be given to the You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence: contained a key called 'Test', the value set in override.yaml would take precedence:
$ helm install -f myvalues.yaml -f override.yaml myredis ./redis $ helm install -f myvalues.yaml -f override.yaml myredis ./redis
You can specify the '--set' flag multiple times. The priority will be given to the You can specify the '--set' flag multiple times. The priority will be given to the
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence: set for a key called 'foo', the 'newbar' value would take precedence:
$ helm install --set foo=bar --set foo=newbar myredis ./redis $ helm install --set foo=bar --set foo=newbar myredis ./redis
To check the generated manifests of a release without installing the chart, To check the generated manifests of a release without installing the chart,
@ -93,8 +93,8 @@ A chart reference is a convenient way of referencing a chart in a chart reposito
When you use a chart reference with a repo prefix ('example/mariadb'), Helm will look in the local When you use a chart reference with a repo prefix ('example/mariadb'), Helm will look in the local
configuration for a chart repository named 'example', and will then look for a configuration for a chart repository named 'example', and will then look for a
chart in that repository whose name is 'mariadb'. It will install the latest stable version of that chart chart in that repository whose name is 'mariadb'. It will install the latest stable version of that chart
until you specify '--devel' flag to also include development version (alpha, beta, and release candidate releases), or until you specify '--devel' flag to also include development version (alpha, beta, and release candidate releases), or
supply a version number with the '--version' flag. supply a version number with the '--version' flag.
To see the list of chart repositories, use 'helm repo list'. To search for To see the list of chart repositories, use 'helm repo list'. To search for

6
cmd/helm/list.go
Unescape View File

@ -45,9 +45,9 @@ If the --filter flag is provided, it will be treated as a filter. Filters are
regular expressions (Perl compatible) that are applied to the list of releases. regular expressions (Perl compatible) that are applied to the list of releases.
Only items that match the filter will be returned. Only items that match the filter will be returned.
$ helm list --filter 'ara[a-z]+' $ helm list --filter 'ara[a-z]+'
NAME UPDATED CHART NAME UPDATED CHART
maudlin-arachnid Mon May 9 16:07:08 2016 alpine-0.1.0 maudlin-arachnid Mon May 9 16:07:08 2016 alpine-0.1.0
If no results are found, 'helm list' will exit 0, but with no output (or in If no results are found, 'helm list' will exit 0, but with no output (or in
the case of no '-q' flag, only headers). the case of no '-q' flag, only headers).

3
cmd/helm/plugin_install.go
Unescape View File

@ -33,9 +33,6 @@ type pluginInstallOptions struct {
const pluginInstallDesc = ` const pluginInstallDesc = `
This command allows you to install a plugin from a url to a VCS repo or a local path. This command allows you to install a plugin from a url to a VCS repo or a local path.
Example usage:
$ helm plugin install https://github.com/technosophos/helm-template
` `
func newPluginInstallCmd(out io.Writer) *cobra.Command { func newPluginInstallCmd(out io.Writer) *cobra.Command {

4
cmd/helm/registry.go
Unescape View File

@ -25,10 +25,6 @@ import (
const registryHelp = ` const registryHelp = `
This command consists of multiple subcommands to interact with registries. This command consists of multiple subcommands to interact with registries.
It can be used to login to or logout from a registry.
Example usage:
$ helm registry login [URL]
` `
func newRegistryCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newRegistryCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

2
cmd/helm/repo.go
Unescape View File

@ -30,8 +30,6 @@ var repoHelm = `
This command consists of multiple subcommands to interact with chart repositories. This command consists of multiple subcommands to interact with chart repositories.
It can be used to add, remove, list, and index chart repositories. It can be used to add, remove, list, and index chart repositories.
Example usage:
$ helm repo add [NAME] [REPO_URL]
` `
func newRepoCmd(out io.Writer) *cobra.Command { func newRepoCmd(out io.Writer) *cobra.Command {

37
cmd/helm/root.go
Unescape View File

@ -282,14 +282,14 @@ __helm_custom_func()
__helm_list_releases __helm_list_releases
return return
;; ;;
helm_repo_remove) helm_repo_remove)
__helm_list_repos __helm_list_repos
return return
;; ;;
helm_plugin_remove | helm_plugin_update) helm_plugin_remove | helm_plugin_update)
__helm_list_plugins __helm_list_plugins
return return
;; ;;
*) *)
;; ;;
esac esac
@ -311,17 +311,22 @@ var globalUsage = `The Kubernetes package manager
Common actions for Helm: Common actions for Helm:
- helm search: search for charts - helm search: search for charts
- helm fetch: download a chart to your local directory to view - helm pull: download a chart to your local directory to view
- helm install: upload the chart to Kubernetes - helm install: upload the chart to Kubernetes
- helm list: list releases of charts - helm list: list releases of charts
Environment: Environment variables:
$XDG_CACHE_HOME set an alternative location for storing cached files.
$XDG_CONFIG_HOME set an alternative location for storing Helm configuration. +------------------+-----------------------------------------------------------------------------+
$XDG_DATA_HOME set an alternative location for storing Helm data. | Name | Description |
$HELM_DRIVER set the backend storage driver. Values are: configmap, secret, memory +------------------+-----------------------------------------------------------------------------+
$HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. | $XDG_CACHE_HOME | set an alternative location for storing cached files. |
$KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config") | $XDG_CONFIG_HOME | set an alternative location for storing Helm configuration. |
| $XDG_DATA_HOME | set an alternative location for storing Helm data. |
| $HELM_DRIVER | set the backend storage driver. Values are: configmap, secret, memory |
| $HELM_NO_PLUGINS | disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. |
| $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") |
+------------------+-----------------------------------------------------------------------------+
Helm stores configuration based on the XDG base directory specification, so Helm stores configuration based on the XDG base directory specification, so

4
cmd/helm/upgrade.go
Unescape View File

@ -51,13 +51,13 @@ You can specify the '--values'/'-f' flag multiple times. The priority will be gi
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence: contained a key called 'Test', the value set in override.yaml would take precedence:
$ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis
You can specify the '--set' flag multiple times. The priority will be given to the You can specify the '--set' flag multiple times. The priority will be given to the
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence: set for a key called 'foo', the 'newbar' value would take precedence:
$ helm upgrade --set foo=bar --set foo=newbar redis ./redis $ helm upgrade --set foo=bar --set foo=newbar redis ./redis
` `
func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

Write Preview
Loading…
Cancel
Save