From 81d77a62fb3825a93bdf764d66ef2f96c2a67467 Mon Sep 17 00:00:00 2001 From: Matt Butcher Date: Mon, 31 Oct 2016 17:16:15 -0600 Subject: [PATCH] docs(helm): add docs for helm cli commands This adds the documentation automatically generated from Cobra. It's basically a Markdown-formatted copy of the 'helm help' commands. --- docs/helm/helm.md | 62 +++++++++++++++++++++ docs/helm/helm_create.md | 49 +++++++++++++++++ docs/helm/helm_delete.md | 40 ++++++++++++++ docs/helm/helm_dependency.md | 58 ++++++++++++++++++++ docs/helm/helm_dependency_build.md | 42 +++++++++++++++ docs/helm/helm_dependency_list.md | 34 ++++++++++++ docs/helm/helm_dependency_update.md | 41 ++++++++++++++ docs/helm/helm_fetch.md | 50 +++++++++++++++++ docs/helm/helm_get.md | 46 ++++++++++++++++ docs/helm/helm_get_hooks.md | 36 +++++++++++++ docs/helm/helm_get_manifest.md | 38 +++++++++++++ docs/helm/helm_get_values.md | 35 ++++++++++++ docs/helm/helm_history.md | 46 ++++++++++++++++ docs/helm/helm_home.md | 29 ++++++++++ docs/helm/helm_init.md | 54 +++++++++++++++++++ docs/helm/helm_inspect.md | 41 ++++++++++++++ docs/helm/helm_inspect_chart.md | 37 +++++++++++++ docs/helm/helm_inspect_values.md | 37 +++++++++++++ docs/helm/helm_install.md | 84 +++++++++++++++++++++++++++++ docs/helm/helm_lint.md | 39 ++++++++++++++ docs/helm/helm_list.md | 65 ++++++++++++++++++++++ docs/helm/helm_package.md | 44 +++++++++++++++ docs/helm/helm_repo.md | 33 ++++++++++++ docs/helm/helm_repo_add.md | 32 +++++++++++ docs/helm/helm_repo_index.md | 42 +++++++++++++++ docs/helm/helm_repo_list.md | 26 +++++++++ docs/helm/helm_repo_remove.md | 26 +++++++++ docs/helm/helm_repo_update.md | 32 +++++++++++ docs/helm/helm_rollback.md | 36 +++++++++++++ docs/helm/helm_search.md | 38 +++++++++++++ docs/helm/helm_serve.md | 39 ++++++++++++++ docs/helm/helm_status.md | 34 ++++++++++++ docs/helm/helm_upgrade.md | 51 ++++++++++++++++++ docs/helm/helm_verify.md | 41 ++++++++++++++ docs/helm/helm_version.md | 49 +++++++++++++++++ 35 files changed, 1486 insertions(+) create mode 100644 docs/helm/helm.md create mode 100644 docs/helm/helm_create.md create mode 100644 docs/helm/helm_delete.md create mode 100644 docs/helm/helm_dependency.md create mode 100644 docs/helm/helm_dependency_build.md create mode 100644 docs/helm/helm_dependency_list.md create mode 100644 docs/helm/helm_dependency_update.md create mode 100644 docs/helm/helm_fetch.md create mode 100644 docs/helm/helm_get.md create mode 100644 docs/helm/helm_get_hooks.md create mode 100644 docs/helm/helm_get_manifest.md create mode 100644 docs/helm/helm_get_values.md create mode 100644 docs/helm/helm_history.md create mode 100644 docs/helm/helm_home.md create mode 100644 docs/helm/helm_init.md create mode 100644 docs/helm/helm_inspect.md create mode 100644 docs/helm/helm_inspect_chart.md create mode 100644 docs/helm/helm_inspect_values.md create mode 100644 docs/helm/helm_install.md create mode 100644 docs/helm/helm_lint.md create mode 100644 docs/helm/helm_list.md create mode 100644 docs/helm/helm_package.md create mode 100644 docs/helm/helm_repo.md create mode 100644 docs/helm/helm_repo_add.md create mode 100644 docs/helm/helm_repo_index.md create mode 100644 docs/helm/helm_repo_list.md create mode 100644 docs/helm/helm_repo_remove.md create mode 100644 docs/helm/helm_repo_update.md create mode 100644 docs/helm/helm_rollback.md create mode 100644 docs/helm/helm_search.md create mode 100644 docs/helm/helm_serve.md create mode 100644 docs/helm/helm_status.md create mode 100644 docs/helm/helm_upgrade.md create mode 100644 docs/helm/helm_verify.md create mode 100644 docs/helm/helm_version.md diff --git a/docs/helm/helm.md b/docs/helm/helm.md new file mode 100644 index 000000000..96eea7bc1 --- /dev/null +++ b/docs/helm/helm.md @@ -0,0 +1,62 @@ +## helm + +The Helm package manager for Kubernetes. + +### Synopsis + + +The Kubernetes package manager + +To begin working with Helm, run the 'helm init' command: + + $ helm init + +This will install Tiller to your running Kubernetes cluster. +It will also set up any necessary local configuration. + +Common actions from this point include: + +- helm search: search for charts +- helm fetch: download a chart to your local directory to view +- helm install: upload the chart to Kubernetes +- helm list: list releases of charts + +Environment: + $HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm + $HELM_HOST set an alternative Tiller host. The format is host:port + $KUBECONFIG set an alternate Kubernetes configuration file (default "~/.kube/config") + + +### Options + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm create](helm_create.md) - create a new chart with the given name +* [helm delete](helm_delete.md) - given a release name, delete the release from Kubernetes +* [helm dependency](helm_dependency.md) - manage a chart's dependencies +* [helm fetch](helm_fetch.md) - download a chart from a repository and (optionally) unpack it in local directory +* [helm get](helm_get.md) - download a named release +* [helm history](helm_history.md) - fetch release history +* [helm home](helm_home.md) - displays the location of HELM_HOME +* [helm init](helm_init.md) - initialize Helm on both client and server +* [helm inspect](helm_inspect.md) - inspect a chart +* [helm install](helm_install.md) - install a chart archive +* [helm lint](helm_lint.md) - examines a chart for possible issues +* [helm list](helm_list.md) - list releases +* [helm package](helm_package.md) - package a chart directory into a chart archive +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories +* [helm rollback](helm_rollback.md) - roll back a release to a previous revision +* [helm search](helm_search.md) - search for a keyword in charts +* [helm serve](helm_serve.md) - start a local http web server +* [helm status](helm_status.md) - displays the status of the named release +* [helm upgrade](helm_upgrade.md) - upgrade a release +* [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 31-Oct-2016 diff --git a/docs/helm/helm_create.md b/docs/helm/helm_create.md new file mode 100644 index 000000000..297de4f85 --- /dev/null +++ b/docs/helm/helm_create.md @@ -0,0 +1,49 @@ +## helm create + +create a new chart with the given name + +### Synopsis + + + +This command creates a chart directory along with the common files and +directories used in a chart. + +For example, 'helm create foo' will create a directory structure that looks +something like this: + + foo/ + | + |- .helmignore # Contains patterns to ignore when packaging Helm charts. + | + |- Chart.yaml # Information about your chart + | + |- values.yaml # The default values for your templates + | + |- charts/ # Charts that this chart depends on + | + |- templates/ # The template files + +'helm create' takes a path for an argument. If directories in the given path +do not exist, Helm will attempt to create them as it goes. If the given +destination exists and there are files in that directory, conflicting files +will be overwritten, but other files will be left alone. + + +``` +helm create NAME +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_delete.md b/docs/helm/helm_delete.md new file mode 100644 index 000000000..79e5be3c3 --- /dev/null +++ b/docs/helm/helm_delete.md @@ -0,0 +1,40 @@ +## helm delete + +given a release name, delete the release from Kubernetes + +### Synopsis + + + +This command takes a release name, and then deletes the release from Kubernetes. +It removes all of the resources associated with the last release of the chart. + +Use the '--dry-run' flag to see which releases will be deleted without actually +deleting them. + + +``` +helm delete [flags] RELEASE_NAME [...] +``` + +### Options + +``` + --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 +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_dependency.md b/docs/helm/helm_dependency.md new file mode 100644 index 000000000..5495516b8 --- /dev/null +++ b/docs/helm/helm_dependency.md @@ -0,0 +1,58 @@ +## helm dependency + +manage a chart's dependencies + +### Synopsis + + + +Manage the dependencies of a chart. + +Helm charts store their dependencies in 'charts/'. For chart developers, it is +often easier to manage a single dependency file ('requirements.yaml') +which declares all dependencies. + +The dependency commands operate on that file, making it easy to synchronize +between the desired dependencies and the actual dependencies stored in the +'charts/' directory. + +A 'requirements.yaml' file is a YAML file in which developers can declare chart +dependencies, along with the location of the chart and the desired version. +For example, this requirements file declares two dependencies: + + # requirements.yaml + dependencies: + - name: nginx + version: "1.2.3" + repository: "https://example.com/charts" + - name: memcached + version: "3.2.1" + repository: "https://another.example.com/charts" + +The 'name' should be the name of a chart, where that name must match the name +in that chart's 'Chart.yaml' file. + +The 'version' field should contain a semantic version or version range. + +The 'repository' URL should point to a Chart Repository. Helm expects that by +appending '/index.yaml' to the URL, it should be able to retrieve the chart +repository's index. Note: 'repository' cannot be a repository alias. It must be +a URL. + + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. +* [helm dependency build](helm_dependency_build.md) - rebuild the charts/ directory based on the requirements.lock file +* [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 31-Oct-2016 diff --git a/docs/helm/helm_dependency_build.md b/docs/helm/helm_dependency_build.md new file mode 100644 index 000000000..1929fb7fd --- /dev/null +++ b/docs/helm/helm_dependency_build.md @@ -0,0 +1,42 @@ +## helm dependency build + +rebuild the charts/ directory based on the requirements.lock file + +### Synopsis + + + +Build out the charts/ directory from the requirements.lock file. + +Build is used to reconstruct a chart's dependencies to the state specified in +the lock file. This will not re-negotiate dependencies, as 'helm dependency update' +does. + +If no lock file is found, 'helm dependency build' will mirror the behavior +of 'helm dependency update'. + + +``` +helm dependency build [flags] CHART +``` + +### Options + +``` + --keyring string keyring containing public keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --verify verify the packages against signatures +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_dependency_list.md b/docs/helm/helm_dependency_list.md new file mode 100644 index 000000000..bb0178f8c --- /dev/null +++ b/docs/helm/helm_dependency_list.md @@ -0,0 +1,34 @@ +## helm dependency list + +list the dependencies for the given chart + +### Synopsis + + + +List all of the dependencies declared in a chart. + +This can take chart archives and chart directories as input. It will not alter +the contents of a chart. + +This will produce an error if the chart cannot be loaded. It will emit a warning +if it cannot find a requirements.yaml. + + +``` +helm dependency list [flags] CHART +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_dependency_update.md b/docs/helm/helm_dependency_update.md new file mode 100644 index 000000000..0ade8de17 --- /dev/null +++ b/docs/helm/helm_dependency_update.md @@ -0,0 +1,41 @@ +## helm dependency update + +update charts/ based on the contents of requirements.yaml + +### Synopsis + + + +Update the on-disk dependencies to mirror the requirements.yaml file. + +This command verifies that the required charts, as expressed in 'requirements.yaml', +are present in 'charts/' and are at an acceptable version. + +On successful update, this will generate a lock file that can be used to +rebuild the requirements to an exact version. + + +``` +helm dependency update [flags] CHART +``` + +### Options + +``` + --keyring string keyring containing public keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --verify verify the packages against signatures +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_fetch.md b/docs/helm/helm_fetch.md new file mode 100644 index 000000000..2679e9a34 --- /dev/null +++ b/docs/helm/helm_fetch.md @@ -0,0 +1,50 @@ +## helm fetch + +download a chart from a repository and (optionally) unpack it in local directory + +### Synopsis + + + +Retrieve a package from a package repository, and download it locally. + +This is useful for fetching packages to inspect, modify, or repackage. It can +also be used to perform cryptographic verification of a chart without installing +the chart. + +There are options for unpacking the chart after download. This will create a +directory for the chart and uncomparess into that directory. + +If the --verify flag is specified, the requested chart MUST have a provenance +file, and MUST pass the verification process. Failure in any part of this will +result in an error, and the chart will not be saved locally. + + +``` +helm fetch [flags] [chart URL | repo/chartname] [...] +``` + +### Options + +``` + -d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".") + --keyring string keyring containing public keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --untar if set to true, will untar the chart after downloading it + --untardir string if untar is specified, this flag specifies the name of the directory into which the chart is expanded (default ".") + --verify verify the package against its signature + --version string specific version of a chart. Without this, the latest version is fetched +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_get.md b/docs/helm/helm_get.md new file mode 100644 index 000000000..0f632b6aa --- /dev/null +++ b/docs/helm/helm_get.md @@ -0,0 +1,46 @@ +## helm get + +download a named release + +### Synopsis + + + +This command shows the details of a named release. + +It can be used to get extended information about the release, including: + + - The values used to generate the release + - The chart used to generate the release + - The generated manifest file + +By default, this prints a human readable collection of information about the +chart, the supplied values, and the generated manifest file. + + +``` +helm get [flags] RELEASE_NAME +``` + +### Options + +``` + --revision value get the named release with revision +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. +* [helm get hooks](helm_get_hooks.md) - download all hooks for a named release +* [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 31-Oct-2016 diff --git a/docs/helm/helm_get_hooks.md b/docs/helm/helm_get_hooks.md new file mode 100644 index 000000000..e05a4f8de --- /dev/null +++ b/docs/helm/helm_get_hooks.md @@ -0,0 +1,36 @@ +## helm get hooks + +download all hooks for a named release + +### Synopsis + + + +This command downloads hooks for a given release. + +Hooks are formatted in YAML and separated by the YAML '---\n' separator. + + +``` +helm get hooks [flags] RELEASE_NAME +``` + +### Options + +``` + --revision value get the named release with revision +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm get](helm_get.md) - download a named release + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_get_manifest.md b/docs/helm/helm_get_manifest.md new file mode 100644 index 000000000..86d0a7bd0 --- /dev/null +++ b/docs/helm/helm_get_manifest.md @@ -0,0 +1,38 @@ +## helm get manifest + +download the manifest for a named release + +### Synopsis + + + +This command fetches the generated manifest for a given release. + +A manifest is a YAML-encoded representation of the Kubernetes resources that +were generated from this release's chart(s). If a chart is dependent on other +charts, those resources will also be included in the manifest. + + +``` +helm get manifest [flags] RELEASE_NAME +``` + +### Options + +``` + --revision value get the named release with revision +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm get](helm_get.md) - download a named release + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_get_values.md b/docs/helm/helm_get_values.md new file mode 100644 index 000000000..4a6be5660 --- /dev/null +++ b/docs/helm/helm_get_values.md @@ -0,0 +1,35 @@ +## helm get values + +download the values file for a named release + +### Synopsis + + + +This command downloads a values file for a given release. + + +``` +helm get values [flags] RELEASE_NAME +``` + +### Options + +``` + -a, --all dump all (computed) values + --revision value get the named release with revision +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm get](helm_get.md) - download a named release + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_history.md b/docs/helm/helm_history.md new file mode 100644 index 000000000..e64a35b44 --- /dev/null +++ b/docs/helm/helm_history.md @@ -0,0 +1,46 @@ +## helm history + +fetch release history + +### Synopsis + + + +History prints historical revisions for a given release. + +A default maximum of 256 revisions will be returned. Setting '--max' +configures the maximum length of the revision list returned. + +The historical release set is printed as a formatted table, e.g: + + $ helm history angry-bird --max=4 + REVISION UPDATED STATUS CHART + 1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 + 2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 + 3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 + 4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine-0.1.0 + + +``` +helm history [flags] RELEASE_NAME +``` + +### Options + +``` + --max value maximum number of revision to include in history (default 256) +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_home.md b/docs/helm/helm_home.md new file mode 100644 index 000000000..32da0292d --- /dev/null +++ b/docs/helm/helm_home.md @@ -0,0 +1,29 @@ +## helm home + +displays the location of HELM_HOME + +### Synopsis + + + +This command displays the location of HELM_HOME. This is where +any helm configuration files live. + + +``` +helm home +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_init.md b/docs/helm/helm_init.md new file mode 100644 index 000000000..faba870c2 --- /dev/null +++ b/docs/helm/helm_init.md @@ -0,0 +1,54 @@ +## helm init + +initialize Helm on both client and server + +### Synopsis + + + +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 +deployment. + +When installing Tiller, 'helm init' will attempt to install the latest released +version. You can specify an alternative image with '--tiller-image'. For those +frequently working on the latest code, the flag '--canary-image' will install +the latest pre-release version of Tiller (e.g. the HEAD commit in the GitHub +repository on the master branch). + +To dump a manifest containing the Tiller deployment YAML, combine the +'--dry-run' and '--debug' flags. + + +``` +helm init +``` + +### Options + +``` + --canary-image use the canary tiller image + -c, --client-only if set does not install tiller + --dry-run do not install local or remote + -i, --tiller-image string override tiller image +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_inspect.md b/docs/helm/helm_inspect.md new file mode 100644 index 000000000..697742f4b --- /dev/null +++ b/docs/helm/helm_inspect.md @@ -0,0 +1,41 @@ +## helm inspect + +inspect a chart + +### Synopsis + + + +This command inspects a chart and displays information. It takes a chart reference +('stable/drupal'), a full path to a directory or packaged chart, or a URL. + +Inspect prints the contents of the Chart.yaml file and the values.yaml file. + + +``` +helm inspect [CHART] +``` + +### Options + +``` + --keyring string path to the keyring containing public verification keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --verify verify the provenance data for this chart + --version string version of the chart. By default, the newest chart is shown +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. +* [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 31-Oct-2016 diff --git a/docs/helm/helm_inspect_chart.md b/docs/helm/helm_inspect_chart.md new file mode 100644 index 000000000..082c2e287 --- /dev/null +++ b/docs/helm/helm_inspect_chart.md @@ -0,0 +1,37 @@ +## helm inspect chart + +shows inspect chart + +### Synopsis + + + +This command inspects a chart (directory, file, or URL) and displays the contents +of the Charts.yaml file + + +``` +helm inspect chart [CHART] +``` + +### Options + +``` + --keyring string path to the keyring containing public verification keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --verify verify the provenance data for this chart + --version string version of the chart. By default, the newest chart is shown +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm inspect](helm_inspect.md) - inspect a chart + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_inspect_values.md b/docs/helm/helm_inspect_values.md new file mode 100644 index 000000000..1fe34a319 --- /dev/null +++ b/docs/helm/helm_inspect_values.md @@ -0,0 +1,37 @@ +## helm inspect values + +shows inspect values + +### Synopsis + + + +This command inspects a chart (directory, file, or URL) and displays the contents +of the values.yaml file + + +``` +helm inspect values [CHART] +``` + +### Options + +``` + --keyring string path to the keyring containing public verification keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --verify verify the provenance data for this chart + --version string version of the chart. By default, the newest chart is shown +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm inspect](helm_inspect.md) - inspect a chart + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_install.md b/docs/helm/helm_install.md new file mode 100644 index 000000000..167c51b85 --- /dev/null +++ b/docs/helm/helm_install.md @@ -0,0 +1,84 @@ +## helm install + +install a chart archive + +### Synopsis + + + +This command installs a chart archive. + +The install argument must be either a relative path to a chart directory or the +name of a chart in the current working directory. + +To override values in a chart, use either the '--values' flag and pass in a file +or use the '--set' flag and pass configuration from the command line. + + $ helm install -f myvalues.yaml ./redis + +or + + $ helm install --set name=prod ./redis + +To check the generated manifests of a release without installing the chart, +the '--debug' and '--dry-run' flags can be combined. This will still require a +round-trip to the Tiller server. + +If --verify is set, the chart MUST have a provenance file, and the provenenace +fall MUST pass all verification steps. + +There are four different ways you can express the chart you want to install: + +1. By chart reference: helm install stable/mariadb +2. By path to a packaged chart: helm install ./nginx-1.2.3.tgz +3. By path to an unpacked chart directory: helm install ./nginx +4. By absolute URL: helm install https://example.com/charts/nginx-1.2.3.tgz + +CHART REFERENCES + +A chart reference is a convenient way of reference a chart in a chart repository. + +When you use a chart reference ('stable/mariadb'), Helm will look in the local +configuration for a chart repository named 'stable', and will then look for a +chart in that repository whose name is 'mariadb'. It will install the latest +version of that chart unless you also supply a version number with the +'--version' flag. + +To see the list of chart repositories, use 'helm repo list'. To search for +charts in a repository, use 'helm search'. + + +``` +helm install [CHART] +``` + +### Options + +``` + --dry-run simulate an install + --keyring string location of public keys used for verification (default "/Users/mattbutcher/.gnupg/pubring.gpg") + -n, --name string release name. If unspecified, it will autogenerate one for you + --name-template string specify template used to name the release + --namespace string namespace to install the release into + --no-hooks prevent hooks from running during install + --replace re-use the given name, even if that name is already used. This is unsafe in production + --set value set values on the command line. Separate values with commas: key1=val1,key2=val2 (default null +) + -f, --values string specify values in a YAML file + --verify verify the package before installing it + --version string specify the exact chart version to install. If this is not specified, the latest version is installed +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_lint.md b/docs/helm/helm_lint.md new file mode 100644 index 000000000..33bf4c909 --- /dev/null +++ b/docs/helm/helm_lint.md @@ -0,0 +1,39 @@ +## helm lint + +examines a chart for possible issues + +### Synopsis + + + +This command takes a path to a chart and runs a series of tests to verify that +the chart is well-formed. + +If the linter encounters things that will cause the chart to fail installation, +it will emit [ERROR] messages. If it encounters issues that break with convention +or recommendation, it will emit [WARNING] messages. + + +``` +helm lint [flags] PATH +``` + +### Options + +``` + --strict fail on lint warnings +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_list.md b/docs/helm/helm_list.md new file mode 100644 index 000000000..c027fe059 --- /dev/null +++ b/docs/helm/helm_list.md @@ -0,0 +1,65 @@ +## helm list + +list releases + +### Synopsis + + + +This command lists all of the releases. + +By default, it lists only releases that are deployed or failed. Flags like +'--delete' and '--all' will alter this behavior. Such flags can be combined: +'--deleted --failed'. + +By default, items are sorted alphabetically. Use the '-d' flag to sort by +release date. + +If an argument is provided, it will be treated as a filter. Filters are +regular expressions (Perl compatible) that are applied to the list of releases. +Only items that match the filter will be returned. + + $ helm list 'ara[a-z]+' + NAME UPDATED CHART + 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 +the case of no '-q' flag, only headers). + +By default, up to 256 items may be returned. To limit this, use the '--max' flag. +Setting '--max' to 0 will not return all results. Rather, it will return the +server's default, which may be much higher than 256. Pairing the '--max' +flag with the '--offset' flag allows you to page through results. + + +``` +helm list [flags] [FILTER] +``` + +### Options + +``` + --all show all releases, not just the ones marked DEPLOYED + -d, --date sort by release date + --deleted show deleted releases + --deployed show deployed releases. If no other is specified, this will be automatically enabled + --failed show failed releases + -m, --max int maximum number of releases to fetch (default 256) + -o, --offset string next release name in the list, used to offset from start value + -r, --reverse reverse the sort order + -q, --short output short (quiet) listing format +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_package.md b/docs/helm/helm_package.md new file mode 100644 index 000000000..607413352 --- /dev/null +++ b/docs/helm/helm_package.md @@ -0,0 +1,44 @@ +## helm package + +package a chart directory into a chart archive + +### Synopsis + + + +This command packages a chart into a versioned chart archive file. If a path +is given, this will look at that path for a chart (which must contain a +Chart.yaml file) and then package that directory. + +If no path is given, this will look in the present working directory for a +Chart.yaml file, and (if found) build the current directory into a chart. + +Versioned chart archives are used by Helm package repositories. + + +``` +helm package [flags] [CHART_PATH] [...] +``` + +### Options + +``` + --key string name of the key to use when signing. Used if --sign is true + --keyring string location of a public keyring (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --save save packaged chart to local chart repository (default true) + --sign use a PGP private key to sign this package +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo.md b/docs/helm/helm_repo.md new file mode 100644 index 000000000..932ee41f0 --- /dev/null +++ b/docs/helm/helm_repo.md @@ -0,0 +1,33 @@ +## helm repo + +add, list, remove, update, and index chart repositories + +### Synopsis + + + +This command consists of multiple subcommands to interact with chart repositories. + +It can be used to add, remove, list, and index chart repositories. +Example usage: + $ helm repo add [NAME] [REPO_URL] + + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. +* [helm repo add](helm_repo_add.md) - add a chart repository +* [helm repo index](helm_repo_index.md) - generate an index file given a directory containing packaged charts +* [helm repo list](helm_repo_list.md) - list chart repositories +* [helm repo remove](helm_repo_remove.md) - remove a chart repository +* [helm repo update](helm_repo_update.md) - update information on available charts in the chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo_add.md b/docs/helm/helm_repo_add.md new file mode 100644 index 000000000..d207c99cf --- /dev/null +++ b/docs/helm/helm_repo_add.md @@ -0,0 +1,32 @@ +## helm repo add + +add a chart repository + +### Synopsis + + +add a chart repository + +``` +helm repo add [flags] [NAME] [URL] +``` + +### Options + +``` + --no-update raise error if repo is already registered +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo_index.md b/docs/helm/helm_repo_index.md new file mode 100644 index 000000000..6f894465a --- /dev/null +++ b/docs/helm/helm_repo_index.md @@ -0,0 +1,42 @@ +## helm repo index + +generate an index file given a directory containing packaged charts + +### Synopsis + + + +Read the current directory and generate an index file based on the charts found. + +This tool is used for creating an 'index.yaml' file for a chart repository. To +set an absolute URL to the charts, use '--url' flag. + +To merge the generated index with an existing index file, use the '--merge' +flag. In this case, the charts found in the current directory will be merged +into the existing index, with local charts taking priority over existing charts. + + +``` +helm repo index [flags] [DIR] +``` + +### Options + +``` + --merge string merge the generated index into the given index + --url string url of chart repository +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo_list.md b/docs/helm/helm_repo_list.md new file mode 100644 index 000000000..ada63b98f --- /dev/null +++ b/docs/helm/helm_repo_list.md @@ -0,0 +1,26 @@ +## helm repo list + +list chart repositories + +### Synopsis + + +list chart repositories + +``` +helm repo list [flags] +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo_remove.md b/docs/helm/helm_repo_remove.md new file mode 100644 index 000000000..46d97e27e --- /dev/null +++ b/docs/helm/helm_repo_remove.md @@ -0,0 +1,26 @@ +## helm repo remove + +remove a chart repository + +### Synopsis + + +remove a chart repository + +``` +helm repo remove [flags] [NAME] +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_repo_update.md b/docs/helm/helm_repo_update.md new file mode 100644 index 000000000..98f3ecd9d --- /dev/null +++ b/docs/helm/helm_repo_update.md @@ -0,0 +1,32 @@ +## helm repo update + +update information on available charts in the chart repositories + +### Synopsis + + + +Update gets the latest information about charts from the respective chart repositories. +Information is cached locally, where it is used by commands like 'helm search'. + +'helm update' is the deprecated form of 'helm repo update'. It will be removed in +future releases. + + +``` +helm repo update +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_rollback.md b/docs/helm/helm_rollback.md new file mode 100644 index 000000000..895103345 --- /dev/null +++ b/docs/helm/helm_rollback.md @@ -0,0 +1,36 @@ +## helm rollback + +roll back a release to a previous revision + +### Synopsis + + + +This command rolls back a release to the previous revision. +The argument of the rollback command is the name of a release. + + +``` +helm rollback [RELEASE] +``` + +### Options + +``` + --dry-run simulate a rollback + --no-hooks prevent hooks from running during rollback +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_search.md b/docs/helm/helm_search.md new file mode 100644 index 000000000..8c9bae66f --- /dev/null +++ b/docs/helm/helm_search.md @@ -0,0 +1,38 @@ +## helm search + +search for a keyword in charts + +### Synopsis + + + +Search reads through all of the repositories configured on the system, and +looks for matches. + +Repositories are managed with 'helm repo' commands. + + +``` +helm search [keyword] +``` + +### Options + +``` + -r, --regexp use regular expressions for searching + -l, --versions show the long listing, with each version of each chart on its own line +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_serve.md b/docs/helm/helm_serve.md new file mode 100644 index 000000000..4be46fa05 --- /dev/null +++ b/docs/helm/helm_serve.md @@ -0,0 +1,39 @@ +## helm serve + +start a local http web server + +### Synopsis + + + +This command starts a local chart repository server that serves charts from a local directory. + +The new server will provide HTTP access to a repository. By default, it will +scan all of the charts in '$HELM_HOME/repository/local' and serve those over +the a local IPv4 TCP port (default '127.0.0.1:8879'). + + +``` +helm serve +``` + +### Options + +``` + --address string address to listen on (default "127.0.0.1:8879") + --repo-path string local directory path from which to serve charts (default "/Users/mattbutcher/Code/helm_home/repository/local") +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_status.md b/docs/helm/helm_status.md new file mode 100644 index 000000000..8d31e347b --- /dev/null +++ b/docs/helm/helm_status.md @@ -0,0 +1,34 @@ +## helm status + +displays the status of the named release + +### Synopsis + + + +This command shows the status of a named release. + + +``` +helm status [flags] RELEASE_NAME +``` + +### Options + +``` + --revision value if set, display the status of the named release with revision +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_upgrade.md b/docs/helm/helm_upgrade.md new file mode 100644 index 000000000..1a5f979a6 --- /dev/null +++ b/docs/helm/helm_upgrade.md @@ -0,0 +1,51 @@ +## helm upgrade + +upgrade a release + +### Synopsis + + + +This command upgrades a release to a new version of a chart. + +The upgrade arguments must be a release and chart. The chart +argument can be either: a chart reference('stable/mariadb'), a path to a chart directory, +a packaged chart, or a fully qualified URL. For chart references, the latest +version will be specified unless the '--version' flag is set. + +To override values in a chart, use either the '--values' flag and pass in a file +or use the '--set' flag and pass configuration from the command line. + + +``` +helm upgrade [RELEASE] [CHART] +``` + +### Options + +``` + --disable-hooks disable pre/post upgrade hooks + --dry-run simulate an upgrade + -i, --install if a release by this name doesn't already exist, run an install + --keyring string path to the keyring that contains public singing keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") + --namespace string namespace to install the release into (only used if --install is set) (default "default") + --set value set values on the command line. Separate values with commas: key1=val1,key2=val2 (default null +) + -f, --values string path to a values YAML file + --verify verify the provenance of the chart before upgrading + --version string specify the exact chart version to use. If this is not specified, the latest version is used +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_verify.md b/docs/helm/helm_verify.md new file mode 100644 index 000000000..3732abd70 --- /dev/null +++ b/docs/helm/helm_verify.md @@ -0,0 +1,41 @@ +## helm verify + +verify that a chart at the given path has been signed and is valid + +### Synopsis + + + +Verify that the given chart has a valid provenance file. + +Provenance files provide crytographic verification that a chart has not been +tampered with, and was packaged by a trusted provider. + +This command can be used to verify a local chart. Several other commands provide +'--verify' flags that run the same validation. To generate a signed package, use +the 'helm package --sign' command. + + +``` +helm verify [flags] PATH +``` + +### Options + +``` + --keyring string keyring containing public keys (default "/Users/mattbutcher/.gnupg/pubring.gpg") +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016 diff --git a/docs/helm/helm_version.md b/docs/helm/helm_version.md new file mode 100644 index 000000000..101f4dc8d --- /dev/null +++ b/docs/helm/helm_version.md @@ -0,0 +1,49 @@ +## helm version + +print the client/server version information + +### Synopsis + + + +Show the client and server versions for Helm and tiller. + +This will print a representation of the client and server versions of Helm and +Tiller. The output will look something like this: + +Client: &version.Version{SemVer:"v2.0.0-beta.1", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"dirty"} +Server: &version.Version{SemVer:"v2.0.0-beta.1", GitCommit:"b0c113dfb9f612a9add796549da66c0d294508a3", GitTreeState:"clean"} + +- SemVer is the semantic version of the release. +- GitCommit is the SHA for the commit that this version was built from. +- GitTreeState is "clean" if there are no local code changes when this binary was + built, and "dirty" if the binary was built from locally modified code. + +To print just the client version, use '--client'. To print just the server version, +use '--server'. + + +``` +helm version +``` + +### Options + +``` + -c, --client if set, show the client version + -s, --server if set, show the server version +``` + +### Options inherited from parent commands + +``` + --debug enable verbose output + --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/mattbutcher/Code/helm_home") + --host string address of tiller. Overrides $HELM_HOST + --kube-context string name of the kubeconfig context to use +``` + +### SEE ALSO +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 31-Oct-2016