README
¶
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 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
- A description of the package (
- 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.
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 users can use
brew install kubernetes-helm. - Chocolatey users can use
choco install kubernetes-helm. - Scoop users can use
scoop install helm. - GoFish users can use
gofish install helm.
To rapidly get Helm up and running, start with the Quick Start Guide.
See the installation guide for more options, including installing pre-releases.
Docs
Get started with the Quick Start guide or plunge into the complete documentation
Roadmap
The Helm roadmap uses Github 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:
- Mailing List:
- Developer Call: Thursdays at 9:30-10:00 Pacific. https://zoom.us/j/696660622
Code of conduct
Participation in the Helm community is governed by the Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
helm/search
Package search provides client-side repository searching.
|
Package search provides client-side repository searching. |
|
pkg
|
|
|
chartutil
Package chartutil contains tools for working with charts.
|
Package chartutil contains tools for working with charts. |
|
downloader
Package downloader provides a library for downloading charts.
|
Package downloader provides a library for downloading charts. |
|
engine
Package engine implements the Go template engine as a Tiller Engine.
|
Package engine implements the Go template engine as a Tiller Engine. |
|
getter
Package getter provides a generalize tool for fetching data by scheme.
|
Package getter provides a generalize tool for fetching data by scheme. |
|
helm/environment
Package environment describes the operating environment for Tiller.
|
Package environment describes the operating environment for Tiller. |
|
ignore
Package ignore provides tools for writing ignore files (a la .gitignore).
|
Package ignore provides tools for writing ignore files (a la .gitignore). |
|
lint/support
Package support contains tools for linting charts.
|
Package support contains tools for linting charts. |
|
manifest
Package manifest contains tools for working with kubernetes manifests.
|
Package manifest contains tools for working with kubernetes manifests. |
|
plugin/cache
Package cache provides a key generator for vcs urls.
|
Package cache provides a key generator for vcs urls. |
|
plugin/installer
Package installer provides an interface for installing Helm plugins.
|
Package installer provides an interface for installing Helm plugins. |
|
provenance
Package provenance provides tools for establishing the authenticity of a chart.
|
Package provenance provides tools for establishing the authenticity of a chart. |
|
renderutil
Package renderutil contains tools related to the local rendering of charts.
|
Package renderutil contains tools related to the local rendering of charts. |
|
repo
Package repo implements the Helm Chart Repository.
|
Package repo implements the Helm Chart Repository. |
|
repo/repotest
Package repotest provides utilities for testing.
|
Package repotest provides utilities for testing. |
|
strvals
Package strvals provides tools for working with strval lines.
|
Package strvals provides tools for working with strval lines. |
|
tiller/environment
Package environment describes the operating environment for Tiller.
|
Package environment describes the operating environment for Tiller. |
|
timeconv
Package timeconv contains utilities for converting time.
|
Package timeconv contains utilities for converting time. |
|
version
Package version represents the current version of the project.
|
Package version represents the current version of the project. |
Click to show internal directories.
Click to hide internal directories.