helm/README.md

# Kubernetes Helm

[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/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
- 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 server (`tiller`)
- Tiller runs inside of your Kubernetes cluster, and manages releases (installations)
  of your charts.
- 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

Download a [release tarball of helm for your platform](https://github.com/kubernetes/helm/releases). Unpack the `helm` binary and add it to your PATH and you are good to go! OS X/[Cask](https://caskroom.github.io/) users can `brew cask install helm`.

## Docs

- [Quick Start](docs/quickstart.md)
- [Architecture](docs/architecture.md)
- [Charts](docs/charts.md)
	- [Chart Repository Guide](docs/chart_repository.md)
	- [Syncing your Chart Repository](docs/chart_repository_sync_example.md)
- [Developers](docs/developers.md)

## Community, discussion, contribution, and support

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

- [Kubernetes Slack](https://slack.k8s.io): #helm
- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-apps
- Developer Call: Thursdays at 9:30-10:00 Pacific. https://engineyard.zoom.us/j/366425549
-												docs(README): udate core docs pre-merge

											
										
										
											8 years ago
+								# Kubernetes Helm
-												feat(tiller): stub out environment

											
										
										
											8 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)
-												docs(README): udate core docs pre-merge

											
										
										
											8 years ago
+								Helm is a tool for managing Kubernetes charts. Charts are packages of
 								pre-configured Kubernetes resources.
-												feat(tiller): stub out environment

											
										
										
											8 years ago
-												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
+								Use Helm to...
-												fix(README): add features list

											
										
										
											8 years ago
-												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
+								- Find and use popular software packaged as Kubernetes 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 server (`tiller`)
 								- Tiller runs inside of your Kubernetes cluster, and manages releases (installations)
 								  of your charts.
 								- 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
 								Download a [release tarball of helm for your platform](https://github.com/kubernetes/helm/releases). Unpack the `helm` binary and add it to your PATH and you are good to go! OS X/[Cask](https://caskroom.github.io/) users can `brew cask install helm`.
-												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
-												add docs table of contents and update quick start

Signed-off-by: Jess Frazelle <me@jessfraz.com>

											
										
										
											8 years ago
+								- [Quick Start](docs/quickstart.md)
-												README: fix small typo
											
										
										
											8 years ago
+								- [Architecture](docs/architecture.md)
-												add docs table of contents and update quick start

Signed-off-by: Jess Frazelle <me@jessfraz.com>

											
										
										
											8 years ago
+								- [Charts](docs/charts.md)
 									- [Chart Repository Guide](docs/chart_repository.md)
 									- [Syncing your Chart Repository](docs/chart_repository_sync_example.md)
 								- [Developers](docs/developers.md)
-												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:
 								- [Kubernetes Slack](https://slack.k8s.io): #helm
 								- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-apps
 								- Developer Call: Thursdays at 9:30-10:00 Pacific. https://engineyard.zoom.us/j/366425549