helm/README.md

# Helm

[![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm)
[![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)
[![GoDoc](https://godoc.org/helm.sh/helm?status.svg)](https://godoc.org/helm.sh/helm)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3131/badge)](https://bestpractices.coreinfrastructure.org/projects/3131)

Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.

Use Helm to:

- Find and use [popular software packaged as Helm Charts](https://github.com/helm/charts) to run in Kubernetes
- Share your own applications as Helm Charts
- Create reproducible builds of your Kubernetes applications
- Intelligently manage your Kubernetes manifest files
- Manage releases of Helm packages

## Helm in a Handbasket

Helm is a tool that streamlines installing and managing Kubernetes applications.
Think of it like apt/yum/homebrew for Kubernetes.

- Helm has two parts: a client (`helm`) and a library
- The library renders your templates and communicates with the Kubernetes API
- Helm runs on your laptop, CI/CD, or wherever you want it to run.
- Charts are Helm packages that contain at least two things:
  - A description of the package (`Chart.yaml`)
  - One or more templates, which contain Kubernetes manifest files
- Charts can be stored on disk, or fetched from remote chart repositories
  (like Debian or RedHat packages)

## Install


Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).

Unpack the `helm` binary and add it to your PATH and you are good to go!

If you want to use a package manager:

- [Homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
- [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
- [Scoop](https://scoop.sh/) users can use `scoop install helm`.
- [GoFish](https://gofi.sh/) users can use `gofish install helm`.

To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide).

See the [installation guide](https://docs.helm.sh/using_helm/#installing-helm) for more options,
including installing pre-releases.

## Docs

Get started with the [Quick Start guide](https://docs.helm.sh/using_helm/#quickstart-guide) or plunge into the [complete documentation](https://docs.helm.sh)

## Roadmap

The [Helm roadmap uses Github milestones](https://github.com/helm/helm/milestones) to track the progress of the project.

## Community, discussion, contribution, and support

You can reach the Helm community and developers via the following channels:

- [Kubernetes Slack](https://kubernetes.slack.com):
  - [#helm-users](https://kubernetes.slack.com/messages/helm-users)
  - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
  - [#charts](https://kubernetes.slack.com/messages/charts)
- Mailing List:
  - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/696660622](https://zoom.us/j/696660622)

### Code of conduct

Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`# Helm`
feat(tiller): stub out environment 2016-04-11 15:26:33 -04:00
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`[![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)`
feat(*): use vanity import helm.sh/helm Signed-off-by: Adam Reese <adam@reese.io> 2019-03-12 19:06:06 -04:00			`[![GoDoc](https://godoc.org/helm.sh/helm?status.svg)](https://godoc.org/helm.sh/helm)`
docs: Add best practices compliance badge (#6320) This is now required by CNCF for graduation from incubation. Signed-off-by: Matt Butcher <matt.butcher@microsoft.com> 2019-08-30 15:06:38 -04:00			`[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3131/badge)](https://bestpractices.coreinfrastructure.org/projects/3131)`
docs(ci): add cicleci badge to readme 2016-07-06 13:38:34 -04:00
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.`
feat(tiller): stub out environment 2016-04-11 15:26:33 -04:00
Update README.md There should be a colon because it precedes an explanation or an enumeration, or list. 2017-10-19 02:14:28 -04:00			`Use Helm to:`
fix(README): add features list 2016-04-28 19:09:33 -04:00
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`- Find and use [popular software packaged as Helm Charts](https://github.com/helm/charts) to run in Kubernetes`
			`- Share your own applications as Helm Charts`
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status. 2016-07-20 09:30:10 -04:00			`- Create reproducible builds of your Kubernetes applications`
			`- Intelligently manage your Kubernetes manifest files`
			`- Manage releases of Helm packages`

			`## Helm in a Handbasket`

			`Helm is a tool that streamlines installing and managing Kubernetes applications.`
			`Think of it like apt/yum/homebrew for Kubernetes.`

doc(helm): remove Tiller reference from the docs (#4788) * Remove Tiller reference from the docs Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com> * Update comments after review - https://github.com/helm/helm/pull/4788#discussion_r226037034 - https://github.com/helm/helm/pull/4788#discussion_r226037064 - https://github.com/helm/helm/pull/4788#discussion_r226037806 - https://github.com/helm/helm/pull/4788#discussion_r226038492 - https://github.com/helm/helm/pull/4788#discussion_r226039202 - https://github.com/helm/helm/pull/4788#discussion_r226039894 Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com> 2018-10-18 13:30:39 -04:00			- Helm has two parts: a client (`helm`) and a library
			`- The library renders your templates and communicates with the Kubernetes API`
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status. 2016-07-20 09:30:10 -04:00			`- Helm runs on your laptop, CI/CD, or wherever you want it to run.`
			`- Charts are Helm packages that contain at least two things:`
			- A description of the package (`Chart.yaml`)
			`- One or more templates, which contain Kubernetes manifest files`
			`- Charts can be stored on disk, or fetched from remote chart repositories`
			`(like Debian or RedHat packages)`

docs(README): remove the build from source instructions docs/developers.md already has these instructions. And 80% of the time someone looking at this project is interested in getting started not hacking directly. 2016-09-10 17:04:13 -04:00			`## Install`

docs(README): update download information 2016-10-10 14:59:06 -04:00
docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).`
docs(README): update download information 2016-10-10 14:59:06 -04:00
Update docs for homebrew formula 2016-12-21 13:26:32 -05:00			Unpack the `helm` binary and add it to your PATH and you are good to go!
Updates readme with choco install command 2018-04-05 17:51:21 -04:00
			`If you want to use a package manager:`

docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			- [Homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
			- [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
			- [Scoop](https://scoop.sh/) users can use `scoop install helm`.
			- [GoFish](https://gofi.sh/) users can use `gofish install helm`.
docs(README): remove the build from source instructions docs/developers.md already has these instructions. And 80% of the time someone looking at this project is interested in getting started not hacking directly. 2016-09-10 17:04:13 -04:00
Update README with links to docs.helm.sh 2017-06-22 01:38:46 -04:00			`To rapidly get Helm up and running, start with the [Quick Start Guide](https://docs.helm.sh/using_helm/#quickstart-guide).`
feat(helm): remove the requirement that fetch/install need version This removes the requirement that a fetch or install command must explicitly state the version number to install. Instead, this goes to the strategy used by OS package managers: Install the latest until told to do otherwise. Closes #1198 2016-10-05 14:43:06 -04:00
Update README with links to docs.helm.sh 2017-06-22 01:38:46 -04:00			`See the [installation guide](https://docs.helm.sh/using_helm/#installing-helm) for more options,`
docs(install): Add information on using canary releases This includes documentation on how to use Helm and Tiller canary releases. 2016-10-04 17:48:08 -04:00			`including installing pre-releases.`

add docs table of contents and update quick start Signed-off-by: Jess Frazelle <me@jessfraz.com> 2016-08-22 14:18:28 -04:00			`## Docs`
docs(README): update README with basic information The README reflected an earlier stage of project development. This update gives more useful "Why Helm?" documentation at the top, and updates several of the instructions to be more reflective of current status. 2016-07-20 09:30:10 -04:00
Update README with links to docs.helm.sh 2017-06-22 01:38:46 -04:00			`Get started with the [Quick Start guide](https://docs.helm.sh/using_helm/#quickstart-guide) or plunge into the [complete documentation](https://docs.helm.sh)`
feat(README): add community contact points Add the sig-apps mailing list, developer call details, and #helm slack channel. Based on https://github.com/kubernetes/kubernetes-template-project/blob/master/README.md 2016-09-12 20:22:45 -04:00
feat(README): Adding roadmap location To exit incubation the roadmap needs to be listed in the wiki per the incubator documentation. For more detail see https://github.com/kubernetes/community/blob/master/incubator.md 2017-02-02 10:12:36 -05:00			`## Roadmap`

ref(url) update helm's github url (#4962) https://github.com/kubernetes/helm -> https://github.com/helm/helm https://github.com/kubernetes/charts -> https://github.com/helm/charts Signed-off-by: Roc Chan <roc@imroc.io> 2018-11-28 13:08:38 -05:00			`The [Helm roadmap uses Github milestones](https://github.com/helm/helm/milestones) to track the progress of the project.`
feat(README): Adding roadmap location To exit incubation the roadmap needs to be listed in the wiki per the incubator documentation. For more detail see https://github.com/kubernetes/community/blob/master/incubator.md 2017-02-02 10:12:36 -05:00
feat(README): add community contact points Add the sig-apps mailing list, developer call details, and #helm slack channel. Based on https://github.com/kubernetes/kubernetes-template-project/blob/master/README.md 2016-09-12 20:22:45 -04:00			`## Community, discussion, contribution, and support`

			`You can reach the Helm community and developers via the following channels:`

docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`- [Kubernetes Slack](https://kubernetes.slack.com):`
			`- [#helm-users](https://kubernetes.slack.com/messages/helm-users)`
			`- [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)`
			`- [#charts](https://kubernetes.slack.com/messages/charts)`
			`- Mailing List:`
			`- [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)`
			`- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/696660622](https://zoom.us/j/696660622)`
feat(README): call out the code of conduct Lifted from https://raw.githubusercontent.com/kubernetes/kubernetes-template-project/master/README.md 2016-09-13 12:36:41 -04:00
			`### Code of conduct`

docs: s,kubernetes/helm,helm/helm,g (#5404) Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com> 2019-03-05 14:57:39 -05:00			`Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).`