From 5884124294c43396d97e9d6e291320327a28e762 Mon Sep 17 00:00:00 2001 From: Michelle Noorali Date: Mon, 20 Nov 2017 10:01:15 -0500 Subject: [PATCH] ref(docs): update plugin install documentation --- cmd/helm/plugin_install.go | 8 ++++++++ docs/helm/helm_plugin_install.md | 9 +++++++-- docs/plugins.md | 5 ++--- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/cmd/helm/plugin_install.go b/cmd/helm/plugin_install.go index aa75770fc..f36178808 100644 --- a/cmd/helm/plugin_install.go +++ b/cmd/helm/plugin_install.go @@ -33,11 +33,19 @@ type pluginInstallCmd struct { out io.Writer } +const pluginInstallDesc = ` +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 { pcmd := &pluginInstallCmd{out: out} cmd := &cobra.Command{ Use: "install [options] ...", Short: "install one or more Helm plugins", + Long: pluginInstallDesc, PreRunE: func(cmd *cobra.Command, args []string) error { return pcmd.complete(args) }, diff --git a/docs/helm/helm_plugin_install.md b/docs/helm/helm_plugin_install.md index 1b1e03ea7..f93378b7b 100644 --- a/docs/helm/helm_plugin_install.md +++ b/docs/helm/helm_plugin_install.md @@ -5,7 +5,12 @@ install one or more Helm plugins ### Synopsis -install one or more Helm plugins + +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 + ``` helm plugin install [options] ... @@ -31,4 +36,4 @@ helm plugin install [options] ... ### SEE ALSO * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 7-Nov-2017 +###### Auto generated by spf13/cobra on 20-Nov-2017 diff --git a/docs/plugins.md b/docs/plugins.md index 1bee8bd56..5d7e4f622 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -31,11 +31,10 @@ plugins do the "detail work" of performing a desired action. ## Installing a Plugin -A Helm plugin management system is in the works. But in the short term, plugins -are installed by copying the plugin directory into `$(helm home)/plugins`. +Plugins are installed using the `$ helm plugin install command. You can pass in a path to a plugin on your local file system or a url of a remote VCS repo. The `helm plugin install` command clones or copies the plugin at the path/url given into `$ (helm home)/plugins` ```console -$ cp -a myplugin/ $(helm home)/plugins/ +$ helm plugin install https://github.com/technosophos/helm-template ``` If you have a plugin tar distribution, simply untar the plugin into the