diff --git a/README.md b/README.md index e7bb94b113..c9d050290f 100755 --- a/README.md +++ b/README.md @@ -39,18 +39,18 @@ Since the release of Helm 3, all project documentation is located in this repo u For earlier versions, see the dev-v2 branch of the main Helm repo [here](https://github.com/helm/helm/tree/dev-v2/docs). + ### Updating the Helm CLI Reference Docs The documentation for the list of Helm CLI Commands are [exported](https://github.com/helm/helm/blob/a6b2c9e2126753f6f94df231e89b2153c2862764/cmd/helm/root.go#L169) from the main helm project repo and rendered [here on the website](https://helm.sh/docs/helm) as a reference. To update these docs, you'll need to: -1. Go to the `helm/helm` repo and fetch the latest master. -2. Run `helm docs --type markdown` to generate the markdown docs files -3. Copy the generated files (helm.md, helm_create.md, etc) -4. Return to the `helm/helm-www` repo and navigate to `content/en/docs/helm/` -5. Paste the latest CLI command docs here, replacing any prior markdown files -6. Commit the changes and create a PR to update the website. +1. Delete all plugins currently installed with `helm plugin uninstall` +2. Navigate to `content/en/docs/helm/` +3. Run `helm docs --type markdown` to generate the markdown docs files, replacing any prior markdown files +4. Add back the YAML front-matter to each file that was changed +5. Commit the changes and create a PR to update the website. ### How to Write a Blog Post @@ -59,6 +59,7 @@ Blog posts are created via pull requests. The following steps are used to add th 1) Add a new file to the `content/en/blog/` directory whose name is the published date and the title. The files must be markdown formatted. See the existing titles for examples of the format 2) Add the header meta-data to the file using this format (note the permalink structure). Recommended but optional fields are `authorname` which should be name(s); these are displayed verbatim. `authorlink` is the link used by `authorname`. + ```yaml --- title: "A Fancy Title" @@ -68,6 +69,7 @@ authorlink: "https://example.com" date: "yyyy-mm-dd" --- ``` + 3) Add the content below the `---` as Markdown. The title does not need to be included in this section 4) Any images should be placed in the `/content/en/blog/images/` directory. Images should be losslessly compressed to reduce their size. Tools, such as [ImageOptim](https://imageoptim.com/), can be used. 5) To summarize the content on the blog index page, insert a `` break in your markdown. This will truncate the content with a _Read More_ link. @@ -77,7 +79,9 @@ Blog PRs require approval from the core Helm [maintainers](https://github.com/he --- ### Code of Conduct + Participation in the Helm community is governed by the Helm [Code of Conduct](https://github.com/helm/helm/blob/master/code-of-conduct.md). ### Thank You! -We appreciate your contributions to our website and our documentation! :clap: \ No newline at end of file + +We appreciate your contributions to our website and our documentation! :clap: diff --git a/content/en/docs/helm/_index.md b/content/en/docs/helm/_index.md index 9a6b34c3a5..12b5febbe8 100644 --- a/content/en/docs/helm/_index.md +++ b/content/en/docs/helm/_index.md @@ -1,10 +1,10 @@ --- title: "Helm Commands" -description: "Documentation for the full list off helm CLI commands." +description: "Documentation for the full list of helm CLI commands." weight: 6 slug: helm --- # Helm Commands -Here you’ll find the list of CLI commands for Helm, with help info on their usage. \ No newline at end of file +Here you’ll find the list of CLI commands for Helm, with help info on their usage. diff --git a/content/en/docs/helm/helm.md b/content/en/docs/helm/helm.md index b5ec824ce3..ff4f21ed0f 100644 --- a/content/en/docs/helm/helm.md +++ b/content/en/docs/helm/helm.md @@ -1,6 +1,5 @@ --- title: "Helm" -weight: 1 --- ## helm @@ -9,67 +8,94 @@ 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: +Common actions for Helm: - helm search: search for charts -- helm fetch: download a chart to your local directory to view +- helm pull: download a chart to your local directory to view - helm install: upload the chart to Kubernetes - helm 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 - $HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. - $TILLER_NAMESPACE set an alternative Tiller namespace (default "kube-system") - $KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config") +Environment variables: + ++------------------+-----------------------------------------------------------------------------+ +| Name | Description | ++------------------+-----------------------------------------------------------------------------+ +| $XDG_CACHE_HOME | set an alternative location for storing cached files. | +| $XDG_CONFIG_HOME | set an alternative location for storing Helm configuration. | +| $XDG_DATA_HOME | set an alternative location for storing Helm data. | +| $HELM_DRIVER | set the backend storage driver. Values are: configmap, secret, memory | +| $HELM_NO_PLUGINS | disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. | +| $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") | ++------------------+-----------------------------------------------------------------------------+ + +Helm stores configuration based on the XDG base directory specification, so + +- cached files are stored in $XDG_CACHE_HOME/helm +- configuration is stored in $XDG_CONFIG_HOME/helm +- data is stored in $XDG_DATA_HOME/helm + +By default, the default directories depend on the Operating System. The defaults are listed below: + ++------------------+---------------------------+--------------------------------+-------------------------+ +| Operating System | Cache Path | Configuration Path | Data Path | ++------------------+---------------------------+--------------------------------+-------------------------+ +| Linux | $HOME/.cache/helm | $HOME/.config/helm | $HOME/.local/share/helm | +| macOS | $HOME/Library/Caches/helm | $HOME/Library/Preferences/helm | $HOME/Library/helm | +| Windows | %TEMP%\helm | %APPDATA%\helm | %APPDATA%\helm | ++------------------+---------------------------+--------------------------------+-------------------------+ ### Options ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + -h, --help help for helm + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/snap/code/common/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm completion](../helm_completion) - Generate autocompletions script for the specified shell (bash or zsh) * [helm create](../helm_create) - create a new chart with the given name -* [helm delete](../helm_delete) - given a release name, delete the release from Kubernetes * [helm dependency](../helm_dependency) - manage a chart's dependencies -* [helm fetch](../helm_fetch) - download a chart from a repository and (optionally) unpack it in local directory -* [helm get](../helm_get) - download a named release +* [helm env](../helm_env) - Helm client environment information +* [helm get](../helm_get) - download extended information of a named release * [helm history](../helm_history) - fetch release history -* [helm home](../helm_home) - displays the location of HELM_HOME -* [helm inspect](../helm_inspect) - inspect a chart -* [helm init](../helm_init) - initialize Helm on both client and server -* [helm install](../helm_install) - install a chart archive +* [helm install](../helm_install) - install a chart * [helm lint](../helm_lint) - examines a chart for possible issues * [helm list](../helm_list) - list releases * [helm package](../helm_package) - package a chart directory into a chart archive -* [helm plugin](../helm_plugin) - add, list, or remove Helm plugins +* [helm plugin](../helm_plugin) - install, list, or uninstall Helm plugins +* [helm pull](../helm_pull) - download a chart from a repository and (optionally) unpack it in local directory * [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -* [helm reset](../helm_reset) - uninstalls Tiller from a cluster * [helm rollback](../helm_rollback) - roll back a release to a previous revision * [helm search](../helm_search) - search for a keyword in charts -* [helm serve](../helm_serve) - start a local http web server +* [helm show](../helm_show) - show information of a chart * [helm status](../helm_status) - displays the status of the named release * [helm template](../helm_template) - locally render templates -* [helm test](../helm_test) - test a release +* [helm test](../helm_test) - run tests for a release +* [helm uninstall](../helm_uninstall) - uninstall a release * [helm upgrade](../helm_upgrade) - upgrade a release * [helm verify](../helm_verify) - verify that a chart at the given path has been signed and is valid -* [helm version](../helm_version) - print the client/server version information +* [helm version](../helm_version) - print the client version information -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_completion.md b/content/en/docs/helm/helm_completion.md index 2e5c57dd8f..7c4d80fa0a 100644 --- a/content/en/docs/helm/helm_completion.md +++ b/content/en/docs/helm/helm_completion.md @@ -1,6 +1,5 @@ --- title: "Helm Completion" -weight: 2 --- ## helm completion @@ -10,33 +9,53 @@ Generate autocompletions script for the specified shell (bash or zsh) ### Synopsis - Generate autocompletions script for Helm for the specified shell (bash or zsh). This command can generate shell autocompletions. e.g. - $ helm completion bash + $ helm completion bash Can be sourced as such - $ source <(helm completion bash) + $ source <(helm completion bash) + + +``` +helm completion SHELL [flags] +``` +### Options ``` -helm completion SHELL + -h, --help help for completion ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_create.md b/content/en/docs/helm/helm_create.md index c7280f4a23..f9a9c43f5c 100644 --- a/content/en/docs/helm/helm_create.md +++ b/content/en/docs/helm/helm_create.md @@ -1,6 +1,5 @@ --- title: "Helm Create" -weight: 3 --- ## helm create @@ -10,24 +9,19 @@ 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 + 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 + └── tests/ # The test 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 @@ -36,26 +30,42 @@ will be overwritten, but other files will be left alone. ``` -helm create NAME +helm create NAME [flags] ``` ### Options ``` - -p, --starter string the named Helm starter scaffold + -h, --help help for create + -p, --starter string The name or absolute path to Helm starter scaffold ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_delete.md b/content/en/docs/helm/helm_delete.md deleted file mode 100644 index 7120bdb872..0000000000 --- a/content/en/docs/helm/helm_delete.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Helm Delete" -weight: 4 ---- - -## 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 - --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote -``` - -### Options inherited from parent commands - -``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_dependency.md b/content/en/docs/helm/helm_dependency.md index 0294406aff..84952da59d 100644 --- a/content/en/docs/helm/helm_dependency.md +++ b/content/en/docs/helm/helm_dependency.md @@ -1,6 +1,5 @@ --- title: "Helm Dependency" -weight: 5 --- ## helm dependency @@ -10,22 +9,19 @@ 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. +often easier to manage dependencies in 'Chart.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: +For example, this Chart.yaml declares two dependencies: - # requirements.yaml + # Chart.yaml dependencies: - name: nginx version: "1.2.3" @@ -34,6 +30,7 @@ For example, this requirements file declares two dependencies: 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. @@ -48,7 +45,7 @@ Starting from 2.2.0, repository can be defined as the path to the directory of the dependency charts stored locally. The path should start with a prefix of "file://". For example, - # requirements.yaml + # Chart.yaml dependencies: - name: nginx version: "1.2.3" @@ -59,20 +56,41 @@ repository added to helm by "helm add repo". Version matching is also supported for this case. +### Options + +``` + -h, --help help for dependency +``` + ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -* [helm dependency build](../helm_dependency_build) - rebuild the charts/ directory based on the requirements.lock file -* [helm dependency list](../helm_dependency_list) - list the dependencies for the given chart -* [helm dependency update](../helm_dependency_update) - update charts/ based on the contents of requirements.yaml +* [helm dependency build](helm_dependency_build.md) - rebuild the charts/ directory based on the Chart.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 Chart.yaml -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_dependency_build.md b/content/en/docs/helm/helm_dependency_build.md index a2f9533676..793958b378 100644 --- a/content/en/docs/helm/helm_dependency_build.md +++ b/content/en/docs/helm/helm_dependency_build.md @@ -1,17 +1,15 @@ --- title: "Helm Dependency Build" -weight: 6 --- ## helm dependency build -rebuild the charts/ directory based on the requirements.lock file +rebuild the charts/ directory based on the Chart.lock file ### Synopsis - -Build out the charts/ directory from the requirements.lock file. +Build out the charts/ directory from the Chart.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' @@ -22,27 +20,43 @@ of 'helm dependency update'. ``` -helm dependency build [flags] CHART +helm dependency build CHART [flags] ``` ### Options ``` - --keyring string keyring containing public keys (default "/Users/roflynnc/.gnupg/pubring.gpg") + -h, --help help for build + --keyring string keyring containing public keys (default "~/.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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm dependency](../helm_dependency) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_dependency_list.md b/content/en/docs/helm/helm_dependency_list.md index 522ea15c4a..85e878ee3d 100644 --- a/content/en/docs/helm/helm_dependency_list.md +++ b/content/en/docs/helm/helm_dependency_list.md @@ -1,6 +1,5 @@ --- title: "Helm Dependency List" -weight: 7 --- ## helm dependency list @@ -10,31 +9,50 @@ 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. +This will produce an error if the chart cannot be loaded. + + +``` +helm dependency list CHART [flags] +``` +### Options ``` -helm dependency list [flags] CHART + -h, --help help for list ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm dependency](../helm_dependency) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_dependency_update.md b/content/en/docs/helm/helm_dependency_update.md index fd96094ee9..8d68a2876a 100644 --- a/content/en/docs/helm/helm_dependency_update.md +++ b/content/en/docs/helm/helm_dependency_update.md @@ -1,38 +1,37 @@ --- title: "Helm Dependency Update" -weight: 8 --- ## helm dependency update -update charts/ based on the contents of requirements.yaml +update charts/ based on the contents of Chart.yaml ### Synopsis +Update the on-disk dependencies to mirror Chart.yaml. -Update the on-disk dependencies to mirror the requirements.yaml file. - -This command verifies that the required charts, as expressed in 'requirements.yaml', +This command verifies that the required charts, as expressed in 'Chart.yaml', are present in 'charts/' and are at an acceptable version. It will pull down the latest charts that satisfy the dependencies, and clean up old dependencies. On successful update, this will generate a lock file that can be used to -rebuild the requirements to an exact version. +rebuild the dependencies to an exact version. -Dependencies are not required to be represented in 'requirements.yaml'. For that +Dependencies are not required to be represented in 'Chart.yaml'. For that reason, an update command will not remove charts unless they are (a) present -in the requirements.yaml file, but (b) at the wrong version. +in the Chart.yaml file, but (b) at the wrong version. ``` -helm dependency update [flags] CHART +helm dependency update CHART [flags] ``` ### Options ``` - --keyring string keyring containing public keys (default "/Users/roflynnc/.gnupg/pubring.gpg") + -h, --help help for update + --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") --skip-refresh do not refresh the local repository cache --verify verify the packages against signatures ``` @@ -40,14 +39,29 @@ helm dependency update [flags] CHART ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm dependency](../helm_dependency) - manage a chart's dependencies -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm dependency](helm_dependency.md) - manage a chart's dependencies + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_env.md b/content/en/docs/helm/helm_env.md new file mode 100644 index 0000000000..29a2c27c55 --- /dev/null +++ b/content/en/docs/helm/helm_env.md @@ -0,0 +1,53 @@ +--- +title: "Helm Env" +--- + +## helm env + +Helm client environment information + +### Synopsis + + +Env prints out all the environment information in use by Helm. + + +``` +helm env [flags] +``` + +### Options + +``` + -h, --help help for env +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm](../helm) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_fetch.md b/content/en/docs/helm/helm_fetch.md deleted file mode 100644 index b5645f0ecc..0000000000 --- a/content/en/docs/helm/helm_fetch.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Helm Fetch" -weight: 9 ---- - -## 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 uncompress 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 - -``` - --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle - --cert-file string identify HTTPS client using this SSL certificate file - -d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".") - --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. - --key-file string identify HTTPS client using this SSL key file - --keyring string keyring containing public keys (default "/Users/roflynnc/.gnupg/pubring.gpg") - --prov fetch the provenance file, but don't perform verification - --repo string chart repository url where to locate the requested chart - --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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_get.md b/content/en/docs/helm/helm_get.md index 5285cd967f..bdfa30d017 100644 --- a/content/en/docs/helm/helm_get.md +++ b/content/en/docs/helm/helm_get.md @@ -1,57 +1,60 @@ --- title: "Helm Get" -weight: 10 --- ## helm get -download a named release +download extended information of a named release ### Synopsis +This command consists of multiple subcommands which can be used to +get extended information about the release, including: -This command shows the details of a named release. +- The values used to generate the release +- The generated manifest file +- The notes provided by the chart of the release +- The hooks associated with the 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 int32 get the named release with revision - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for get ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -* [helm get hooks](../helm_get_hooks) - download all hooks for a named release -* [helm get manifest](../helm_get_manifest) - download the manifest for a named release -* [helm get values](../helm_get_values) - download the values file for a named release +* [helm get all](helm_get_all.md) - download all information for a named release +* [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 notes](helm_get_notes.md) - download the notes 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 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_get_all.md b/content/en/docs/helm/helm_get_all.md new file mode 100644 index 0000000000..62462f3155 --- /dev/null +++ b/content/en/docs/helm/helm_get_all.md @@ -0,0 +1,56 @@ +--- +title: "Helm Get All" +--- + +## helm get all + +download all information for a named release + +### Synopsis + + +This command prints a human readable collection of information about the +notes, hooks, supplied values, and generated manifest file of the given release. + + +``` +helm get all RELEASE_NAME [flags] +``` + +### Options + +``` + -h, --help help for all + --revision int get the named release with revision + --template string go template for formatting the output, eg: {{.Release.Name}} +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm get](helm_get.md) - download extended information of a named release + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_get_hooks.md b/content/en/docs/helm/helm_get_hooks.md index 5e7d7d4540..c0050489ff 100644 --- a/content/en/docs/helm/helm_get_hooks.md +++ b/content/en/docs/helm/helm_get_hooks.md @@ -1,6 +1,5 @@ --- title: "Helm Get Hooks" -weight: 11 --- ## helm get hooks @@ -10,38 +9,48 @@ 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 +helm get hooks RELEASE_NAME [flags] ``` ### Options ``` - --revision int32 get the named release with revision - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for hooks + --revision int 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm get](../helm_get) - download a named release -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm get](helm_get.md) - download extended information of a named release + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_get_manifest.md b/content/en/docs/helm/helm_get_manifest.md index 0321dfb44b..05ae7f6a8f 100644 --- a/content/en/docs/helm/helm_get_manifest.md +++ b/content/en/docs/helm/helm_get_manifest.md @@ -1,6 +1,5 @@ --- title: "Helm Get Manifest" -weight: 12 --- ## helm get manifest @@ -10,7 +9,6 @@ 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 @@ -19,31 +17,42 @@ charts, those resources will also be included in the manifest. ``` -helm get manifest [flags] RELEASE_NAME +helm get manifest RELEASE_NAME [flags] ``` ### Options ``` - --revision int32 get the named release with revision - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for manifest + --revision int 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm get](../helm_get) - download a named release -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm get](helm_get.md) - download extended information of a named release + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_get_notes.md b/content/en/docs/helm/helm_get_notes.md new file mode 100644 index 0000000000..ef21575e2a --- /dev/null +++ b/content/en/docs/helm/helm_get_notes.md @@ -0,0 +1,54 @@ +--- +title: "Helm Get Notes" +--- + +## helm get notes + +download the notes for a named release + +### Synopsis + + +This command shows notes provided by the chart of a named release. + + +``` +helm get notes RELEASE_NAME [flags] +``` + +### Options + +``` + -h, --help help for notes + --revision int get the named release with revision +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm get](helm_get.md) - download extended information of a named release + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_get_values.md b/content/en/docs/helm/helm_get_values.md index ed55b65c83..4e52752e06 100644 --- a/content/en/docs/helm/helm_get_values.md +++ b/content/en/docs/helm/helm_get_values.md @@ -1,6 +1,5 @@ --- title: "Helm Get Values" -weight: 13 --- ## helm get values @@ -10,37 +9,48 @@ 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 +helm get values RELEASE_NAME [flags] ``` ### Options ``` - -a, --all dump all (computed) values - --revision int32 get the named release with revision - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -a, --all dump all (computed) values + -h, --help help for values + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + --revision int 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm get](../helm_get) - download a named release -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm get](helm_get.md) - download extended information of a named release + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_history.md b/content/en/docs/helm/helm_history.md index 96f3fe6ff8..f9fe6a32d8 100644 --- a/content/en/docs/helm/helm_history.md +++ b/content/en/docs/helm/helm_history.md @@ -1,6 +1,5 @@ --- title: "Helm History" -weight: 14 --- ## helm history @@ -10,7 +9,6 @@ fetch release history ### Synopsis - History prints historical revisions for a given release. A default maximum of 256 revisions will be returned. Setting '--max' @@ -18,40 +16,52 @@ 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 DESCRIPTION - 1 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Initial install - 2 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Upgraded successfully - 3 Mon Oct 3 10:15:13 2016 SUPERSEDED alpine-0.1.0 Rolled back to 2 - 4 Mon Oct 3 10:15:13 2016 DEPLOYED alpine-0.1.0 Upgraded successfully + $ helm history angry-bird + REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION + 1 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Initial install + 2 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Upgraded successfully + 3 Mon Oct 3 10:15:13 2016 superseded alpine-0.1.0 1.0 Rolled back to 2 + 4 Mon Oct 3 10:15:13 2016 deployed alpine-0.1.0 1.0 Upgraded successfully ``` -helm history [flags] RELEASE_NAME +helm history RELEASE_NAME [flags] ``` ### Options ``` - --max int32 maximum number of revision to include in history (default 256) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for history + --max int maximum number of revision to include in history (default 256) + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_home.md b/content/en/docs/helm/helm_home.md deleted file mode 100644 index 9350510d0b..0000000000 --- a/content/en/docs/helm/helm_home.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Helm Home" -weight: 15 ---- - -## 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_init.md b/content/en/docs/helm/helm_init.md deleted file mode 100644 index 24d1066799..0000000000 --- a/content/en/docs/helm/helm_init.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Helm Init" -weight: 16 ---- - -## 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 Kubernetes 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 - --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit. - --local-repo-url string URL for local repository (default "http://127.0.0.1:8879/charts") - --net-host install Tiller with net=host - --node-selectors string labels to specify the node on which Tiller is installed (app=tiller,helm=rocks) - -o, --output OutputFormat skip installation and output Tiller's manifest in specified format (json or yaml) - --override stringArray override values for the Tiller Deployment manifest (can specify multiple or separate values with commas: key1=val1,key2=val2) - --service-account string name of service account - --skip-refresh do not refresh (download) the local repository cache - --stable-repo-url string URL for stable repository (default "https://kubernetes-charts.storage.googleapis.com") - -i, --tiller-image string override Tiller image - --tiller-tls install Tiller with TLS enabled - --tiller-tls-cert string path to TLS certificate file to install with Tiller - --tiller-tls-key string path to TLS key file to install with Tiller - --tiller-tls-verify install Tiller with TLS enabled and to verify remote certificates - --tls-ca-cert string path to CA root certificate - --upgrade upgrade if Tiller is already installed -``` - -### Options inherited from parent commands - -``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_inspect.md b/content/en/docs/helm/helm_inspect.md deleted file mode 100644 index e1b611470e..0000000000 --- a/content/en/docs/helm/helm_inspect.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "Helm Inspect" -weight: 20 ---- - -## 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 - -``` - --ca-file string chart repository url where to locate the requested chart - --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle - --key-file string identify HTTPS client using this SSL key file - --keyring string path to the keyring containing public verification keys (default "/Users/roflynnc/.gnupg/pubring.gpg") - --repo string chart repository url where to locate the requested chart - --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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. -* [helm inspect chart](../helm_inspect_chart) - shows inspect chart -* [helm inspect values](../helm_inspect_values) - shows inspect values - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_inspect_chart.md b/content/en/docs/helm/helm_inspect_chart.md deleted file mode 100644 index 90d3f3eec2..0000000000 --- a/content/en/docs/helm/helm_inspect_chart.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Helm Inspect Chart" -weight: 18 ---- - -## 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 - -``` - --ca-file string chart repository url where to locate the requested chart - --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle - --key-file string identify HTTPS client using this SSL key file - --keyring string path to the keyring containing public verification keys (default "/Users/roflynnc/.gnupg/pubring.gpg") - --repo string chart repository url where to locate the requested chart - --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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm inspect](../helm_inspect) - inspect a chart - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_inspect_values.md b/content/en/docs/helm/helm_inspect_values.md deleted file mode 100644 index fcfb5030a5..0000000000 --- a/content/en/docs/helm/helm_inspect_values.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Helm Inspect Values" -weight: 19 ---- - -## 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 - -``` - --ca-file string chart repository url where to locate the requested chart - --cert-file string verify certificates of HTTPS-enabled servers using this CA bundle - --key-file string identify HTTPS client using this SSL key file - --keyring string path to the keyring containing public verification keys (default "/Users/roflynnc/.gnupg/pubring.gpg") - --repo string chart repository url where to locate the requested chart - --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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm inspect](../helm_inspect) - inspect a chart - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_install.md b/content/en/docs/helm/helm_install.md index c81523a537..4e0d463c2d 100644 --- a/content/en/docs/helm/helm_install.md +++ b/content/en/docs/helm/helm_install.md @@ -1,114 +1,141 @@ --- title: "Helm Install" -weight: 17 --- ## helm install -install a chart archive +install a chart ### Synopsis - This command installs a chart archive. The install argument must be a chart reference, a path to a packaged chart, a path to an unpacked chart directory or a URL. 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. +or use the '--set' flag and pass configuration from the command line, to force +a string value use '--set-string'. In case a value is large and therefore +you want not to use neither '--values' nor '--set', use '--set-file' to read the +single large value from file. + + $ helm install -f myvalues.yaml myredis ./redis + +or - $ helm install -f myvalues.yaml ./redis + $ helm install --set name=prod myredis ./redis or - $ helm install --set name=prod ./redis + $ helm install --set-string long_int=1234567890 myredis ./redis + +or + $ helm install --set-file my_script=dothings.sh myredis ./redis You can specify the '--values'/'-f' flag multiple times. The priority will be given to the last (right-most) file specified. For example, if both myvalues.yaml and override.yaml contained a key called 'Test', the value set in override.yaml would take precedence: - $ helm install -f myvalues.yaml -f override.yaml ./redis + $ helm install -f myvalues.yaml -f override.yaml myredis ./redis You can specify the '--set' flag multiple times. The priority will be given to the last (right-most) set specified. For example, if both 'bar' and 'newbar' values are set for a key called 'foo', the 'newbar' value would take precedence: - $ helm install --set foo=bar --set foo=newbar ./redis + $ helm install --set foo=bar --set foo=newbar myredis ./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. +the '--debug' and '--dry-run' flags can be combined. -If --verify is set, the chart MUST have a provenance file, and the provenenace -fall MUST pass all verification steps. +If --verify is set, the chart MUST have a provenance file, and the provenance +file MUST pass all verification steps. -There are four different ways you can express the chart you want to install: +There are five 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 +1. By chart reference: helm install mymaria example/mariadb +2. By path to a packaged chart: helm install mynginx ./nginx-1.2.3.tgz +3. By path to an unpacked chart directory: helm install mynginx ./nginx +4. By absolute URL: helm install mynginx https://example.com/charts/nginx-1.2.3.tgz +5. By chart reference and repo url: helm install --repo https://example.com/charts/ mynginx nginx CHART REFERENCES -A chart reference is a convenient way of reference a chart in a chart repository. +A chart reference is a convenient way of referencing 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. +When you use a chart reference with a repo prefix ('example/mariadb'), Helm will look in the local +configuration for a chart repository named 'example', and will then look for a +chart in that repository whose name is 'mariadb'. It will install the latest stable version of that chart +until you specify '--devel' flag to also include development version (alpha, beta, and release candidate releases), or +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] +helm install [NAME] [CHART] [flags] ``` ### Options ``` - --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle - --cert-file string identify HTTPS client using this SSL certificate file - --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. - --dry-run simulate an install - --key-file string identify HTTPS client using this SSL key file - --keyring string location of public keys used for verification (default "/Users/roflynnc/.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. Defaults to the current kube config namespace. - --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 - --repo string chart repository url where to locate the requested chart - --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) - --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote - -f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default []) - --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 - --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout + --atomic if set, installation process purges chart on fail. The --wait flag will be set automatically if --atomic is used + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + --dependency-update run helm dependency update before installing the chart + --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored + --dry-run simulate an install + -g, --generate-name generate the name (and omit the NAME parameter) + -h, --help help for install + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --name-template string specify template used to name the release + --no-hooks prevent hooks from running during install + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + --password string chart repository password where to locate the requested chart + --render-subchart-notes if set, render subchart notes along with the parent + --replace re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production + --repo string chart repository url where to locate the requested chart + --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) + --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) + --username string chart repository username where to locate the requested chart + -f, --values strings specify values in a YAML file or a URL(can specify multiple) + --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 + --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_lint.md b/content/en/docs/helm/helm_lint.md index e7a94cf55c..08847e34f3 100644 --- a/content/en/docs/helm/helm_lint.md +++ b/content/en/docs/helm/helm_lint.md @@ -1,6 +1,5 @@ --- title: "Helm Lint" -weight: 21 --- ## helm lint @@ -10,7 +9,6 @@ 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. @@ -20,26 +18,46 @@ or recommendation, it will emit [WARNING] messages. ``` -helm lint [flags] PATH +helm lint PATH [flags] ``` ### Options ``` - --strict fail on lint warnings + -h, --help help for lint + --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) + --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --strict fail on lint warnings + -f, --values strings specify values in a YAML file or a URL(can specify multiple) ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_list.md b/content/en/docs/helm/helm_list.md index b9945e8b08..74950ef133 100644 --- a/content/en/docs/helm/helm_list.md +++ b/content/en/docs/helm/helm_list.md @@ -1,6 +1,5 @@ --- title: "Helm List" -weight: 22 --- ## helm list @@ -10,23 +9,22 @@ list releases ### Synopsis - -This command lists all of the releases. +This command lists all of the releases for a specified namespace (uses current namespace context if namespace not specified). By default, it lists only releases that are deployed or failed. Flags like -'--deleted' and '--all' will alter this behavior. Such flags can be combined: -'--deleted --failed'. +'--uninstalled' and '--all' will alter this behavior. Such flags can be combined: +'--uninstalled --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 +If the --filter flag is provided, it will be treated as a filter. Filters are regular expressions (Perl compatible) that are applied to the list of releases. 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 + $ helm list --filter '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). @@ -38,42 +36,56 @@ flag with the '--offset' flag allows you to page through results. ``` -helm list [flags] [FILTER] +helm list [flags] ``` ### Options ``` - -a, --all show all releases, not just the ones marked DEPLOYED - -d, --date sort by release date - --deleted show deleted releases - --deleting show releases that are currently being deleted - --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) - --namespace string show releases within a specific namespace - -o, --offset string next release name in the list, used to offset from start value - --pending show pending releases - -r, --reverse reverse the sort order - -q, --short output short (quiet) listing format - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -a, --all show all releases without any filter applied + --all-namespaces list releases across all namespaces + -d, --date sort by release date + --deployed show deployed releases. If no other is specified, this will be automatically enabled + --failed show failed releases + -f, --filter string a regular expression (Perl compatible). Any releases that match the expression will be included in the results + -h, --help help for list + -m, --max int maximum number of releases to fetch (default 256) + --offset int next release name in the list, used to offset from start value + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + --pending show pending releases + -r, --reverse reverse the sort order + -q, --short output short (quiet) listing format + --superseded show superseded releases + --uninstalled show uninstalled releases + --uninstalling show releases that are currently being uninstalled ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_package.md b/content/en/docs/helm/helm_package.md index bf2cb4be91..0f935d8d9e 100644 --- a/content/en/docs/helm/helm_package.md +++ b/content/en/docs/helm/helm_package.md @@ -1,6 +1,5 @@ --- title: "Helm Package" -weight: 23 --- ## helm package @@ -10,7 +9,6 @@ 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. @@ -22,17 +20,18 @@ Versioned chart archives are used by Helm package repositories. ``` -helm package [flags] [CHART_PATH] [...] +helm package [CHART_PATH] [...] [flags] ``` ### Options ``` - -u, --dependency-update update dependencies from "requirements.yaml" to dir "charts/" before packaging + --app-version string set the appVersion on the chart to this version + -u, --dependency-update update dependencies from "Chart.yaml" to dir "charts/" before packaging -d, --destination string location to write the chart. (default ".") + -h, --help help for package --key string name of the key to use when signing. Used if --sign is true - --keyring string location of a public keyring (default "/Users/roflynnc/.gnupg/pubring.gpg") - --save save packaged chart to local chart repository (default true) + --keyring string location of a public keyring (default "~/.gnupg/pubring.gpg") --sign use a PGP private key to sign this package --version string set the version on the chart to this semver version ``` @@ -40,14 +39,29 @@ helm package [flags] [CHART_PATH] [...] ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_plugin.md b/content/en/docs/helm/helm_plugin.md index fa86ca3999..b0fbd1f4be 100644 --- a/content/en/docs/helm/helm_plugin.md +++ b/content/en/docs/helm/helm_plugin.md @@ -1,34 +1,53 @@ --- title: "Helm Plugin" -weight: 24 --- ## helm plugin -add, list, or remove Helm plugins +install, list, or uninstall Helm plugins ### Synopsis - Manage client-side Helm plugins. +### Options + +``` + -h, --help help for plugin +``` + ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -* [helm plugin install](../helm_plugin_install) - install one or more Helm plugins -* [helm plugin list](../helm_plugin_list) - list installed Helm plugins -* [helm plugin remove](../helm_plugin_remove) - remove one or more Helm plugins -* [helm plugin update](../helm_plugin_update) - update one or more Helm plugins +* [helm plugin install](helm_plugin_install.md) - install one or more Helm plugins +* [helm plugin list](helm_plugin_list.md) - list installed Helm plugins +* [helm plugin uninstall](helm_plugin_uninstall.md) - uninstall one or more Helm plugins +* [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_plugin_install.md b/content/en/docs/helm/helm_plugin_install.md index 386e3f80d5..98aba69612 100644 --- a/content/en/docs/helm/helm_plugin_install.md +++ b/content/en/docs/helm/helm_plugin_install.md @@ -1,6 +1,5 @@ --- title: "Helm Plugin Install" -weight: 25 --- ## helm plugin install @@ -10,29 +9,46 @@ install one or more Helm plugins ### Synopsis -install one or more Helm plugins +This command allows you to install a plugin from a url to a VCS repo or a local path. + ``` -helm plugin install [options] ... +helm plugin install [options] ... [flags] ``` ### Options ``` + -h, --help help for install --version string specify a version constraint. 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm plugin](../helm_plugin) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_plugin_list.md b/content/en/docs/helm/helm_plugin_list.md index 6e79f7f49a..2f5481cd36 100644 --- a/content/en/docs/helm/helm_plugin_list.md +++ b/content/en/docs/helm/helm_plugin_list.md @@ -1,6 +1,5 @@ --- -title: "Helm List" -weight: 26 +title: "Helm Plugin List" --- ## helm plugin list @@ -9,24 +8,44 @@ list installed Helm plugins ### Synopsis - list installed Helm plugins ``` -helm plugin list +helm plugin list [flags] +``` + +### Options + +``` + -h, --help help for list ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm plugin](../helm_plugin) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_plugin_remove.md b/content/en/docs/helm/helm_plugin_remove.md deleted file mode 100644 index 4dc92dbc56..0000000000 --- a/content/en/docs/helm/helm_plugin_remove.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Helm Plugin Remove" -weight: 27 ---- - -## helm plugin remove - -remove one or more Helm plugins - -### Synopsis - - -remove one or more Helm plugins - -``` -helm plugin remove ... -``` - -### Options inherited from parent commands - -``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm plugin](../helm_plugin) - add, list, or remove Helm plugins - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_plugin_uninstall.md b/content/en/docs/helm/helm_plugin_uninstall.md new file mode 100644 index 0000000000..7b4a08341b --- /dev/null +++ b/content/en/docs/helm/helm_plugin_uninstall.md @@ -0,0 +1,51 @@ +--- +title: "Helm Plugin Uninstall" +--- + +## helm plugin uninstall + +uninstall one or more Helm plugins + +### Synopsis + +uninstall one or more Helm plugins + +``` +helm plugin uninstall ... [flags] +``` + +### Options + +``` + -h, --help help for uninstall +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_plugin_update.md b/content/en/docs/helm/helm_plugin_update.md index cd561fe828..9f3acc46b4 100644 --- a/content/en/docs/helm/helm_plugin_update.md +++ b/content/en/docs/helm/helm_plugin_update.md @@ -1,6 +1,5 @@ --- title: "Helm Plugin Update" -weight: 28 --- ## helm plugin update @@ -9,24 +8,44 @@ update one or more Helm plugins ### Synopsis - update one or more Helm plugins ``` -helm plugin update ... +helm plugin update ... [flags] +``` + +### Options + +``` + -h, --help help for update ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm plugin](../helm_plugin) - add, list, or remove Helm plugins -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_pull.md b/content/en/docs/helm/helm_pull.md new file mode 100644 index 0000000000..775095623d --- /dev/null +++ b/content/en/docs/helm/helm_pull.md @@ -0,0 +1,78 @@ +--- +title: "Helm Pull" +--- + +## helm pull + +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 uncompress 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 pull [chart URL | repo/chartname] [...] [flags] +``` + +### Options + +``` + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + -d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".") + --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. + -h, --help help for pull + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --password string chart repository password where to locate the requested chart + --prov fetch the provenance file, but don't perform verification + --repo string chart repository url where to locate the requested chart + --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 ".") + --username string chart repository username where to locate the requested chart + --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 + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm](../helm) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo.md b/content/en/docs/helm/helm_repo.md index 34ca40690b..24e801cdaf 100644 --- a/content/en/docs/helm/helm_repo.md +++ b/content/en/docs/helm/helm_repo.md @@ -1,6 +1,5 @@ --- title: "Helm Repo" -weight: 29 --- ## helm repo @@ -10,30 +9,48 @@ 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 + +``` + -h, --help help for repo +``` + ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -* [helm repo add](../helm_repo_add) - add a chart repository -* [helm repo index](../helm_repo_index) - generate an index file given a directory containing packaged charts -* [helm repo list](../helm_repo_list) - list chart repositories -* [helm repo remove](../helm_repo_remove) - remove a chart repository -* [helm repo update](../helm_repo_update) - update information of available charts locally from chart repositories +* [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 of available charts locally from chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo_add.md b/content/en/docs/helm/helm_repo_add.md index 1aea8ca24f..71e7606b8d 100644 --- a/content/en/docs/helm/helm_repo_add.md +++ b/content/en/docs/helm/helm_repo_add.md @@ -1,6 +1,5 @@ --- title: "Helm Repo Add" -weight: 30 --- ## helm repo add @@ -9,11 +8,10 @@ add a chart repository ### Synopsis - add a chart repository ``` -helm repo add [flags] [NAME] [URL] +helm repo add [NAME] [URL] [flags] ``` ### Options @@ -21,21 +19,39 @@ helm repo add [flags] [NAME] [URL] ``` --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for add --key-file string identify HTTPS client using this SSL key file --no-update raise error if repo is already registered + --password string chart repository password + --username string chart repository username ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo_index.md b/content/en/docs/helm/helm_repo_index.md index 037b8197f8..b465497c1f 100644 --- a/content/en/docs/helm/helm_repo_index.md +++ b/content/en/docs/helm/helm_repo_index.md @@ -1,6 +1,5 @@ --- title: "Helm Repo Index" -weight: 31 --- ## helm repo index @@ -10,7 +9,6 @@ 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 @@ -22,12 +20,13 @@ into the existing index, with local charts taking priority over existing charts. ``` -helm repo index [flags] [DIR] +helm repo index [DIR] [flags] ``` ### Options ``` + -h, --help help for index --merge string merge the generated index into the given index --url string url of chart repository ``` @@ -35,14 +34,29 @@ helm repo index [flags] [DIR] ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo_list.md b/content/en/docs/helm/helm_repo_list.md index 0266131822..32d46e4845 100644 --- a/content/en/docs/helm/helm_repo_list.md +++ b/content/en/docs/helm/helm_repo_list.md @@ -1,6 +1,5 @@ --- title: "Helm Repo List" -weight: 32 --- ## helm repo list @@ -9,24 +8,45 @@ list chart repositories ### Synopsis - list chart repositories ``` helm repo list [flags] ``` +### Options + +``` + -h, --help help for list + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) +``` + ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo_remove.md b/content/en/docs/helm/helm_repo_remove.md index af82f37a97..cffc55d052 100644 --- a/content/en/docs/helm/helm_repo_remove.md +++ b/content/en/docs/helm/helm_repo_remove.md @@ -1,6 +1,5 @@ --- title: "Helm Repo Remove" -weight: 33 --- ## helm repo remove @@ -9,24 +8,44 @@ remove a chart repository ### Synopsis - remove a chart repository ``` -helm repo remove [flags] [NAME] +helm repo remove [NAME] [flags] +``` + +### Options + +``` + -h, --help help for remove ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_repo_update.md b/content/en/docs/helm/helm_repo_update.md index 31a1a41b0a..f16611dc90 100644 --- a/content/en/docs/helm/helm_repo_update.md +++ b/content/en/docs/helm/helm_repo_update.md @@ -1,6 +1,5 @@ --- title: "Helm Repo Update" -weight: 33 --- ## helm repo update @@ -10,29 +9,46 @@ update information of available charts locally from 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 [flags] +``` + +### Options ``` -helm repo update + -h, --help help for update ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [helm repo](../helm_repo) - add, list, remove, update, and index chart repositories -###### Auto generated by spf13/cobra on 13-Jan-2020 +* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_reset.md b/content/en/docs/helm/helm_reset.md deleted file mode 100644 index 7ffbc8d12e..0000000000 --- a/content/en/docs/helm/helm_reset.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Helm Reset" -weight: 34 ---- - -## helm reset - -uninstalls Tiller from a cluster - -### Synopsis - - - -This command uninstalls Tiller (the Helm server-side component) from your -Kubernetes Cluster and optionally deletes local configuration in -$HELM_HOME (default ~/.helm/) - - -``` -helm reset -``` - -### Options - -``` - -f, --force forces Tiller uninstall even if there are releases installed, or if Tiller is not in ready state - --remove-helm-home if set deletes $HELM_HOME - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote -``` - -### Options inherited from parent commands - -``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_rollback.md b/content/en/docs/helm/helm_rollback.md index 3592f5a363..51cdb0504c 100644 --- a/content/en/docs/helm/helm_rollback.md +++ b/content/en/docs/helm/helm_rollback.md @@ -1,6 +1,5 @@ --- title: "Helm Rollback" -weight: 35 --- ## helm rollback @@ -10,45 +9,58 @@ roll back a release to a previous revision ### Synopsis - This command rolls back a release to a previous revision. The first argument of the rollback command is the name of a release, and the -second is a revision (version) number. To see revision numbers, run -'helm history RELEASE'. +second is a revision (version) number. If this argument is omitted, it will +roll back to the previous release. + +To see revision numbers, run 'helm history RELEASE'. ``` -helm rollback [flags] [RELEASE] [REVISION] +helm rollback [REVISION] [flags] ``` ### Options ``` - --dry-run simulate a rollback - --force force resource update through delete/recreate if needed - --no-hooks prevent hooks from running during rollback - --recreate-pods performs pods restart for the resource if applicable - --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote - --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout + --cleanup-on-fail allow deletion of new resources created in this rollback when rollback fails + --dry-run simulate a rollback + --force force resource update through delete/recreate if needed + -h, --help help for rollback + --no-hooks prevent hooks from running during rollback + --recreate-pods performs pods restart for the resource if applicable + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) + --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_search.md b/content/en/docs/helm/helm_search.md index 48fbd09a8c..14e9bc4f96 100644 --- a/content/en/docs/helm/helm_search.md +++ b/content/en/docs/helm/helm_search.md @@ -1,6 +1,5 @@ --- title: "Helm Search" -weight: 36 --- ## helm search @@ -10,36 +9,45 @@ search for a keyword in charts ### Synopsis +Search provides the ability to search for Helm charts in the various places +they can be stored including the Helm Hub and repositories you have added. Use +search subcommands to search different locations for charts. -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 - -v, --version string search using semantic versioning constraints - -l, --versions show the long listing, with each version of each chart on its own line + -h, --help help for search ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. +* [helm search hub](helm_search_hub.md) - search for charts in the Helm Hub or an instance of Monocular +* [helm search repo](helm_search_repo.md) - search repositories for a keyword in charts -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_search_hub.md b/content/en/docs/helm/helm_search_hub.md new file mode 100644 index 0000000000..1a368a448a --- /dev/null +++ b/content/en/docs/helm/helm_search_hub.md @@ -0,0 +1,64 @@ +--- +title: "Helm Search Hub" +--- + +## helm search hub + +search for charts in the Helm Hub or an instance of Monocular + +### Synopsis + + +Search the Helm Hub or an instance of Monocular for Helm charts. + +The Helm Hub provides a centralized search for publicly available distributed +charts. It is maintained by the Helm project. It can be visited at +https://hub.helm.sh + +Monocular is a web-based application that enables the search and discovery of +charts from multiple Helm Chart repositories. It is the codebase that powers the +Helm Hub. You can find it at https://github.com/helm/monocular + + +``` +helm search hub [keyword] [flags] +``` + +### Options + +``` + --endpoint string monocular instance to query for charts (default "https://hub.helm.sh") + -h, --help help for hub + --max-col-width uint maximum column width for output table (default 50) + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm search](helm_search.md) - search for a keyword in charts + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_search_repo.md b/content/en/docs/helm/helm_search_repo.md new file mode 100644 index 0000000000..ebf7329e3f --- /dev/null +++ b/content/en/docs/helm/helm_search_repo.md @@ -0,0 +1,78 @@ +--- +title: "Helm Search Repo" +--- + +## helm search repo + +search repositories for a keyword in charts + +### Synopsis + + +Search reads through all of the repositories configured on the system, and +looks for matches. Search of these repositories uses the metadata stored on +the system. + +It will display the latest stable versions of the charts found. If you +specify the --devel flag, the output will include pre-release versions. +If you want to search using a version constraint, use --version. + +Examples: + + # Search for stable release versions matching the keyword "nginx" + $ helm search repo nginx + + # Search for release versions matching the keyword "nginx", including pre-release versions + $ helm search repo nginx --devel + + # Search for the latest stable release for nginx-ingress with a major version of 1 + $ helm search repo nginx-ingress --version ^1.0.0 + +Repositories are managed with 'helm repo' commands. + + +``` +helm search repo [keyword] [flags] +``` + +### Options + +``` + --devel use development versions (alpha, beta, and release candidate releases), too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored + -h, --help help for repo + --max-col-width uint maximum column width for output table (default 50) + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + -r, --regexp use regular expressions for searching repositories you have added + --version string search using semantic versioning constraints on repositories you have added + -l, --versions show the long listing, with each version of each chart on its own line, for repositories you have added +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm search](helm_search.md) - search for a keyword in charts + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_serve.md b/content/en/docs/helm/helm_serve.md deleted file mode 100644 index 29d32a26c5..0000000000 --- a/content/en/docs/helm/helm_serve.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "Helm Serve" -weight: 37 ---- - -## 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 local IPv4 TCP port (default '127.0.0.1:8879'). - -This command is intended to be used for educational and testing purposes only. -It is best to rely on a dedicated web server or a cloud-hosted solution like -Google Cloud Storage for production use. - -See https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories -for more information on hosting chart repositories in a production setting. - - -``` -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 - --url string external 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") -``` - -### SEE ALSO -* [helm](../helm) - The Helm package manager for Kubernetes. - -###### Auto generated by spf13/cobra on 13-Jan-2020 diff --git a/content/en/docs/helm/helm_show.md b/content/en/docs/helm/helm_show.md new file mode 100644 index 0000000000..60899c8c0c --- /dev/null +++ b/content/en/docs/helm/helm_show.md @@ -0,0 +1,53 @@ +--- +title: "Helm Show" +--- + +## helm show + +show information of a chart + +### Synopsis + + +This command consists of multiple subcommands to display information about a chart + + +### Options + +``` + -h, --help help for show +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm](../helm) - The Helm package manager for Kubernetes. +* [helm show all](helm_show_all.md) - shows all information of the chart +* [helm show chart](helm_show_chart.md) - shows the chart's definition +* [helm show readme](helm_show_readme.md) - shows the chart's README +* [helm show values](helm_show_values.md) - shows the chart's values + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_show_all.md b/content/en/docs/helm/helm_show_all.md new file mode 100644 index 0000000000..f1e8486ba9 --- /dev/null +++ b/content/en/docs/helm/helm_show_all.md @@ -0,0 +1,63 @@ +--- +title: "Helm Show All" +--- + +## helm show all + +shows all information of the chart + +### Synopsis + + +This command inspects a chart (directory, file, or URL) and displays all its content +(values.yaml, Charts.yaml, README) + + +``` +helm show all [CHART] [flags] +``` + +### Options + +``` + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for all + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --password string chart repository password where to locate the requested chart + --repo string chart repository url where to locate the requested chart + --username string chart repository username where to locate the requested chart + --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 + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm show](helm_show.md) - show information of a chart + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_show_chart.md b/content/en/docs/helm/helm_show_chart.md new file mode 100644 index 0000000000..1e552d7fd4 --- /dev/null +++ b/content/en/docs/helm/helm_show_chart.md @@ -0,0 +1,63 @@ +--- +title: "Helm Show Chart" +--- + +## helm show chart + +shows the chart's definition + +### Synopsis + + +This command inspects a chart (directory, file, or URL) and displays the contents +of the Charts.yaml file + + +``` +helm show chart [CHART] [flags] +``` + +### Options + +``` + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for chart + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --password string chart repository password where to locate the requested chart + --repo string chart repository url where to locate the requested chart + --username string chart repository username where to locate the requested chart + --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 + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm show](helm_show.md) - show information of a chart + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_show_readme.md b/content/en/docs/helm/helm_show_readme.md new file mode 100644 index 0000000000..3a431cae50 --- /dev/null +++ b/content/en/docs/helm/helm_show_readme.md @@ -0,0 +1,63 @@ +--- +title: "Helm Show Readme" +--- + +## helm show readme + +shows the chart's README + +### Synopsis + + +This command inspects a chart (directory, file, or URL) and displays the contents +of the README file + + +``` +helm show readme [CHART] [flags] +``` + +### Options + +``` + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for readme + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --password string chart repository password where to locate the requested chart + --repo string chart repository url where to locate the requested chart + --username string chart repository username where to locate the requested chart + --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 + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm show](helm_show.md) - show information of a chart + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_show_values.md b/content/en/docs/helm/helm_show_values.md new file mode 100644 index 0000000000..f030636fb5 --- /dev/null +++ b/content/en/docs/helm/helm_show_values.md @@ -0,0 +1,63 @@ +--- +title: "Helm Show Values" +--- + +## helm show values + +shows the chart's values + +### Synopsis + + +This command inspects a chart (directory, file, or URL) and displays the contents +of the values.yaml file + + +``` +helm show values [CHART] [flags] +``` + +### Options + +``` + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + -h, --help help for values + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --password string chart repository password where to locate the requested chart + --repo string chart repository url where to locate the requested chart + --username string chart repository username where to locate the requested chart + --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 + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm show](helm_show.md) - show information of a chart + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_status.md b/content/en/docs/helm/helm_status.md index 7af65199d9..aac67163c9 100644 --- a/content/en/docs/helm/helm_status.md +++ b/content/en/docs/helm/helm_status.md @@ -1,6 +1,5 @@ --- title: "Helm Status" -weight: 38 --- ## helm status @@ -10,43 +9,54 @@ displays the status of the named release ### Synopsis - This command shows the status of a named release. The status consists of: - last deployment time - k8s namespace in which the release lives -- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) +- state of the release (can be: unknown, deployed, uninstalled, superseded, failed, uninstalling, pending-install, pending-upgrade or pending-rollback) - list of resources that this release consists of, sorted by kind - details on last test suite run, if applicable - additional notes provided by the chart ``` -helm status [flags] RELEASE_NAME +helm status RELEASE_NAME [flags] ``` ### Options ``` - --revision int32 if set, display the status of the named release with revision - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for status + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + --revision int 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/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_template.md b/content/en/docs/helm/helm_template.md index f51265bed9..077f770ad8 100644 --- a/content/en/docs/helm/helm_template.md +++ b/content/en/docs/helm/helm_template.md @@ -1,6 +1,5 @@ --- title: "Helm Template" -weight: 39 --- ## helm template @@ -10,47 +9,78 @@ locally render templates ### Synopsis - Render chart templates locally and display the output. -This does not require Tiller. However, any values that would normally be -looked up or retrieved in-cluster will be faked locally. Additionally, none -of the server-side testing of chart validity (e.g. whether an API is supported) -is done. - -To render just one template in a chart, use '-x': - - $ helm template mychart -x templates/deployment.yaml +Any values that would normally be looked up or retrieved in-cluster will be +faked locally. Additionally, none of the server-side testing of chart validity +(e.g. whether an API is supported) is done. ``` -helm template [flags] CHART +helm template [NAME] [CHART] [flags] ``` ### Options ``` - -x, --execute stringArray only execute the given templates - --kube-version string override the Kubernetes version used as Capabilities.KubeVersion.Major/Minor (e.g. 1.7) - -n, --name string release name (default "RELEASE-NAME") - --name-template string specify template used to name the release - --namespace string namespace to install the release into - --notes show the computed NOTES.txt file as well - --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) - -f, --values valueFiles specify values in a YAML file (can specify multiple) (default []) + -a, --api-versions stringArray Kubernetes api versions used for Capabilities.APIVersions + --atomic if set, installation process purges chart on fail. The --wait flag will be set automatically if --atomic is used + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + --dependency-update run helm dependency update before installing the chart + --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored + --dry-run simulate an install + -g, --generate-name generate the name (and omit the NAME parameter) + -h, --help help for template + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --name-template string specify template used to name the release + --no-hooks prevent hooks from running during install + --output-dir string writes the executed templates to files in output-dir instead of stdout + --password string chart repository password where to locate the requested chart + --render-subchart-notes if set, render subchart notes along with the parent + --replace re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production + --repo string chart repository url where to locate the requested chart + --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) + --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + -s, --show-only stringArray only show manifests rendered from the given templates + --skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) + --username string chart repository username where to locate the requested chart + --validate validate your manifests against the Kubernetes cluster you are currently pointing at. This is the same validation performed on an install + -f, --values strings specify values in a YAML file or a URL(can specify multiple) + --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 + --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_test.md b/content/en/docs/helm/helm_test.md index 8be711f632..4c781d8964 100644 --- a/content/en/docs/helm/helm_test.md +++ b/content/en/docs/helm/helm_test.md @@ -1,16 +1,14 @@ --- title: "Helm Test" -weight: 40 --- ## helm test -test a release +run tests for a release ### Synopsis - The test command runs the tests for a release. The argument this command takes is the name of a deployed release. @@ -18,32 +16,43 @@ The tests to be run are defined in the chart that was installed. ``` -helm test [RELEASE] +helm test [RELEASE] [flags] ``` ### Options ``` - --cleanup delete test pods upon completion - --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for test + --logs Dump the logs from test pods (this runs after all tests are complete, but before any cleanup) + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_uninstall.md b/content/en/docs/helm/helm_uninstall.md new file mode 100644 index 0000000000..a8e369f148 --- /dev/null +++ b/content/en/docs/helm/helm_uninstall.md @@ -0,0 +1,63 @@ +--- +title: "Helm Uninstall" +--- + +## helm uninstall + +uninstall a release + +### Synopsis + + +This command takes a release name and uninstalls the release. + +It removes all of the resources associated with the last release of the chart +as well as the release history, freeing it up for future use. + +Use the '--dry-run' flag to see which releases will be uninstalled without actually +uninstalling them. + + +``` +helm uninstall RELEASE_NAME [...] [flags] +``` + +### Options + +``` + --dry-run simulate a uninstall + -h, --help help for uninstall + --keep-history remove all associated resources and mark the release as deleted, but retain the release history + --no-hooks prevent hooks from running during uninstallation + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) +``` + +### Options inherited from parent commands + +``` + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [helm](../helm) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_upgrade.md b/content/en/docs/helm/helm_upgrade.md index 8e96a532b8..23a4d02cf8 100644 --- a/content/en/docs/helm/helm_upgrade.md +++ b/content/en/docs/helm/helm_upgrade.md @@ -1,6 +1,5 @@ --- title: "Helm Upgrade" -weight: 41 --- ## helm upgrade @@ -10,75 +9,95 @@ 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, +argument can be either: a chart reference('example/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. +or use the '--set' flag and pass configuration from the command line, to force string +values, use '--set-string'. In case a value is large and therefore +you want not to use neither '--values' nor '--set', use '--set-file' to read the +single large value from file. You can specify the '--values'/'-f' flag multiple times. The priority will be given to the last (right-most) file specified. For example, if both myvalues.yaml and override.yaml contained a key called 'Test', the value set in override.yaml would take precedence: - $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis + $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis You can specify the '--set' flag multiple times. The priority will be given to the last (right-most) set specified. For example, if both 'bar' and 'newbar' values are set for a key called 'foo', the 'newbar' value would take precedence: - $ helm upgrade --set foo=bar --set foo=newbar redis ./redis + $ helm upgrade --set foo=bar --set foo=newbar redis ./redis ``` -helm upgrade [RELEASE] [CHART] +helm upgrade [RELEASE] [CHART] [flags] ``` ### Options ``` - --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle - --cert-file string identify HTTPS client using this SSL certificate file - --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored. - --dry-run simulate an upgrade - --force force resource update through delete/recreate if needed - -i, --install if a release by this name doesn't already exist, run an install - --key-file string identify HTTPS client using this SSL key file - --keyring string path to the keyring that contains public signing keys (default "/Users/roflynnc/.gnupg/pubring.gpg") - --namespace string namespace to install the release into (only used if --install is set). Defaults to the current kube config namespace - --no-hooks disable pre/post upgrade hooks - --recreate-pods performs pods restart for the resource if applicable - --repo string chart repository url where to locate the requested chart - --reset-values when upgrading, reset the values to the ones built into the chart - --reuse-values when upgrading, reuse the last release's values, and merge in any new values. If '--reset-values' is specified, this is ignored. - --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) - --timeout int time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote - -f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default []) - --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 - --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as long as --timeout + --atomic if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used + --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle + --cert-file string identify HTTPS client using this SSL certificate file + --cleanup-on-fail allow deletion of new resources created in this upgrade when upgrade fails + --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored + --dry-run simulate an upgrade + --force force resource updates through a replacement strategy + -h, --help help for upgrade + --history-max int limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) + -i, --install if a release by this name doesn't already exist, run an install + --key-file string identify HTTPS client using this SSL key file + --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg") + --no-hooks disable pre/post upgrade hooks + -o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table) + --password string chart repository password where to locate the requested chart + --render-subchart-notes if set, render subchart notes along with the parent + --repo string chart repository url where to locate the requested chart + --reset-values when upgrading, reset the values to the ones built into the chart + --reuse-values when upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored + --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) + --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) + --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) + --username string chart repository username where to locate the requested chart + -f, --values strings specify values in a YAML file or a URL(can specify multiple) + --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 + --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_verify.md b/content/en/docs/helm/helm_verify.md index 0833a5230d..b41f0931ac 100644 --- a/content/en/docs/helm/helm_verify.md +++ b/content/en/docs/helm/helm_verify.md @@ -1,6 +1,5 @@ --- title: "Helm Verify" -weight: 42 --- ## helm verify @@ -10,7 +9,6 @@ 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 @@ -22,26 +20,42 @@ the 'helm package --sign' command. ``` -helm verify [flags] PATH +helm verify PATH [flags] ``` ### Options ``` - --keyring string keyring containing public keys (default "/Users/roflynnc/.gnupg/pubring.gpg") + -h, --help help for verify + --keyring string keyring containing public keys (default "~/.gnupg/pubring.gpg") ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020 diff --git a/content/en/docs/helm/helm_version.md b/content/en/docs/helm/helm_version.md index f6998190a7..bf1d4ddeb2 100644 --- a/content/en/docs/helm/helm_version.md +++ b/content/en/docs/helm/helm_version.md @@ -1,61 +1,65 @@ --- title: "Helm Version" -weight: 43 --- ## helm version -print the client/server version information +print the client version information ### Synopsis +Show the version for Helm. -Show the client and server versions for Helm and tiller. +This will print a representation the version of Helm. +The output will look something like this: -This will print a representation of the client and server versions of Helm and -Tiller. The output will look something like this: +version.BuildInfo{Version:"v2.0.0", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"clean"} -Client: &version.Version{SemVer:"v2.0.0", GitCommit:"ff52399e51bb880526e9cd0ed8386f6433b74da1", GitTreeState:"clean"} -Server: &version.Version{SemVer:"v2.0.0", GitCommit:"b0c113dfb9f612a9add796549da66c0d294508a3", GitTreeState:"clean"} - -- SemVer is the semantic version of the release. +- Version 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 +helm version [flags] ``` ### Options ``` - -c, --client client version only - -s, --server server version only - --short print the version number - --tls enable TLS for request - --tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem") - --tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem") - --tls-key string path to TLS key file (default "$HELM_HOME/key.pem") - --tls-verify enable TLS for request and verify remote + -h, --help help for version + --short print the version number + --template string template for version string format ``` ### Options inherited from parent commands ``` - --debug enable verbose output - --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/roflynnc/.helm") - --host string address of Tiller. Overrides $HELM_HOST - --kube-context string name of the kubeconfig context to use - --tiller-namespace string namespace of Tiller (default "kube-system") + --add-dir-header If true, adds the file directory to the header + --alsologtostderr log to standard error as well as files + --debug enable verbose output + --kube-context string name of the kubeconfig context to use + --kubeconfig string path to the kubeconfig file + --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log-dir string If non-empty, write log files in this directory + --log-file string If non-empty, use this log file + --log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) + --logtostderr log to standard error instead of files (default true) + -n, --namespace string namespace scope for this request + --registry-config string path to the registry config file (default "~/.config/helm/registry.json") + --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository") + --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml") + --skip-headers If true, avoid header prefixes in the log messages + --skip-log-headers If true, avoid headers when opening log files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level number for the log level verbosity + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO + * [helm](../helm) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 13-Jan-2020 +###### Auto generated by spf13/cobra on 4-Feb-2020