helm
/
helm
mirror of https://github.com/helm/helm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Correct punctuation and capitalization for user facing strings.

This commit is contained in:
Justin Scott 2017-06-20 17:40:10 -07:00
parent 56ed16aeca
commit af4c243ee3
63 changed files with 246 additions and 246 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/helm/delete.go
View File

@ -80,7 +80,7 @@ func newDeleteCmd(c helm.Interface, out io.Writer) *cobra.Command {
f.BoolVar(&del.dryRun, "dry-run", false, "simulate a delete")
f.BoolVar(&del.disableHooks, "no-hooks", false, "prevent hooks from running during deletion")
f.BoolVar(&del.purge, "purge", false, "remove the release from the store and make its name free for later use")
f.Int64Var(&del.timeout, "timeout", 300, "time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)")
f.Int64Var(&del.timeout, "timeout", 300, "time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)")
return cmd
}

4
cmd/helm/helm.go
View File

@ -93,10 +93,10 @@ func setFlagsFromEnv(flags map[string]string, cmd *cobra.Command) {
func addRootFlags(cmd *cobra.Command) {
pf := cmd.PersistentFlags()
pf.StringVar((*string)(&settings.Home), "home", helm_env.DefaultHelmHome, "location of your Helm config. Overrides $HELM_HOME")
pf.StringVar(&settings.TillerHost, "host", "", "address of tiller. Overrides $HELM_HOST")
pf.StringVar(&settings.TillerHost, "host", "", "address of Tiller. Overrides $HELM_HOST")
pf.StringVar(&kubeContext, "kube-context", "", "name of the kubeconfig context to use")
pf.BoolVar(&settings.Debug, "debug", false, "enable verbose output")
pf.StringVar(&settings.TillerNamespace, "tiller-namespace", tiller_env.DefaultTillerNamespace, "namespace of tiller")
pf.StringVar(&settings.TillerNamespace, "tiller-namespace", tiller_env.DefaultTillerNamespace, "namespace of Tiller")
}
func initRootFlags(cmd *cobra.Command) {

34
cmd/helm/init.go
View File

@ -33,14 +33,14 @@ import (
)
const initDesc = `
This command installs Tiller (the helm server side component) onto your
Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/)
This command installs Tiller (the Helm server-side component) onto your
Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/).
As with the rest of the Helm commands, 'helm init' discovers Kubernetes clusters
by reading $KUBECONFIG (default '~/.kube/config') and using the default context.
To set up just a local environment, use '--client-only'. That will configure
$HELM_HOME, but not attempt to connect to a remote cluster and install the Tiller
$HELM_HOME, but not attempt to connect to a Kubernetes cluster and install the Tiller
deployment.
When installing Tiller, 'helm init' will attempt to install the latest released
@ -101,23 +101,23 @@ func newInitCmd(out io.Writer) *cobra.Command {
}
f := cmd.Flags()
f.StringVarP(&i.image, "tiller-image", "i", "", "override tiller image")
f.BoolVar(&i.canary, "canary-image", false, "use the canary tiller image")
f.BoolVar(&i.upgrade, "upgrade", false, "upgrade if tiller is already installed")
f.BoolVarP(&i.clientOnly, "client-only", "c", false, "if set does not install tiller")
f.StringVarP(&i.image, "tiller-image", "i", "", "override Tiller image")
f.BoolVar(&i.canary, "canary-image", false, "use the canary Tiller image")
f.BoolVar(&i.upgrade, "upgrade", false, "upgrade if Tiller is already installed")
f.BoolVarP(&i.clientOnly, "client-only", "c", false, "if set does not install Tiller")
f.BoolVar(&i.dryRun, "dry-run", false, "do not install local or remote")
f.BoolVar(&i.skipRefresh, "skip-refresh", false, "do not refresh (download) the local repository cache")
f.BoolVar(&tlsEnable, "tiller-tls", false, "install tiller with TLS enabled")
f.BoolVar(&tlsVerify, "tiller-tls-verify", false, "install tiller with TLS enabled and to verify remote certificates")
f.StringVar(&tlsKeyFile, "tiller-tls-key", "", "path to TLS key file to install with tiller")
f.StringVar(&tlsCertFile, "tiller-tls-cert", "", "path to TLS certificate file to install with tiller")
f.BoolVar(&tlsEnable, "tiller-tls", false, "install Tiller with TLS enabled")
f.BoolVar(&tlsVerify, "tiller-tls-verify", false, "install Tiller with TLS enabled and to verify remote certificates")
f.StringVar(&tlsKeyFile, "tiller-tls-key", "", "path to TLS key file to install with Tiller")
f.StringVar(&tlsCertFile, "tiller-tls-cert", "", "path to TLS certificate file to install with Tiller")
f.StringVar(&tlsCaCertFile, "tls-ca-cert", "", "path to CA root certificate")
f.StringVar(&stableRepositoryURL, "stable-repo-url", stableRepositoryURL, "URL for stable repository")
f.StringVar(&localRepositoryURL, "local-repo-url", localRepositoryURL, "URL for local repository")
f.BoolVar(&i.opts.EnableHostNetwork, "net-host", false, "install tiller with net=host")
f.BoolVar(&i.opts.EnableHostNetwork, "net-host", false, "install Tiller with net=host")
f.StringVar(&i.serviceAccount, "service-account", "", "name of service account")
return cmd
@ -149,7 +149,7 @@ func (i *initCmd) tlsOptions() error {
return nil
}
// runInit initializes local config and installs tiller to Kubernetes Cluster
// run initializes local config and installs Tiller to Kubernetes cluster.
func (i *initCmd) run() error {
if err := i.tlsOptions(); err != nil {
return err
@ -246,23 +246,23 @@ func (i *initCmd) run() error {
if err := installer.Upgrade(i.kubeClient, &i.opts); err != nil {
return fmt.Errorf("error when upgrading: %s", err)
}
fmt.Fprintln(i.out, "\nTiller (the helm server side component) has been upgraded to the current version.")
fmt.Fprintln(i.out, "\nTiller (the helm server-side component) has been upgraded to the current version.")
} else {
fmt.Fprintln(i.out, "Warning: Tiller is already installed in the cluster.\n"+
"(Use --client-only to suppress this message, or --upgrade to upgrade Tiller to the current version.)")
}
} else {
fmt.Fprintln(i.out, "\nTiller (the helm server side component) has been installed into your Kubernetes Cluster.")
fmt.Fprintln(i.out, "\nTiller (the helm server-side component) has been installed into your Kubernetes Cluster.")
}
} else {
fmt.Fprintln(i.out, "Not installing tiller due to 'client-only' flag having been set")
fmt.Fprintln(i.out, "Not installing Tiller due to 'client-only' flag having been set")
}
fmt.Fprintln(i.out, "Happy Helming!")
return nil
}
// ensureDirectories checks to see if $HELM_HOME exists
// ensureDirectories checks to see if $HELM_HOME exists.
//
// If $HELM_HOME does not exist, this function will create it.
func ensureDirectories(home helmpath.Home, out io.Writer) error {

2
cmd/helm/init_test.go
View File

@ -128,7 +128,7 @@ func TestInitCmd_clientOnly(t *testing.T) {
if len(fc.Actions()) != 0 {
t.Error("expected client call")
}
expected := "Not installing tiller due to 'client-only' flag having been set"
expected := "Not installing Tiller due to 'client-only' flag having been set"
if !strings.Contains(buf.String(), expected) {
t.Errorf("expected %q, got %q", expected, buf.String())
}

2
cmd/helm/install.go
View File

@ -186,7 +186,7 @@ func newInstallCmd(c helm.Interface, out io.Writer) *cobra.Command {
f.BoolVar(&inst.verify, "verify", false, "verify the package before installing it")
f.StringVar(&inst.keyring, "keyring", defaultKeyring(), "location of public keys used for verification")
f.StringVar(&inst.version, "version", "", "specify the exact chart version to install. If this is not specified, the latest version is installed")
f.Int64Var(&inst.timeout, "timeout", 300, "time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)")
f.Int64Var(&inst.timeout, "timeout", 300, "time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)")
f.BoolVar(&inst.wait, "wait", false, "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")
f.StringVar(&inst.repoURL, "repo", "", "chart repository url where to locate the requested chart")
f.StringVar(&inst.certFile, "cert-file", "", "identify HTTPS client using this SSL certificate file")

8
cmd/helm/installer/install.go
View File

@ -30,7 +30,7 @@ import (
"k8s.io/client-go/pkg/apis/extensions/v1beta1"
)
// Install uses kubernetes client to install tiller.
// Install uses Kubernetes client to install Tiller.
//
// Returns an error if the command failed.
func Install(client kubernetes.Interface, opts *Options) error {
@ -48,7 +48,7 @@ func Install(client kubernetes.Interface, opts *Options) error {
return nil
}
// Upgrade uses kubernetes client to upgrade tiller to current version.
// Upgrade uses Kubernetes client to upgrade Tiller to current version.
//
// Returns an error if the command failed.
func Upgrade(client kubernetes.Interface, opts *Options) error {
@ -62,7 +62,7 @@ func Upgrade(client kubernetes.Interface, opts *Options) error {
if _, err := client.Extensions().Deployments(opts.Namespace).Update(obj); err != nil {
return err
}
// If the service does not exists that would mean we are upgrading from a tiller version
// If the service does not exists that would mean we are upgrading from a Tiller version
// that didn't deploy the service, so install it.
_, err = client.Core().Services(opts.Namespace).Get(serviceName, metav1.GetOptions{})
if apierrors.IsNotFound(err) {
@ -71,7 +71,7 @@ func Upgrade(client kubernetes.Interface, opts *Options) error {
return err
}
// createDeployment creates the Tiller deployment reource
// createDeployment creates the Tiller Deployment resource.
func createDeployment(client extensionsclient.DeploymentsGetter, opts *Options) error {
obj := deployment(opts)
_, err := client.Deployments(obj.Namespace).Create(obj)

22
cmd/helm/installer/options.go
View File

@ -25,51 +25,51 @@ import (
const defaultImage = "gcr.io/kubernetes-helm/tiller"
// Options control how to install tiller into a cluster, upgrade, and uninstall tiller from a cluster.
// Options control how to install Tiller into a cluster, upgrade, and uninstall Tiller from a cluster.
type Options struct {
// EnableTLS instructs tiller to serve with TLS enabled.
// EnableTLS instructs Tiller to serve with TLS enabled.
//
// Implied by VerifyTLS. If set the TLSKey and TLSCert are required.
EnableTLS bool
// VerifyTLS instructs tiller to serve with TLS enabled verify remote certificates.
// VerifyTLS instructs Tiller to serve with TLS enabled verify remote certificates.
//
// If set TLSKey, TLSCert, TLSCaCert are required.
VerifyTLS bool
// UseCanary indicates that tiller should deploy using the latest tiller image.
// UseCanary indicates that Tiller should deploy using the latest Tiller image.
UseCanary bool
// Namespace is the kubernetes namespace to use to deploy tiller.
// Namespace is the Kubernetes namespace to use to deploy Tiller.
Namespace string
// ServiceAccount is the Kubernetes service account to add to tiller
// ServiceAccount is the Kubernetes service account to add to Tiller.
ServiceAccount string
// ImageSpec indentifies the image tiller will use when deployed.
// ImageSpec indentifies the image Tiller will use when deployed.
//
// Valid if and only if UseCanary is false.
ImageSpec string
// TLSKeyFile identifies the file containing the pem encoded TLS private
// key tiller should use.
// key Tiller should use.
//
// Required and valid if and only if EnableTLS or VerifyTLS is set.
TLSKeyFile string
// TLSCertFile identifies the file containing the pem encoded TLS
// certificate tiller should use.
// certificate Tiller should use.
//
// Required and valid if and only if EnableTLS or VerifyTLS is set.
TLSCertFile string
// TLSCaCertFile identifies the file containing the pem encoded TLS CA
// certificate tiller should use to verify remotes certificates.
// certificate Tiller should use to verify remotes certificates.
//
// Required and valid if and only if VerifyTLS is set.
TLSCaCertFile string
// EnableHostNetwork installs Tiller with net=host
// EnableHostNetwork installs Tiller with net=host.
EnableHostNetwork bool
}

2
cmd/helm/installer/uninstall.go
View File

@ -30,7 +30,7 @@ const (
serviceName = "tiller-deploy"
)
// Uninstall uses kubernetes client to uninstall tiller
// Uninstall uses Kubernetes client to uninstall Tiller.
func Uninstall(client internalclientset.Interface, opts *Options) error {
if err := deleteService(client.Core(), opts.Namespace); err != nil {
return err

2
cmd/helm/release_testing.go
View File

@ -64,7 +64,7 @@ func newReleaseTestCmd(c helm.Interface, out io.Writer) *cobra.Command {
}
f := cmd.Flags()
f.Int64Var(&rlsTest.timeout, "timeout", 300, "time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)")
f.Int64Var(&rlsTest.timeout, "timeout", 300, "time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)")
f.BoolVar(&rlsTest.cleanup, "cleanup", false, "delete test pods upon completion")
return cmd

2
cmd/helm/reset.go
View File

@ -77,7 +77,7 @@ func newResetCmd(client helm.Interface, out io.Writer) *cobra.Command {
}
f := cmd.Flags()
f.BoolVarP(&d.force, "force", "f", false, "forces Tiller uninstall even if there are releases installed, or if tiller is not in ready state")
f.BoolVarP(&d.force, "force", "f", false, "forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state")
f.BoolVar(&d.removeHelmHome, "remove-helm-home", false, "if set deletes $HELM_HOME")
return cmd

2
cmd/helm/rollback.go
View File

@ -81,7 +81,7 @@ func newRollbackCmd(c helm.Interface, out io.Writer) *cobra.Command {
f.BoolVar(&rollback.recreate, "recreate-pods", false, "performs pods restart for the resource if applicable")
f.BoolVar(&rollback.force, "force", false, "force resource update through delete/recreate if needed")
f.BoolVar(&rollback.disableHooks, "no-hooks", false, "prevent hooks from running during rollback")
f.Int64Var(&rollback.timeout, "timeout", 300, "time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)")
f.Int64Var(&rollback.timeout, "timeout", 300, "time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)")
f.BoolVar(&rollback.wait, "wait", false, "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")
return cmd

2
cmd/helm/upgrade.go
View File

@ -126,7 +126,7 @@ func newUpgradeCmd(client helm.Interface, out io.Writer) *cobra.Command {
f.BoolVarP(&upgrade.install, "install", "i", false, "if a release by this name doesn't already exist, run an install")
f.StringVar(&upgrade.namespace, "namespace", "default", "namespace to install the release into (only used if --install is set)")
f.StringVar(&upgrade.version, "version", "", "specify the exact chart version to use. If this is not specified, the latest version is used")
f.Int64Var(&upgrade.timeout, "timeout", 300, "time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)")
f.Int64Var(&upgrade.timeout, "timeout", 300, "time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)")
f.BoolVar(&upgrade.resetValues, "reset-values", false, "when upgrading, reset the values to the ones built into the chart")
f.BoolVar(&upgrade.reuseValues, "reuse-values", false, "when upgrading, reuse the last release's values, and merge in any new values. If '--reset-values' is specified, this is ignored.")
f.BoolVar(&upgrade.wait, "wait", false, "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")

6
docs/helm/helm.md
View File

@ -34,9 +34,9 @@ Environment:
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -66,4 +66,4 @@ Environment:
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client/server version information
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_completion.md
View File

@ -26,12 +26,12 @@ helm completion SHELL
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_create.md
View File

@ -45,12 +45,12 @@ helm create NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_delete.md
View File

@ -23,7 +23,7 @@ helm delete [flags] RELEASE_NAME [...]
--dry-run simulate a delete
--no-hooks prevent hooks from running during deletion
--purge remove the release from the store and make its name free for later use
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
@ -36,12 +36,12 @@ helm delete [flags] RELEASE_NAME [...]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_dependency.md
View File

@ -59,9 +59,9 @@ for this case.
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -70,4 +70,4 @@ for this case.
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart
* [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of requirements.yaml
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_dependency_build.md
View File

@ -32,12 +32,12 @@ helm dependency build [flags] CHART
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_dependency_list.md
View File

@ -24,12 +24,12 @@ helm dependency list [flags] CHART
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_dependency_update.md
View File

@ -37,12 +37,12 @@ helm dependency update [flags] CHART
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm dependency](helm_dependency.md) - manage a chart's dependencies
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_fetch.md
View File

@ -46,12 +46,12 @@ helm fetch [flags] [chart URL | repo/chartname] [...]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_get.md
View File

@ -38,9 +38,9 @@ helm get [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -49,4 +49,4 @@ helm get [flags] RELEASE_NAME
* [helm get manifest](helm_get_manifest.md) - download the manifest for a named release
* [helm get values](helm_get_values.md) - download the values file for a named release
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_get_hooks.md
View File

@ -26,12 +26,12 @@ helm get hooks [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_get_manifest.md
View File

@ -28,12 +28,12 @@ helm get manifest [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_get_values.md
View File

@ -25,12 +25,12 @@ helm get values [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm get](helm_get.md) - download a named release
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_history.md
View File

@ -41,12 +41,12 @@ helm history [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_home.md
View File

@ -19,12 +19,12 @@ helm home
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

30
docs/helm/helm_init.md
View File

@ -6,14 +6,14 @@ initialize Helm on both client and server
This command installs Tiller (the helm server side component) onto your
Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/)
This command installs Tiller (the Helm server-side component) onto your
Kubernetes Cluster and sets up local configuration in $HELM_HOME (default ~/.helm/).
As with the rest of the Helm commands, 'helm init' discovers Kubernetes clusters
by reading $KUBECONFIG (default '~/.kube/config') and using the default context.
To set up just a local environment, use '--client-only'. That will configure
$HELM_HOME, but not attempt to connect to a remote cluster and install the Tiller
$HELM_HOME, but not attempt to connect to a Kubernetes cluster and install the Tiller
deployment.
When installing Tiller, 'helm init' will attempt to install the latest released
@ -33,21 +33,21 @@ helm init
### Options
```
--canary-image use the canary tiller image
-c, --client-only if set does not install tiller
--canary-image use the canary Tiller image
-c, --client-only if set does not install Tiller
--dry-run do not install local or remote
--local-repo-url string URL for local repository (default "http://127.0.0.1:8879/charts")
--net-host install tiller with net=host
--net-host install Tiller with net=host
--service-account string name of service account
--skip-refresh do not refresh (download) the local repository cache
--stable-repo-url string URL for stable repository (default "https://kubernetes-charts.storage.googleapis.com")
-i, --tiller-image string override tiller image
--tiller-tls install tiller with TLS enabled
--tiller-tls-cert string path to TLS certificate file to install with tiller
--tiller-tls-key string path to TLS key file to install with tiller
--tiller-tls-verify install tiller with TLS enabled and to verify remote certificates
-i, --tiller-image string override Tiller image
--tiller-tls install Tiller with TLS enabled
--tiller-tls-cert string path to TLS certificate file to install with Tiller
--tiller-tls-key string path to TLS key file to install with Tiller
--tiller-tls-verify install Tiller with TLS enabled and to verify remote certificates
--tls-ca-cert string path to CA root certificate
--upgrade upgrade if tiller is already installed
--upgrade upgrade if Tiller is already installed
```
### Options inherited from parent commands
@ -55,12 +55,12 @@ helm init
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 26-Jun-2017

6
docs/helm/helm_inspect.md
View File

@ -33,9 +33,9 @@ helm inspect [CHART]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -43,4 +43,4 @@ helm inspect [CHART]
* [helm inspect chart](helm_inspect_chart.md) - shows inspect chart
* [helm inspect values](helm_inspect_values.md) - shows inspect values
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_inspect_chart.md
View File

@ -31,12 +31,12 @@ helm inspect chart [CHART]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_inspect_values.md
View File

@ -31,12 +31,12 @@ helm inspect values [CHART]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm inspect](helm_inspect.md) - inspect a chart
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_install.md
View File

@ -81,7 +81,7 @@ helm install [CHART]
--replace re-use the given name, even if that name is already used. This is unsafe in production
--repo string chart repository url where to locate the requested chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
@ -98,12 +98,12 @@ helm install [CHART]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_lint.md
View File

@ -29,12 +29,12 @@ helm lint [flags] PATH
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_list.md
View File

@ -62,12 +62,12 @@ helm list [flags] [FILTER]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_package.md
View File

@ -37,12 +37,12 @@ helm package [flags] [CHART_PATH] [...]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 5-Jun-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_plugin.md
View File

@ -14,9 +14,9 @@ Manage client-side Helm plugins.
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -26,4 +26,4 @@ Manage client-side Helm plugins.
* [helm plugin remove](helm_plugin_remove.md) - remove one or more Helm plugins
* [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_plugin_install.md
View File

@ -22,12 +22,12 @@ helm plugin install [options] <path|url>...
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_plugin_list.md
View File

@ -16,12 +16,12 @@ helm plugin list
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_plugin_remove.md
View File

@ -16,12 +16,12 @@ helm plugin remove <plugin>...
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_plugin_update.md
View File

@ -16,12 +16,12 @@ helm plugin update <plugin>...
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo.md
View File

@ -18,9 +18,9 @@ Example usage:
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
@ -31,4 +31,4 @@ Example usage:
* [helm repo remove](helm_repo_remove.md) - remove a chart repository
* [helm repo update](helm_repo_update.md) - update information of available charts locally from chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo_add.md
View File

@ -25,12 +25,12 @@ helm repo add [flags] [NAME] [URL]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo_index.md
View File

@ -32,12 +32,12 @@ helm repo index [flags] [DIR]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo_list.md
View File

@ -16,12 +16,12 @@ helm repo list [flags]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo_remove.md
View File

@ -16,12 +16,12 @@ helm repo remove [flags] [NAME]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_repo_update.md
View File

@ -22,12 +22,12 @@ helm repo update
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_reset.md
View File

@ -18,7 +18,7 @@ helm reset
### Options
```
-f, --force forces Tiller uninstall even if there are releases installed, or if tiller is not in ready state
-f, --force forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state
--remove-helm-home if set deletes $HELM_HOME
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
@ -32,12 +32,12 @@ helm reset
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_rollback.md
View File

@ -24,7 +24,7 @@ helm rollback [flags] [RELEASE] [REVISION]
--force force resource update through delete/recreate if needed
--no-hooks prevent hooks from running during rollback
--recreate-pods performs pods restart for the resource if applicable
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
@ -38,12 +38,12 @@ helm rollback [flags] [RELEASE] [REVISION]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_search.md
View File

@ -29,12 +29,12 @@ helm search [keyword]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_serve.md
View File

@ -37,12 +37,12 @@ helm serve
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_status.md
View File

@ -36,12 +36,12 @@ helm status [flags] RELEASE_NAME
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_test.md
View File

@ -20,7 +20,7 @@ helm test [RELEASE]
```
--cleanup delete test pods upon completion
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
@ -33,12 +33,12 @@ helm test [RELEASE]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

8
docs/helm/helm_upgrade.md
View File

@ -51,7 +51,7 @@ helm upgrade [RELEASE] [CHART]
--reset-values when upgrading, reset the values to the ones built into the chart
--reuse-values when upgrading, reuse the last release's values, and merge in any new values. If '--reset-values' is specified, this is ignored.
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
@ -68,12 +68,12 @@ helm upgrade [RELEASE] [CHART]
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_verify.md
View File

@ -31,12 +31,12 @@ helm verify [flags] PATH
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

6
docs/helm/helm_version.md
View File

@ -45,12 +45,12 @@ helm version
```
--debug enable verbose output
--home string location of your Helm config. Overrides $HELM_HOME (default "$HOME/.helm")
--host string address of tiller. Overrides $HELM_HOST
--host string address of Tiller. Overrides $HELM_HOST
--kube-context string name of the kubeconfig context to use
--tiller-namespace string namespace of tiller (default "kube-system")
--tiller-namespace string namespace of Tiller (default "kube-system")
```
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 29-May-2017
###### Auto generated by spf13/cobra on 23-Jun-2017

14
pkg/chartutil/files.go
View File

@ -94,8 +94,8 @@ func (f Files) Glob(pattern string) Files {
}
// AsConfig turns a Files group and flattens it to a YAML map suitable for
// including in the `data` section of a kubernetes ConfigMap definition.
// Duplicate keys will be overwritten, so be aware that your filenames
// including in the 'data' section of a Kubernetes ConfigMap definition.
// Duplicate keys will be overwritten, so be aware that your file names
// (regardless of path) should be unique.
//
// This is designed to be called from a template, and will return empty string
@ -103,7 +103,7 @@ func (f Files) Glob(pattern string) Files {
// object is nil.
//
// The output will not be indented, so you will want to pipe this to the
// `indent` template function.
// 'indent' template function.
//
// data:
// {{ .Files.Glob("config/**").AsConfig() | indent 4 }}
@ -122,9 +122,9 @@ func (f Files) AsConfig() string {
return ToYaml(m)
}
// AsSecrets returns the value of a Files object as base64 suitable for
// including in the `data` section of a kubernetes Secret definition.
// Duplicate keys will be overwritten, so be aware that your filenames
// AsSecrets returns the base64-encoded value of a Files object suitable for
// including in the 'data' section of a Kubernetes Secret definition.
// Duplicate keys will be overwritten, so be aware that your file names
// (regardless of path) should be unique.
//
// This is designed to be called from a template, and will return empty string
@ -132,7 +132,7 @@ func (f Files) AsConfig() string {
// object is nil.
//
// The output will not be indented, so you will want to pipe this to the
// `indent` template function.
// 'indent' template function.
//
// data:
// {{ .Files.Glob("secrets/*").AsSecrets() }}

18
pkg/helm/client.go
View File

@ -29,7 +29,7 @@ import (
rls "k8s.io/helm/pkg/proto/hapi/services"
)
// Client manages client side of the helm-tiller protocol
// Client manages client side of the Helm-Tiller protocol.
type Client struct {
opts options
}
@ -40,7 +40,7 @@ func NewClient(opts ...Option) *Client {
return c.Option(opts...)
}
// Option configures the helm client with the provided options
// Option configures the Helm client with the provided options.
func (h *Client) Option(opts ...Option) *Client {
for _, opt := range opts {
opt(&h.opts)
@ -64,7 +64,7 @@ func (h *Client) ListReleases(opts ...ReleaseListOption) (*rls.ListReleasesRespo
return h.list(ctx, req)
}
// InstallRelease loads a chart from chstr, installs it and returns the release response.
// InstallRelease loads a chart from chstr, installs it, and returns the release response.
func (h *Client) InstallRelease(chstr, ns string, opts ...InstallOption) (*rls.InstallReleaseResponse, error) {
// load the chart to install
chart, err := chartutil.Load(chstr)
@ -135,7 +135,7 @@ func (h *Client) DeleteRelease(rlsName string, opts ...DeleteOption) (*rls.Unins
return h.delete(ctx, req)
}
// UpdateRelease loads a chart from chstr and updates a release to a new/different chart
// UpdateRelease loads a chart from chstr and updates a release to a new/different chart.
func (h *Client) UpdateRelease(rlsName string, chstr string, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error) {
// load the chart to update
chart, err := chartutil.Load(chstr)
@ -146,7 +146,7 @@ func (h *Client) UpdateRelease(rlsName string, chstr string, opts ...UpdateOptio
return h.UpdateReleaseFromChart(rlsName, chart, opts...)
}
// UpdateReleaseFromChart updates a release to a new/different chart
// UpdateReleaseFromChart updates a release to a new/different chart.
func (h *Client) UpdateReleaseFromChart(rlsName string, chart *chart.Chart, opts ...UpdateOption) (*rls.UpdateReleaseResponse, error) {
// apply the update options
@ -181,7 +181,7 @@ func (h *Client) UpdateReleaseFromChart(rlsName string, chart *chart.Chart, opts
return h.update(ctx, req)
}
// GetVersion returns the server version
// GetVersion returns the server version.
func (h *Client) GetVersion(opts ...VersionOption) (*rls.GetVersionResponse, error) {
for _, opt := range opts {
opt(&h.opts)
@ -197,7 +197,7 @@ func (h *Client) GetVersion(opts ...VersionOption) (*rls.GetVersionResponse, err
return h.version(ctx, req)
}
// RollbackRelease rolls back a release to the previous version
// RollbackRelease rolls back a release to the previous version.
func (h *Client) RollbackRelease(rlsName string, opts ...RollbackOption) (*rls.RollbackReleaseResponse, error) {
for _, opt := range opts {
opt(&h.opts)
@ -270,7 +270,7 @@ func (h *Client) ReleaseHistory(rlsName string, opts ...HistoryOption) (*rls.Get
return h.history(ctx, req)
}
// RunReleaseTest executes a pre-defined test on a release
// RunReleaseTest executes a pre-defined test on a release.
func (h *Client) RunReleaseTest(rlsName string, opts ...ReleaseTestOption) (<-chan *rls.TestReleaseResponse, <-chan error) {
for _, opt := range opts {
opt(&h.opts)
@ -283,7 +283,7 @@ func (h *Client) RunReleaseTest(rlsName string, opts ...ReleaseTestOption) (<-ch
return h.test(ctx, req)
}
// connect returns a grpc connection to tiller or error. The grpc dial options
// connect returns a gRPC connection to Tiller or error. The gRPC dial options
// are constructed here.
func (h *Client) connect(ctx context.Context) (conn *grpc.ClientConn, err error) {
opts := []grpc.DialOption{

32
pkg/helm/helm_test.go
View File

@ -31,13 +31,13 @@ import (
tpb "k8s.io/helm/pkg/proto/hapi/services"
)
// path to example charts relative to pkg/helm.
// Path to example charts relative to pkg/helm.
const chartsDir = "../../docs/examples/"
// sentinel error to indicate to the helm client to not send the request to tiller.
// Sentinel error to indicate to the Helm client to not send the request to Tiller.
var errSkip = errors.New("test: skip")
// Verify ReleaseListOption's are applied to a ListReleasesRequest correctly.
// Verify each ReleaseListOption is applied to a ListReleasesRequest correctly.
func TestListReleases_VerifyOptions(t *testing.T) {
// Options testdata
var limit = 2
@ -75,7 +75,7 @@ func TestListReleases_VerifyOptions(t *testing.T) {
ReleaseListNamespace(namespace),
}
// BeforeCall option to intercept helm client ListReleasesRequest
// BeforeCall option to intercept Helm client ListReleasesRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.ListReleasesRequest:
@ -92,7 +92,7 @@ func TestListReleases_VerifyOptions(t *testing.T) {
}
}
// Verify InstallOption's are applied to an InstallReleaseRequest correctly.
// Verify each InstallOption is applied to an InstallReleaseRequest correctly.
func TestInstallRelease_VerifyOptions(t *testing.T) {
// Options testdata
var disableHooks = true
@ -124,7 +124,7 @@ func TestInstallRelease_VerifyOptions(t *testing.T) {
InstallDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client InstallReleaseRequest
// BeforeCall option to intercept Helm client InstallReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.InstallReleaseRequest:
@ -141,7 +141,7 @@ func TestInstallRelease_VerifyOptions(t *testing.T) {
}
}
// Verify DeleteOptions's are applied to an UninstallReleaseRequest correctly.
// Verify each DeleteOptions is applied to an UninstallReleaseRequest correctly.
func TestDeleteRelease_VerifyOptions(t *testing.T) {
// Options testdata
var releaseName = "test"
@ -161,7 +161,7 @@ func TestDeleteRelease_VerifyOptions(t *testing.T) {
DeleteDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client DeleteReleaseRequest
// BeforeCall option to intercept Helm client DeleteReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.UninstallReleaseRequest:
@ -178,7 +178,7 @@ func TestDeleteRelease_VerifyOptions(t *testing.T) {
}
}
// Verify UpdateOption's are applied to an UpdateReleaseRequest correctly.
// Verify each UpdateOption is applied to an UpdateReleaseRequest correctly.
func TestUpdateRelease_VerifyOptions(t *testing.T) {
// Options testdata
var chartName = "alpine"
@ -204,7 +204,7 @@ func TestUpdateRelease_VerifyOptions(t *testing.T) {
UpgradeDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client UpdateReleaseRequest
// BeforeCall option to intercept Helm client UpdateReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.UpdateReleaseRequest:
@ -221,7 +221,7 @@ func TestUpdateRelease_VerifyOptions(t *testing.T) {
}
}
// Verify RollbackOption's are applied to a RollbackReleaseRequest correctly.
// Verify each RollbackOption is applied to a RollbackReleaseRequest correctly.
func TestRollbackRelease_VerifyOptions(t *testing.T) {
// Options testdata
var disableHooks = true
@ -244,7 +244,7 @@ func TestRollbackRelease_VerifyOptions(t *testing.T) {
RollbackDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client RollbackReleaseRequest
// BeforeCall option to intercept Helm client RollbackReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.RollbackReleaseRequest:
@ -261,7 +261,7 @@ func TestRollbackRelease_VerifyOptions(t *testing.T) {
}
}
// Verify StatusOption's are applied to a GetReleaseStatusRequest correctly.
// Verify each StatusOption is applied to a GetReleaseStatusRequest correctly.
func TestReleaseStatus_VerifyOptions(t *testing.T) {
// Options testdata
var releaseName = "test"
@ -273,7 +273,7 @@ func TestReleaseStatus_VerifyOptions(t *testing.T) {
Version: revision,
}
// BeforeCall option to intercept helm client GetReleaseStatusRequest
// BeforeCall option to intercept Helm client GetReleaseStatusRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.GetReleaseStatusRequest:
@ -290,7 +290,7 @@ func TestReleaseStatus_VerifyOptions(t *testing.T) {
}
}
// Verify ContentOption's are applied to a GetReleaseContentRequest correctly.
// Verify each ContentOption is applied to a GetReleaseContentRequest correctly.
func TestReleaseContent_VerifyOptions(t *testing.T) {
// Options testdata
var releaseName = "test"
@ -302,7 +302,7 @@ func TestReleaseContent_VerifyOptions(t *testing.T) {
Version: revision,
}
// BeforeCall option to intercept helm client GetReleaseContentRequest
// BeforeCall option to intercept Helm client GetReleaseContentRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.GetReleaseContentRequest:

30
pkg/kube/client.go
View File

@ -63,7 +63,7 @@ type Client struct {
Log func(string, ...interface{})
}
// New create a new Client
// New creates a new Client.
func New(config clientcmd.ClientConfig) *Client {
return &Client{
Factory: cmdutil.NewFactory(config),
@ -75,9 +75,9 @@ func New(config clientcmd.ClientConfig) *Client {
// ResourceActorFunc performs an action on a single resource.
type ResourceActorFunc func(*resource.Info) error
// Create creates kubernetes resources from an io.reader
// Create creates Kubernetes resources from an io.reader.
//
// Namespace will set the namespace
// Namespace will set the namespace.
func (c *Client) Create(namespace string, reader io.Reader, timeout int64, shouldWait bool) error {
client, err := c.ClientSet()
if err != nil {
@ -147,12 +147,12 @@ func (c *Client) Build(namespace string, reader io.Reader) (Result, error) {
return result, scrubValidationError(err)
}
// Get gets kubernetes resources as pretty printed string
// Get gets Kubernetes resources as pretty-printed string.
//
// Namespace will set the namespace
// Namespace will set the namespace.
func (c *Client) Get(namespace string, reader io.Reader) (string, error) {
// Since we don't know what order the objects come in, let's group them by the types, so
// that when we print them, they come looking good (headers apply to subgroups, etc.)
// that when we print them, they come out looking good (headers apply to subgroups, etc.).
objs := make(map[string][]runtime.Object)
infos, err := c.BuildUnstructured(namespace, reader)
if err != nil {
@ -181,7 +181,7 @@ func (c *Client) Get(namespace string, reader io.Reader) (string, error) {
// Ok, now we have all the objects grouped by types (say, by v1/Pod, v1/Service, etc.), so
// spin through them and print them. Printer is cool since it prints the header only when
// an object type changes, so we can just rely on that. Problem is it doesn't seem to keep
// track of tab widths
// track of tab widths.
buf := new(bytes.Buffer)
p, _ := c.Printer(nil, printers.PrintOptions{})
for t, ot := range objs {
@ -208,11 +208,11 @@ func (c *Client) Get(namespace string, reader io.Reader) (string, error) {
}
// Update reads in the current configuration and a target configuration from io.reader
// and creates resources that don't already exists, updates resources that have been modified
// in the target configuration and deletes resources from the current configuration that are
// not present in the target configuration
// and creates resources that don't already exists, updates resources that have been modified
// in the target configuration and deletes resources from the current configuration that are
// not present in the target configuration.
//
// Namespace will set the namespaces
// Namespace will set the namespaces.
func (c *Client) Update(namespace string, originalReader, targetReader io.Reader, force bool, recreate bool, timeout int64, shouldWait bool) error {
original, err := c.BuildUnstructured(namespace, originalReader)
if err != nil {
@ -281,9 +281,9 @@ func (c *Client) Update(namespace string, originalReader, targetReader io.Reader
return nil
}
// Delete deletes kubernetes resources from an io.reader
// Delete deletes Kubernetes resources from an io.reader.
//
// Namespace will set the namespace
// Namespace will set the namespace.
func (c *Client) Delete(namespace string, reader io.Reader) error {
infos, err := c.BuildUnstructured(namespace, reader)
if err != nil {
@ -577,7 +577,7 @@ func (c *Client) waitForJob(e watch.Event, name string) (bool, error) {
return false, nil
}
// scrubValidationError removes kubectl info from the message
// scrubValidationError removes kubectl info from the message.
func scrubValidationError(err error) error {
if err == nil {
return nil
@ -591,7 +591,7 @@ func scrubValidationError(err error) error {
}
// WaitAndGetCompletedPodPhase waits up to a timeout until a pod enters a completed phase
// and returns said phase (PodSucceeded or PodFailed qualify)
// and returns said phase (PodSucceeded or PodFailed qualify).
func (c *Client) WaitAndGetCompletedPodPhase(namespace string, reader io.Reader, timeout time.Duration) (api.PodPhase, error) {
infos, err := c.Build(namespace, reader)
if err != nil {

2
pkg/kube/config.go
View File

@ -18,7 +18,7 @@ package kube // import "k8s.io/helm/pkg/kube"
import "k8s.io/client-go/tools/clientcmd"
// GetConfig returns a kubernetes client config for a given context.
// GetConfig returns a Kubernetes client config for a given context.
func GetConfig(context string) clientcmd.ClientConfig {
rules := clientcmd.NewDefaultClientConfigLoadingRules()
rules.DefaultClientConfig = &clientcmd.DefaultClientConfig

4
pkg/storage/driver/driver.go
View File

@ -69,9 +69,9 @@ type Queryor interface {
Query(labels map[string]string) ([]*rspb.Release, error)
}
// Driver is the interface composed of Creator, Updator, Deletor, Queryor
// Driver is the interface composed of Creator, Updator, Deletor, and Queryor
// interfaces. It defines the behavior for storing, updating, deleted,
// and retrieving tiller releases from some underlying storage mechanism,
// and retrieving Tiller releases from some underlying storage mechanism,
// e.g. memory, configmaps.
type Driver interface {
Creator

12
pkg/tiller/environment/environment.go
View File

@ -37,11 +37,11 @@ import (
"k8s.io/helm/pkg/storage/driver"
)
// TillerNamespaceEnvVar is the environment variable name for the tiller
// TillerNamespaceEnvVar is the environment variable name for the Tiller
// namespace in the kubernetes cluster.
const TillerNamespaceEnvVar = "TILLER_NAMESPACE"
// DefaultTillerNamespace is the default namespace for tiller.
// DefaultTillerNamespace is the default namespace for Tiller.
const DefaultTillerNamespace = "kube-system"
// GoTplEngine is the name of the Go template engine, as registered in the EngineYard.
@ -133,9 +133,9 @@ type KubeClient interface {
WatchUntilReady(namespace string, reader io.Reader, timeout int64, shouldWait bool) error
// Update updates one or more resources or creates the resource
// if it doesn't exist
// if it doesn't exist.
//
// namespace must contain a valid existing namespace
// namespace must contain a valid existing namespace.
//
// reader must contain a YAML stream (one or more YAML documents separated
// by "\n---\n").
@ -145,7 +145,7 @@ type KubeClient interface {
BuildUnstructured(namespace string, reader io.Reader) (kube.Result, error)
// WaitAndGetCompletedPodPhase waits up to a timeout until a pod enters a completed phase
// and returns said phase (PodSucceeded or PodFailed qualify)
// and returns said phase (PodSucceeded or PodFailed qualify).
WaitAndGetCompletedPodPhase(namespace string, reader io.Reader, timeout time.Duration) (api.PodPhase, error)
}
@ -197,7 +197,7 @@ func (p *PrintingKubeClient) BuildUnstructured(ns string, reader io.Reader) (kub
return []*resource.Info{}, nil
}
// WaitAndGetCompletedPodPhase implements KubeClient WaitAndGetCompletedPodPhase
// WaitAndGetCompletedPodPhase implements KubeClient WaitAndGetCompletedPodPhase.
func (p *PrintingKubeClient) WaitAndGetCompletedPodPhase(namespace string, reader io.Reader, timeout time.Duration) (api.PodPhase, error) {
_, err := io.Copy(p.Out, reader)
return api.PodUnknown, err

2
pkg/tlsutil/cfg.go
View File

@ -27,7 +27,7 @@ import (
type Options struct {
CaCertFile string
// If either the KeyFile or CertFile is empty, ClientConfig() will not load them,
// preventing helm from authenticating to Tiller. They are required to be non-empty
// preventing Helm from authenticating to Tiller. They are required to be non-empty
// when calling ServerConfig, otherwise an error is returned.
KeyFile string
CertFile string