README
¶
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
- 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 at the following links:
Unpack the helm binary and add it to your PATH and you are good to go! OS X/Cask users can brew cask 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
- Quick Start
- Installing Helm
- Using Helm
- Developing Charts
- Chart Template Developer's Guide
- Getting Started with Templates
- Built-in Objects
- Values Files
- Functions and Pipelines
- Flow Control (if/else, with, range, whitespace management)
- Variables
- Named Templates (Partials)
- Accessing Files Inside Templates
- Creating a NOTES.txt File
- Subcharts and Global Values
- Debugging Templates
- Wrapping Up
- Appendix A: YAML Techniques
- Appendix B: Go Data Types
- Architecture
- Developers
- History
- Glossary
Community, discussion, contribution, and support
You can reach the Helm community and developers via the following channels:
- Kubernetes Slack: #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
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
helm/downloader
Package downloader provides a library for downloading charts.
|
Package downloader provides a library for downloading charts. |
|
helm/search
Package search provides client-side repository searching.
|
Package search provides client-side repository searching. |
|
helm/strvals
Package strvals provides tools for working with strval lines.
|
Package strvals provides tools for working with strval lines. |
|
pkg
|
|
|
chartutil
Package chartutil contains tools for working with charts.
|
Package chartutil contains tools for working with charts. |
|
engine
Package engine implements the Go template engine as a Tiller Engine.
|
Package engine implements the Go template engine as a Tiller Engine. |
|
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. |
|
proto/hapi/chart
Package chart is a generated protocol buffer package.
|
Package chart is a generated protocol buffer package. |
|
proto/hapi/release
Package release is a generated protocol buffer package.
|
Package release is a generated protocol buffer package. |
|
proto/hapi/services
Package services is a generated protocol buffer package.
|
Package services is a generated protocol buffer package. |
|
proto/hapi/version
Package version is a generated protocol buffer package.
|
Package version is a generated protocol buffer package. |
|
provenance
Package provenance provides tools for establishing the authenticity of a chart.
|
Package provenance provides tools for establishing the authenticity of a chart. |
|
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. |
|
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.