Skip to content

fix(helm): update helm command docs to v3.0.3 #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bacongobbler merged 1 commit into from
Feb 4, 2020
Merged

fix(helm): update helm command docs to v3.0.3 #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
Expand All @@ -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 `<!--more-->` break in your markdown. This will truncate the content with a _Read More_ link.
Expand All @@ -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:

We appreciate your contributions to our website and our documentation! :clap:
4 changes: 2 additions & 2 deletions content/en/docs/helm/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Here you’ll find the list of CLI commands for Helm, with help info on their usage.
96 changes: 61 additions & 35 deletions content/en/docs/helm/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Helm"
weight: 1
---

## helm
Expand All @@ -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
41 changes: 30 additions & 11 deletions content/en/docs/helm/helm_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Helm Completion"
weight: 2
---

## helm completion
Expand All @@ -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
52 changes: 31 additions & 21 deletions content/en/docs/helm/helm_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Helm Create"
weight: 3
---

## helm create
Expand All @@ -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
Expand All @@ -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
Loading