mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
79 lines
3.4 KiB
79 lines
3.4 KiB
# Helm
|
|
|
|
[](https://circleci.com/gh/helm/helm)
|
|
[](https://goreportcard.com/report/github.com/helm/helm)
|
|
[](https://godoc.org/k8s.io/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 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 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
|
|
|
|
|
|
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`.
|
|
- [Snap](https://snapcraft.io/) users can use `sudo snap install helm
|
|
--classic`.
|
|
|
|
Information can be found in the ["From Script" guide](https://helm.sh/docs/using_helm/#from-script) if you want to install Helm using an installer script.
|
|
|
|
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).
|