mirror of https://github.com/helm/helm
Merge pull request #1484 from technosophos/feat/documentation-generator
feat(helm): add command to generate documentationpull/1599/head
Matt Butcher
9 years ago
committed by
GitHub
commit
7a15ad381e
@ -0,0 +1,80 @@
|
||||
/*
|
||||
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/spf13/cobra/doc"
|
||||
)
|
||||
|
||||
const docsDesc = `
|
||||
Generate documentation files for Helm.
|
||||
|
||||
This command can generate documentation for Helm in the following formats:
|
||||
|
||||
- Markdown
|
||||
- Man pages
|
||||
|
||||
It can also generate bash autocompletions.
|
||||
|
||||
$ helm docs markdown -dir mydocs/
|
||||
`
|
||||
|
||||
type docsCmd struct {
|
||||
out io.Writer
|
||||
dest string
|
||||
docTypeString string
|
||||
topCmd *cobra.Command
|
||||
}
|
||||
|
||||
func newDocsCmd(out io.Writer, topCmd *cobra.Command) *cobra.Command {
|
||||
dc := &docsCmd{out: out, topCmd: topCmd}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "docs",
|
||||
Short: "Generate documentation as markdown or man pages",
|
||||
Long: docsDesc,
|
||||
Hidden: true,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
dc.run()
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
f := cmd.Flags()
|
||||
f.StringVar(&dc.dest, "dir", "./", "directory to which documentation is written")
|
||||
f.StringVar(&dc.docTypeString, "type", "markdown", "the type of documentation to generate (markdown, man, bash)")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
func (d *docsCmd) run() error {
|
||||
switch d.docTypeString {
|
||||
case "markdown", "mdown", "md":
|
||||
return doc.GenMarkdownTree(d.topCmd, d.dest)
|
||||
case "man":
|
||||
manHdr := &doc.GenManHeader{Title: "HELM", Section: "1"}
|
||||
return doc.GenManTree(d.topCmd, manHdr, d.dest)
|
||||
case "bash":
|
||||
return d.topCmd.GenBashCompletionFile(filepath.Join(d.dest, "completions.bash"))
|
||||
default:
|
||||
return fmt.Errorf("unknown doc type %q. Try 'markdown' or 'man'", d.docTypeString)
|
||||
}
|
||||
}
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -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 1-Nov-2016
|
||||
@ -0,0 +1,79 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm \- The Helm package manager for Kubernetes.
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The Kubernetes package manager
|
||||
|
||||
.PP
|
||||
To begin working with Helm, run the 'helm init' command:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ helm init
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
This will install Tiller to your running Kubernetes cluster.
|
||||
It will also set up any necessary local configuration.
|
||||
|
||||
.PP
|
||||
Common actions from this point include:
|
||||
.IP \(bu 2
|
||||
helm search: search for charts
|
||||
.IP \(bu 2
|
||||
helm fetch: download a chart to your local directory to view
|
||||
.IP \(bu 2
|
||||
helm install: upload the chart to Kubernetes
|
||||
.IP \(bu 2
|
||||
helm list: list releases of charts
|
||||
|
||||
.PP
|
||||
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")
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,76 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-create \- create a new chart with the given name
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm create NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command creates a chart directory along with the common files and
|
||||
directories used in a chart.
|
||||
|
||||
.PP
|
||||
For example, 'helm create foo' will create a directory structure that looks
|
||||
something like this:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
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
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\&'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.
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,65 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-delete \- given a release name, delete the release from Kubernetes
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm delete [flags] RELEASE\_NAME [...]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
Use the '\-\-dry\-run' flag to see which releases will be deleted without actually
|
||||
deleting them.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-dry\-run\fP[=false]
|
||||
simulate a delete
|
||||
|
||||
.PP
|
||||
\fB\-\-no\-hooks\fP[=false]
|
||||
prevent hooks from running during deletion
|
||||
|
||||
.PP
|
||||
\fB\-\-purge\fP[=false]
|
||||
remove the release from the store and make its name free for later use
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,90 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-dependency \- manage a chart's dependencies
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm dependency update|build|list\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Manage the dependencies of a chart.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
# 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"
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The 'name' should be the name of a chart, where that name must match the name
|
||||
in that chart's 'Chart.yaml' file.
|
||||
|
||||
.PP
|
||||
The 'version' field should contain a semantic version or version range.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP, \fBhelm\-dependency\-build(1)\fP, \fBhelm\-dependency\-list(1)\fP, \fBhelm\-dependency\-update(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,65 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-dependency\-build \- rebuild the charts/ directory based on the requirements.lock file
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm dependency build [flags] CHART\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Build out the charts/ directory from the requirements.lock file.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
If no lock file is found, 'helm dependency build' will mirror the behavior
|
||||
of 'helm dependency update'.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
keyring containing public keys
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the packages against signatures
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-dependency(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,54 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-dependency\-list \- list the dependencies for the given chart
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm dependency list [flags] CHART\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
List all of the dependencies declared in a chart.
|
||||
|
||||
.PP
|
||||
This can take chart archives and chart directories as input. It will not alter
|
||||
the contents of a chart.
|
||||
|
||||
.PP
|
||||
This will produce an error if the chart cannot be loaded. It will emit a warning
|
||||
if it cannot find a requirements.yaml.
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-dependency(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,64 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-dependency\-update \- update charts/ based on the contents of requirements.yaml
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm dependency update [flags] CHART\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Update the on\-disk dependencies to mirror the requirements.yaml file.
|
||||
|
||||
.PP
|
||||
This command verifies that the required charts, as expressed in 'requirements.yaml',
|
||||
are present in 'charts/' and are at an acceptable version.
|
||||
|
||||
.PP
|
||||
On successful update, this will generate a lock file that can be used to
|
||||
rebuild the requirements to an exact version.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
keyring containing public keys
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the packages against signatures
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-dependency(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,86 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-fetch \- download a chart from a repository and (optionally) unpack it in local directory
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm fetch [flags] [chart URL | repo/chartname] [...]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Retrieve a package from a package repository, and download it locally.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
There are options for unpacking the chart after download. This will create a
|
||||
directory for the chart and uncomparess into that directory.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-d\fP, \fB\-\-destination\fP="."
|
||||
location to write the chart. If this and tardir are specified, tardir is appended to this
|
||||
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
keyring containing public keys
|
||||
|
||||
.PP
|
||||
\fB\-\-untar\fP[=false]
|
||||
if set to true, will untar the chart after downloading it
|
||||
|
||||
.PP
|
||||
\fB\-\-untardir\fP="."
|
||||
if untar is specified, this flag specifies the name of the directory into which the chart is expanded
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the package against its signature
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
specific version of a chart. Without this, the latest version is fetched
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,65 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-get \- download a named release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm get [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command shows the details of a named release.
|
||||
|
||||
.PP
|
||||
It can be used to get extended information about the release, including:
|
||||
.IP \(bu 2
|
||||
The values used to generate the release
|
||||
.IP \(bu 2
|
||||
The chart used to generate the release
|
||||
.IP \(bu 2
|
||||
The generated manifest file
|
||||
|
||||
.PP
|
||||
By default, this prints a human readable collection of information about the
|
||||
chart, the supplied values, and the generated manifest file.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-revision\fP=0
|
||||
get the named release with revision
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP, \fBhelm\-get\-hooks(1)\fP, \fBhelm\-get\-manifest(1)\fP, \fBhelm\-get\-values(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,55 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-get\-hooks \- download all hooks for a named release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm get hooks [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command downloads hooks for a given release.
|
||||
|
||||
.PP
|
||||
Hooks are formatted in YAML and separated by the YAML '\-\-\-\\n' separator.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-revision\fP=0
|
||||
get the named release with revision
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-get(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,57 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-get\-manifest \- download the manifest for a named release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm get manifest [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command fetches the generated manifest for a given release.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-revision\fP=0
|
||||
get the named release with revision
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-get(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,56 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-get\-values \- download the values file for a named release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm get values [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command downloads a values file for a given release.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-a\fP, \fB\-\-all\fP[=false]
|
||||
dump all (computed) values
|
||||
|
||||
.PP
|
||||
\fB\-\-revision\fP=0
|
||||
get the named release with revision
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-get(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,73 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-history \- fetch release history
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm history [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
History prints historical revisions for a given release.
|
||||
|
||||
.PP
|
||||
A default maximum of 256 revisions will be returned. Setting '\-\-max'
|
||||
configures the maximum length of the revision list returned.
|
||||
|
||||
.PP
|
||||
The historical release set is printed as a formatted table, e.g:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ 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
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-max\fP=256
|
||||
maximum number of revision to include in history
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,47 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-home \- displays the location of HELM\_HOME
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm home\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command displays the location of HELM\_HOME. This is where
|
||||
any helm configuration files live.
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,85 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-init \- initialize Helm on both client and server
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm init\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command installs Tiller (the helm server side component) onto your
|
||||
Kubernetes Cluster and sets up local configuration in $HELM\_HOME (default \~/.helm/)
|
||||
|
||||
.PP
|
||||
As with the rest of the Helm commands, 'helm init' discovers Kubernetes clusters
|
||||
by reading $KUBECONFIG (default '\~/.kube/config') and using the default context.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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).
|
||||
|
||||
.PP
|
||||
To dump a manifest containing the Tiller deployment YAML, combine the
|
||||
'\-\-dry\-run' and '\-\-debug' flags.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-canary\-image\fP[=false]
|
||||
use the canary tiller image
|
||||
|
||||
.PP
|
||||
\fB\-c\fP, \fB\-\-client\-only\fP[=false]
|
||||
if set does not install tiller
|
||||
|
||||
.PP
|
||||
\fB\-\-dry\-run\fP[=false]
|
||||
do not install local or remote
|
||||
|
||||
.PP
|
||||
\fB\-i\fP, \fB\-\-tiller\-image\fP=""
|
||||
override tiller image
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,64 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-inspect \- inspect a chart
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm inspect [CHART]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
Inspect prints the contents of the Chart.yaml file and the values.yaml file.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
path to the keyring containing public verification keys
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the provenance data for this chart
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
version of the chart. By default, the newest chart is shown
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP, \fBhelm\-inspect\-chart(1)\fP, \fBhelm\-inspect\-values(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,61 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-inspect\-chart \- shows inspect chart
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm inspect chart [CHART]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the Charts.yaml file
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
path to the keyring containing public verification keys
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the provenance data for this chart
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
version of the chart. By default, the newest chart is shown
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-inspect(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,61 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-inspect\-values \- shows inspect values
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm inspect values [CHART]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command inspects a chart (directory, file, or URL) and displays the contents
|
||||
of the values.yaml file
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
path to the keyring containing public verification keys
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the provenance data for this chart
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
version of the chart. By default, the newest chart is shown
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-inspect(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,167 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-install \- install a chart archive
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm install [CHART]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command installs a chart archive.
|
||||
|
||||
.PP
|
||||
The install argument must be either a relative path to a chart directory or the
|
||||
name of a chart in the current working directory.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ helm install \-f myvalues.yaml ./redis
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
or
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ helm install \-\-set name=prod ./redis
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
If \-\-verify is set, the chart MUST have a provenance file, and the provenenace
|
||||
fall MUST pass all verification steps.
|
||||
|
||||
.PP
|
||||
There are four different ways you can express the chart you want to install:
|
||||
.IP " 1." 5
|
||||
By chart reference: helm install stable/mariadb
|
||||
.IP " 2." 5
|
||||
By path to a packaged chart: helm install ./nginx\-1.2.3.tgz
|
||||
.IP " 3." 5
|
||||
By path to an unpacked chart directory: helm install ./nginx
|
||||
.IP " 4." 5
|
||||
By absolute URL: helm install
|
||||
\[la]https://example.com/charts/nginx-1.2.3.tgz\[ra]
|
||||
|
||||
.PP
|
||||
CHART REFERENCES
|
||||
|
||||
.PP
|
||||
A chart reference is a convenient way of reference a chart in a chart repository.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
To see the list of chart repositories, use 'helm repo list'. To search for
|
||||
charts in a repository, use 'helm search'.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-dry\-run\fP[=false]
|
||||
simulate an install
|
||||
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
location of public keys used for verification
|
||||
|
||||
.PP
|
||||
\fB\-n\fP, \fB\-\-name\fP=""
|
||||
release name. If unspecified, it will autogenerate one for you
|
||||
|
||||
.PP
|
||||
\fB\-\-name\-template\fP=""
|
||||
specify template used to name the release
|
||||
|
||||
.PP
|
||||
\fB\-\-namespace\fP=""
|
||||
namespace to install the release into
|
||||
|
||||
.PP
|
||||
\fB\-\-no\-hooks\fP[=false]
|
||||
prevent hooks from running during install
|
||||
|
||||
.PP
|
||||
\fB\-\-replace\fP[=false]
|
||||
re\-use the given name, even if that name is already used. This is unsafe in production
|
||||
|
||||
.PP
|
||||
\fB\-\-set\fP=null
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
set values on the command line. Separate values with commas: key1=val1,key2=val2
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\fB\-f\fP, \fB\-\-values\fP=""
|
||||
specify values in a YAML file
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the package before installing it
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
specify the exact chart version to install. If this is not specified, the latest version is installed
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,58 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-lint \- examines a chart for possible issues
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm lint [flags] PATH\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command takes a path to a chart and runs a series of tests to verify that
|
||||
the chart is well\-formed.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-strict\fP[=false]
|
||||
fail on lint warnings
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,119 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-list \- list releases
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm list [flags] [FILTER]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command lists all of the releases.
|
||||
|
||||
.PP
|
||||
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'.
|
||||
|
||||
.PP
|
||||
By default, items are sorted alphabetically. Use the '\-d' flag to sort by
|
||||
release date.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ helm list 'ara[a\-z]+'
|
||||
NAME UPDATED CHART
|
||||
maudlin\-arachnid Mon May 9 16:07:08 2016 alpine\-0.1.0
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
If no results are found, 'helm list' will exit 0, but with no output (or in
|
||||
the case of no '\-q' flag, only headers).
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-all\fP[=false]
|
||||
show all releases, not just the ones marked DEPLOYED
|
||||
|
||||
.PP
|
||||
\fB\-d\fP, \fB\-\-date\fP[=false]
|
||||
sort by release date
|
||||
|
||||
.PP
|
||||
\fB\-\-deleted\fP[=false]
|
||||
show deleted releases
|
||||
|
||||
.PP
|
||||
\fB\-\-deployed\fP[=false]
|
||||
show deployed releases. If no other is specified, this will be automatically enabled
|
||||
|
||||
.PP
|
||||
\fB\-\-failed\fP[=false]
|
||||
show failed releases
|
||||
|
||||
.PP
|
||||
\fB\-m\fP, \fB\-\-max\fP=256
|
||||
maximum number of releases to fetch
|
||||
|
||||
.PP
|
||||
\fB\-o\fP, \fB\-\-offset\fP=""
|
||||
next release name in the list, used to offset from start value
|
||||
|
||||
.PP
|
||||
\fB\-r\fP, \fB\-\-reverse\fP[=false]
|
||||
reverse the sort order
|
||||
|
||||
.PP
|
||||
\fB\-q\fP, \fB\-\-short\fP[=false]
|
||||
output short (quiet) listing format
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,73 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-package \- package a chart directory into a chart archive
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm package [flags] [CHART\_PATH] [...]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
Versioned chart archives are used by Helm package repositories.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-key\fP=""
|
||||
name of the key to use when signing. Used if \-\-sign is true
|
||||
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
location of a public keyring
|
||||
|
||||
.PP
|
||||
\fB\-\-save\fP[=true]
|
||||
save packaged chart to local chart repository
|
||||
|
||||
.PP
|
||||
\fB\-\-sign\fP[=false]
|
||||
use a PGP private key to sign this package
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,51 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo \- add, list, remove, update, and index chart repositories
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo [FLAGS] add|remove|list|index|update [ARGS]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command consists of multiple subcommands to interact with chart repositories.
|
||||
|
||||
.PP
|
||||
It can be used to add, remove, list, and index chart repositories.
|
||||
Example usage:
|
||||
$ helm repo add [NAME] [REPO\_URL]
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP, \fBhelm\-repo\-add(1)\fP, \fBhelm\-repo\-index(1)\fP, \fBhelm\-repo\-list(1)\fP, \fBhelm\-repo\-remove(1)\fP, \fBhelm\-repo\-update(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,52 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo\-add \- add a chart repository
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo add [flags] [NAME] [URL]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
add a chart repository
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-no\-update\fP[=false]
|
||||
raise error if repo is already registered
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-repo(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,65 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo\-index \- generate an index file given a directory containing packaged charts
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo index [flags] [DIR]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Read the current directory and generate an index file based on the charts found.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-merge\fP=""
|
||||
merge the generated index into the given index
|
||||
|
||||
.PP
|
||||
\fB\-\-url\fP=""
|
||||
url of chart repository
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-repo(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,46 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo\-list \- list chart repositories
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo list [flags]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
list chart repositories
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-repo(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,46 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo\-remove \- remove a chart repository
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo remove [flags] [NAME]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
remove a chart repository
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-repo(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,51 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-repo\-update \- update information on available charts in the chart repositories
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm repo update\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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'.
|
||||
|
||||
.PP
|
||||
\&'helm update' is the deprecated form of 'helm repo update'. It will be removed in
|
||||
future releases.
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm\-repo(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,57 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-rollback \- roll back a release to a previous revision
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm rollback [RELEASE]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command rolls back a release to the previous revision.
|
||||
The argument of the rollback command is the name of a release.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-dry\-run\fP[=false]
|
||||
simulate a rollback
|
||||
|
||||
.PP
|
||||
\fB\-\-no\-hooks\fP[=false]
|
||||
prevent hooks from running during rollback
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,60 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-search \- search for a keyword in charts
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm search [keyword]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Search reads through all of the repositories configured on the system, and
|
||||
looks for matches.
|
||||
|
||||
.PP
|
||||
Repositories are managed with 'helm repo' commands.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-r\fP, \fB\-\-regexp\fP[=false]
|
||||
use regular expressions for searching
|
||||
|
||||
.PP
|
||||
\fB\-l\fP, \fB\-\-versions\fP[=false]
|
||||
show the long listing, with each version of each chart on its own line
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,61 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-serve \- start a local http web server
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm serve\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command starts a local chart repository server that serves charts from a local directory.
|
||||
|
||||
.PP
|
||||
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').
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-address\fP="127.0.0.1:8879"
|
||||
address to listen on
|
||||
|
||||
.PP
|
||||
\fB\-\-repo\-path\fP="/Users/mattbutcher/Code/helm\_home/repository/local"
|
||||
local directory path from which to serve charts
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,52 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-status \- displays the status of the named release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm status [flags] RELEASE\_NAME\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command shows the status of a named release.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-revision\fP=0
|
||||
if set, display the status of the named release with revision
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,102 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-upgrade \- upgrade a release
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm upgrade [RELEASE] [CHART]\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This command upgrades a release to a new version of a chart.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-disable\-hooks\fP[=false]
|
||||
disable pre/post upgrade hooks
|
||||
|
||||
.PP
|
||||
\fB\-\-dry\-run\fP[=false]
|
||||
simulate an upgrade
|
||||
|
||||
.PP
|
||||
\fB\-i\fP, \fB\-\-install\fP[=false]
|
||||
if a release by this name doesn't already exist, run an install
|
||||
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
path to the keyring that contains public singing keys
|
||||
|
||||
.PP
|
||||
\fB\-\-namespace\fP="default"
|
||||
namespace to install the release into (only used if \-\-install is set)
|
||||
|
||||
.PP
|
||||
\fB\-\-set\fP=null
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
set values on the command line. Separate values with commas: key1=val1,key2=val2
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\fB\-f\fP, \fB\-\-values\fP=""
|
||||
path to a values YAML file
|
||||
|
||||
.PP
|
||||
\fB\-\-verify\fP[=false]
|
||||
verify the provenance of the chart before upgrading
|
||||
|
||||
.PP
|
||||
\fB\-\-version\fP=""
|
||||
specify the exact chart version to use. If this is not specified, the latest version is used
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,61 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-verify \- verify that a chart at the given path has been signed and is valid
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm verify [flags] PATH\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Verify that the given chart has a valid provenance file.
|
||||
|
||||
.PP
|
||||
Provenance files provide crytographic verification that a chart has not been
|
||||
tampered with, and was packaged by a trusted provider.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-\-keyring\fP="/Users/mattbutcher/.gnupg/pubring.gpg"
|
||||
keyring containing public keys
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
@ -0,0 +1,75 @@
|
||||
.TH "HELM" "1" "Nov 2016" "Auto generated by spf13/cobra" ""
|
||||
.nh
|
||||
.ad l
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
helm\-version \- print the client/server version information
|
||||
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fBhelm version\fP
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Show the client and server versions for Helm and tiller.
|
||||
|
||||
.PP
|
||||
This will print a representation of the client and server versions of Helm and
|
||||
Tiller. The output will look something like this:
|
||||
|
||||
.PP
|
||||
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"}
|
||||
.IP \(bu 2
|
||||
SemVer is the semantic version of the release.
|
||||
.IP \(bu 2
|
||||
GitCommit is the SHA for the commit that this version was built from.
|
||||
.IP \(bu 2
|
||||
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.
|
||||
|
||||
.PP
|
||||
To print just the client version, use '\-\-client'. To print just the server version,
|
||||
use '\-\-server'.
|
||||
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\fB\-c\fP, \fB\-\-client\fP[=false]
|
||||
if set, show the client version
|
||||
|
||||
.PP
|
||||
\fB\-s\fP, \fB\-\-server\fP[=false]
|
||||
if set, show the server version
|
||||
|
||||
|
||||
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||
.PP
|
||||
\fB\-\-debug\fP[=false]
|
||||
enable verbose output
|
||||
|
||||
.PP
|
||||
\fB\-\-home\fP="/Users/mattbutcher/Code/helm\_home"
|
||||
location of your Helm config. Overrides $HELM\_HOME
|
||||
|
||||
.PP
|
||||
\fB\-\-host\fP=""
|
||||
address of tiller. Overrides $HELM\_HOST
|
||||
|
||||
.PP
|
||||
\fB\-\-kube\-context\fP=""
|
||||
name of the kubeconfig context to use
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBhelm(1)\fP
|
||||
|
||||
|
||||
.SH HISTORY
|
||||
.PP
|
||||
1\-Nov\-2016 Auto generated by spf13/cobra
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in new issue