helm/README.md

# Kubernetes Helm

[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm)
[![GoDoc](https://godoc.org/github.com/kubernetes/helm?status.svg)](https://godoc.org/github.com/kubernetes/helm)

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

Use Helm to:

- Find and use [popular software packaged as Kubernetes charts](https://github.com/helm/charts)
- Share your own applications as Kubernetes 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 at the following links:

- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-darwin-amd64.tar.gz)
- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-amd64.tar.gz)
- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-386.tar.gz)
- [Windows](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-windows-amd64.tar.gz)

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

If you want to use a package manager:

- macOS/[homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
- Windows/[chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-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](http://slack.k8s.io):
  - #helm-users
  - #helm-dev
  - #charts
- Mailing Lists:
  - [Helm Mailing List](https://lists.cncf.io/g/cncf-kubernetes-helm)
  - [Kubernetes SIG Apps Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-apps)
- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/4526666954](https://zoom.us/j/4526666954)

### Code of conduct

Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
docs(README): udate core docs pre-merge 9 years ago			`# Kubernetes Helm`
feat(tiller): stub out environment 9 years ago
docs(ci): add cicleci badge to readme 8 years ago			`[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm)`
Updated as per suggestion 7 years ago			`[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm)`
			`[![GoDoc](https://godoc.org/github.com/kubernetes/helm?status.svg)](https://godoc.org/github.com/kubernetes/helm)`
docs(ci): add cicleci badge to readme 8 years ago
docs(README): udate core docs pre-merge 9 years ago			`Helm is a tool for managing Kubernetes charts. Charts are packages of`
			`pre-configured Kubernetes resources.`
feat(tiller): stub out environment 9 years ago
Update README.md There should be a colon because it precedes an explanation or an enumeration, or list. 7 years ago			`Use Helm to:`
fix(README): add features list 9 years ago
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> 6 years ago			`- Find and use [popular software packaged as Kubernetes charts](https://github.com/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. 8 years ago			`- Share your own applications as Kubernetes 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.`

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> 6 years ago			- 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. 8 years ago			`- 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. 8 years ago			`## Install`

chore(*): bump to v2.0.0 8 years ago			`Binary downloads of the Helm client can be found at the following links:`
docs(README): update download information 8 years ago
bump version to v2.8.1 (cherry picked from commit a80231648a1473929271764b920a8e346f6de844) 7 years ago			`- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-darwin-amd64.tar.gz)`
			`- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-amd64.tar.gz)`
			`- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-linux-386.tar.gz)`
			`- [Windows](https://kubernetes-helm.storage.googleapis.com/helm-v2.8.2-windows-amd64.tar.gz)`
docs(README): update download information 8 years ago
Update docs for homebrew formula 8 years ago			Unpack the `helm` binary and add it to your PATH and you are good to go!
Updates readme with choco install command 7 years ago
			`If you want to use a package manager:`

			- macOS/[homebrew](https://brew.sh/) users can use `brew install kubernetes-helm`.
			- Windows/[chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-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. 8 years ago
Update README with links to docs.helm.sh 8 years ago			`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 8 years ago
Update README with links to docs.helm.sh 8 years ago			`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. 8 years ago			`including installing pre-releases.`

add docs table of contents and update quick start Signed-off-by: Jess Frazelle <me@jessfraz.com> 8 years ago			`## 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. 8 years ago
Update README with links to docs.helm.sh 8 years ago			`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 8 years ago
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 8 years ago			`## 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> 6 years ago			`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 8 years ago
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 8 years ago			`## Community, discussion, contribution, and support`

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

Fix link to Slack 7 years ago			`- [Kubernetes Slack](http://slack.k8s.io):`
Update Slack channels 8 years ago			`- #helm-users`
			`- #helm-dev`
Update README to point to #charts channel on slack too 7 years ago			`- #charts`
chore(README): add ref to helm mailing list 7 years ago			`- Mailing Lists:`
			`- [Helm Mailing List](https://lists.cncf.io/g/cncf-kubernetes-helm)`
			`- [Kubernetes SIG Apps Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-apps)`
chore(README.md): update zoom meeting link 8 years ago			`- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/4526666954](https://zoom.us/j/4526666954)`
feat(README): call out the code of conduct Lifted from https://raw.githubusercontent.com/kubernetes/kubernetes-template-project/master/README.md 8 years ago
			`### Code of conduct`

			`Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).`