The Kubernetes Package Manager
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.
 
 
 
Go to file
Adam Reese 4e625df328
fix(helmpath): fix syntax errors for windows tests
5 years ago
.circleci Enable style conformance test in circleci build 5 years ago
.github Update to specify version command output. 7 years ago
cmd/helm chore(cmd): Updates --wait flag help 5 years ago
internal feat(cli): support XDG base directory specification 5 years ago
pkg fix(helmpath): fix syntax errors for windows tests 5 years ago
scripts feat(cli): support XDG base directory specification 5 years ago
testdata test(*): add tests for new tls support 8 years ago
.gitignore chore(docs): move docs to helm-www 6 years ago
.golangci.yml feat(*): use vanity import helm.sh/helm 6 years ago
CONTRIBUTING.md docs(CONTRIBUTING): one LGTM for maintainers, remove "always 2 LGTMs" policy 6 years ago
Gopkg.lock ref(*): Refactors kube client to be a bit more friendly 5 years ago
Gopkg.toml ref(*): Refactors kube client to be a bit more friendly 5 years ago
LICENSE fix(LICENSE): add copyright year and authors 9 years ago
Makefile feat(cli): support XDG base directory specification 5 years ago
OWNERS Updating OWERS to remove outdated reviewers and to reflect current case 6 years ago
README.md feat(*): use vanity import helm.sh/helm 6 years ago
code-of-conduct.md Update code-of-conduct.md 7 years ago

README.md

Helm

CircleCI Go Report Card GoDoc

Helm is a tool for managing 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 library
  • The library renders your templates and communicates with the Kubernetes API
  • 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.

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:

Code of conduct

Participation in the Helm community is governed by the Code of Conduct.