Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,22 @@ Pull requests require [maintainer](https://github.com/helm/helm-www/blob/master/

### How to Edit The Helm Docs

Since the release of Helm 3, all project documentation is located in this repo under `/content/en/docs/`.
Since the release of Helm 3, all project documentation is located in this repo under `/content/en/docs/`.

For earlier versions, see the `dev-v2` branch of the main Helm repo [here](https://github.com/helm/helm/tree/dev-v2/docs).
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.


### How to Write a Blog Post
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/community/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Community"
weight: 6
weight: 7
---

# Community Guides
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Frequently Asked Questions"
description: "What are the key differences between Helm 2 and Helm 3? Visit the FAQs for insights."
weight: 1
weight: 8
---

This page provides help with the most common questions about Helm.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/glossary.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Glossary"
description: "Terms used to describe components of Helm's architecture."
weight: 2
weight: 9
---

## Chart
Expand Down
10 changes: 10 additions & 0 deletions content/en/docs/helm/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Helm Commands"
description: "Documentation for the full list off 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.
75 changes: 75 additions & 0 deletions content/en/docs/helm/helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: "Helm"
weight: 1
---

## helm

The Helm package manager for Kubernetes.

### Synopsis


The Kubernetes package manager

To begin working with Helm, run the 'helm init' command:

$ helm init

This will install Tiller to your running Kubernetes cluster.
It will also set up any necessary local configuration.

Common actions from this point include:

- helm search: search for charts
- helm fetch: download a chart to your local directory to view
- helm install: upload the chart to Kubernetes
- helm list: list releases of charts

Environment:
$HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm
$HELM_HOST set an alternative Tiller host. The format is host:port
$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")


### 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")
```

### 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 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 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 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 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 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

###### Auto generated by spf13/cobra on 13-Jan-2020
42 changes: 42 additions & 0 deletions content/en/docs/helm/helm_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "Helm Completion"
weight: 2
---

## helm completion

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

Can be sourced as such

$ source <(helm completion bash)


```
helm completion SHELL
```

### 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
61 changes: 61 additions & 0 deletions content/en/docs/helm/helm_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "Helm Create"
weight: 3
---

## helm create

create a new chart with the given name

### Synopsis



This command creates a chart directory along with the common files and
directories used in a chart.

For example, 'helm create foo' will create a directory structure that looks
something like this:

foo/
|
|- .helmignore # Contains patterns to ignore when packaging Helm charts.
|
|- Chart.yaml # Information about your chart
|
|- values.yaml # The default values for your templates
|
|- charts/ # Charts that this chart depends on
|
|- templates/ # The template files

'helm create' takes a path for an argument. If directories in the given path
do not exist, Helm will attempt to create them as it goes. If the given
destination exists and there are files in that directory, conflicting files
will be overwritten, but other files will be left alone.


```
helm create NAME
```

### Options

```
-p, --starter string the named 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")
```

### SEE ALSO
* [helm](../helm) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 13-Jan-2020
52 changes: 52 additions & 0 deletions content/en/docs/helm/helm_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
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
78 changes: 78 additions & 0 deletions content/en/docs/helm/helm_dependency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: "Helm Dependency"
weight: 5
---

## helm dependency

manage a chart's dependencies

### Synopsis



Manage the dependencies of a chart.

Helm charts store their dependencies in 'charts/'. For chart developers, it is
often easier to manage a single dependency file ('requirements.yaml')
which declares all dependencies.

The dependency commands operate on that file, making it easy to synchronize
between the desired dependencies and the actual dependencies stored in the
'charts/' directory.

A 'requirements.yaml' file is a YAML file in which developers can declare chart
dependencies, along with the location of the chart and the desired version.
For example, this requirements file declares two dependencies:

# requirements.yaml
dependencies:
- name: nginx
version: "1.2.3"
repository: "https://example.com/charts"
- name: memcached
version: "3.2.1"
repository: "https://another.example.com/charts"

The 'name' should be the name of a chart, where that name must match the name
in that chart's 'Chart.yaml' file.

The 'version' field should contain a semantic version or version range.

The 'repository' URL should point to a Chart Repository. Helm expects that by
appending '/index.yaml' to the URL, it should be able to retrieve the chart
repository's index. Note: 'repository' can be an alias. The alias must start
with 'alias:' or '@'.

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
dependencies:
- name: nginx
version: "1.2.3"
repository: "file://../dependency_chart/nginx"

If the dependency chart is retrieved locally, it is not required to have the
repository added to helm by "helm add repo". Version matching is also supported
for this case.


### 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 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

###### Auto generated by spf13/cobra on 13-Jan-2020
Loading