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
Scott Rigby bd29e5edc2
Merge pull request #31217 from helm/plugin-postrender-type
5 hours ago
.github feature: add stale pr workflow 2 weeks ago
cmd/helm Move logging setup to be configurable 2 months ago
internal Move Postrenderer to a plugin type 7 hours ago
pkg Move Postrenderer to a plugin type 7 hours ago
scripts Remove 'coveralls' 6 months ago
testdata Do not explicitly set SNI in HTTPGetter 5 months ago
.gitignore Removing the alpine test chart 5 months ago
.golangci.yml chore: enable usetesting linter 3 months ago
ADOPTERS.md Add Percona to the list of organizations using Helm 7 months ago
CONTRIBUTING.md chore: update profiling doc in CONTRIBUTING.md 7 months ago
KEYS adding-my-key 7 months ago
LICENSE fix(LICENSE): add copyright year and authors 9 years ago
Makefile fix: make file whitespace 2 days ago
OWNERS chore(OWNERS): Add TerryHowe as Triage Maintainer 4 months ago
README.md fix: LFX health score badge link 1 month ago
SECURITY.md Adding security file 6 years ago
code-of-conduct.md Fixing the code of conduct pointer 6 years ago
go.mod chore(deps): bump github.com/stretchr/testify from 1.11.0 to 1.11.1 4 days ago
go.sum chore(deps): bump github.com/stretchr/testify from 1.11.0 to 1.11.1 4 days ago

README.md

Helm

Build Status Go Report Card GoDoc CII Best Practices OpenSSF Scorecard LFX Health Score

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 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)

Helm Development and Stable Versions

Helm v4 is currently under development on the main branch. This is unstable and the APIs within the Go SDK and at the command line are changing. Helm v3 (current stable) is maintained on the dev-v3 branch. APIs there follow semantic versioning.

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 helm.
  • Chocolatey users can use choco install kubernetes-helm.
  • Winget users can use winget install Helm.Helm.
  • Scoop users can use scoop install helm.
  • Snapcraft users can use snap install helm --classic.
  • Flox users can use flox install kubernetes-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.

The development of Helm v4 is currently happening on the main branch while the development of Helm v3, the stable branch, is happening on the dev-v3 branch. Changes should be made to the main branch prior to being added to the dev-v3 branch so that all changes are carried along to Helm v4.

Community, discussion, contribution, and support

You can reach the Helm community and developers via the following channels:

Contribution

If you're interested in contributing, please refer to the Contributing Guide before submitting a pull request.

Code of conduct

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