README.md 3.01 KB
Newer Older
1
# Kubernetes Helm
2

3
[![CircleCI](https://circleci.com/gh/kubernetes/helm.svg?style=svg)](https://circleci.com/gh/kubernetes/helm)
4
5
[![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)
6

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

10
Use Helm to...
Matt Butcher's avatar
Matt Butcher committed
11

12
- Find and use [popular software packaged as Kubernetes charts](https://github.com/kubernetes/charts)
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
- 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)

33
34
## Install

Adam Reese's avatar
Adam Reese committed
35
Binary downloads of the Helm client can be found at the following links:
36

Adam Reese's avatar
Adam Reese committed
37
38
39
- [OSX](https://kubernetes-helm.storage.googleapis.com/helm-v2.6.0-darwin-amd64.tar.gz)
- [Linux](https://kubernetes-helm.storage.googleapis.com/helm-v2.6.0-linux-amd64.tar.gz)
- [Linux 32-bit](https://kubernetes-helm.storage.googleapis.com/helm-v2.6.0-linux-386.tar.gz)
40

41
42
Unpack the `helm` binary and add it to your PATH and you are good to go!
macOS/[homebrew](https://brew.sh/) users can also use `brew install kubernetes-helm`.
43

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

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

49
## Docs
50

51
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)
52

53
54
55
56
## Roadmap

The [Helm roadmap is currently located on the wiki](https://github.com/kubernetes/helm/wiki/Roadmap).

57
58
59
60
## Community, discussion, contribution, and support

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

Trevor Hartman's avatar
Trevor Hartman committed
61
62
63
- [Kubernetes Slack](https://slack.k8s.io):
  - #helm-users
  - #helm-dev
64
  - #charts
65
- Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-apps
66
- Developer Call: Thursdays at 9:30-10:00 Pacific. [https://zoom.us/j/4526666954](https://zoom.us/j/4526666954)
67
68
69
70

### Code of conduct

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