README.md 4.28 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
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/helm)](https://goreportcard.com/report/github.com/kubernetes/helm)
5

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

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

11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
- 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)

32
33
## Install

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

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

40
41
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`.
42

43
44
To rapidly get Helm up and running, start with the [Quick Start Guide](docs/quickstart.md).

45
46
47
See the [installation guide](docs/install.md) for more options,
including installing pre-releases.

48

49
## Docs
50

51
- [Quick Start](docs/quickstart.md)
52
- [Installing Helm](docs/install.md)
53
  - [Kubernetes Distribution Notes](docs/kubernetes_distros.md)
54
  - [Frequently Asked Questions](docs/install_faq.md)
55
- [Using Helm](docs/using_helm.md)
56
  - [Plugins](docs/plugins.md)
57
- [Developing Charts](docs/charts.md)
Fabian Ruff's avatar
Fabian Ruff committed
58
59
	- [Chart Lifecycle Hooks](docs/charts_hooks.md)
	- [Chart Tips and Tricks](docs/charts_tips_and_tricks.md)
60
61
	- [Chart Repository Guide](docs/chart_repository.md)
	- [Syncing your Chart Repository](docs/chart_repository_sync_example.md)
Matt Butcher's avatar
Matt Butcher committed
62
	- [Signing Charts](docs/provenance.md)
63
64
65
66
67
68
69
70
71
72
73
74
75
- [Chart Template Developer's Guide](docs/chart_template_guide/index.md)
  - [Getting Started with Templates](docs/chart_template_guide/getting_started.md)
  - [Built-in Objects](docs/chart_template_guide/builtin_objects.md)
  - [Values Files](docs/chart_template_guide/values_files.md)
  - [Functions and Pipelines](docs/chart_template_guide/functions_and_pipelines.md)
  - [Flow Control (if/else, with, range, whitespace management)](docs/chart_template_guide/control_structures.md)
  - [Variables](docs/chart_template_guide/variables.md)
  - [Named Templates (Partials)](docs/chart_template_guide/named_templates.md)
  - [Accessing Files Inside Templates](docs/chart_template_guide/accessing_files.md)
  - [Creating a NOTES.txt File](docs/chart_template_guide/notes_files.md)
  - [Subcharts and Global Values](docs/chart_template_guide/subcharts_and_globals.md)
  - [Debugging Templates](docs/chart_template_guide/debugging.md)
  - [Wrapping Up](docs/chart_template_guide/wrapping_up.md)
76
77
  - [Appendix A: YAML Techniques](docs/chart_template_guide/yaml_techniques.md)
  - [Appendix B: Go Data Types](docs/chart_template_guide/data_types.md)
78
- [Architecture](docs/architecture.md)
79
- [Developers](docs/developers.md)
80
- [History](docs/history.md)
Matt Butcher's avatar
Matt Butcher committed
81
- [Glossary](docs/glossary.md)
82
83
84
85
86
87
88
89

## 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
90
91
92
93

### Code of conduct

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