The Kubernetes Package Manager

Go to file

Rimas 5a56449a2f replace github org with The Kubernetes package manager To begin working with Helm, run the 'helm init' command: $ helm init This will install Tiller to your running Kubernetes cluster. It will also set up any necessary local configuration. Common actions from this point include: - helm search: search for charts - helm fetch: download a chart to your local directory to view - helm install: upload the chart to Kubernetes - helm list: list releases of charts Environment: $HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm $HELM_HOST set an alternative Tiller host. The format is host:port $HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. $TILLER_NAMESPACE set an alternative Tiller namespace (default "kube-system") $KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config") Usage: helm [command] Available Commands: completion Generate autocompletions script for the specified shell (bash or zsh) create create a new chart with the given name delete given a release name, delete the release from Kubernetes dependency manage a chart's dependencies fetch download a chart from a repository and (optionally) unpack it in local directory get download a named release history fetch release history home displays the location of HELM_HOME init initialize Helm on both client and server inspect inspect a chart install install a chart archive lint examines a chart for possible issues list list releases package package a chart directory into a chart archive plugin add, list, or remove Helm plugins repo add, list, remove, update, and index chart repositories reset uninstalls Tiller from a cluster rollback roll back a release to a previous revision search search for a keyword in charts serve start a local http web server status displays the status of the named release template locally render templates test test a release upgrade upgrade a release verify verify that a chart at the given path has been signed and is valid version print the client/server version information Flags: --debug enable verbose output -h, --help help for helm --home string location of your Helm config. Overrides $HELM_HOME (default "/Users/rimas/.helm") --host string address of Tiller. Overrides $HELM_HOST --kube-context string name of the kubeconfig context to use --tiller-connection-timeout int the duration (in seconds) Helm will wait to establish a connection to tiller (default 300) --tiller-namespace string namespace of Tiller (default "kube-system") Use "helm [command] --help" for more information about a command. one		6 years ago
.circleci	bump go to 1.10	7 years ago
.github	Update to specify version command output.	7 years ago
_proto	Merge pull request #3825 from adshmh/3581-feat-allow-custom-desc-after-helm-release-upgrade	6 years ago
cmd	fix path output for Windows	6 years ago
docs	soften the recommendation of hypens in chart names	6 years ago
pkg	feat: Set values from local files (#3758 )	6 years ago
rootfs	build helm binary in tiller image	7 years ago
scripts	replace github org with The Kubernetes package manager	6 years ago
testdata	test(*): add tests for new tls support	8 years ago
.gitignore	build helm binary in tiller image	7 years ago
CONTRIBUTING.md	Merge pull request #3739 from fqsghostcloud/rename	6 years ago
LICENSE	fix(LICENSE): add copyright year and authors	8 years ago
Makefile	Add s390 architecture in TARGETS	7 years ago
OWNERS	docs(OWNERS): add rimusz as emeritus maintainer (#4357 )	6 years ago
README.md	README: updated links to helm/helm	6 years ago
SECURITY_CONTACTS	add SECURITY_CONTACTS	6 years ago
code-of-conduct.md	Update code-of-conduct.md	7 years ago
glide.lock	chore(sprig): bump sprig to 2.15.0	6 years ago
glide.yaml	chore(sprig): bump sprig to 2.15.0	6 years ago
versioning.mk	fixed an issue in versioning.mk (#3653 )	7 years ago

README.md

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
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 latest 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:

macOS/homebrew users can use brew install kubernetes-helm.
Windows/chocolatey users can use choco 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.

Community, discussion, contribution, and support

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

Kubernetes Slack:
- #helm-users
- #helm-dev
- #charts
Mailing Lists:
- Helm Mailing List
- Kubernetes SIG Apps Mailing List
Developer Call: Thursdays at 9:30-10:00 Pacific. https://zoom.us/j/4526666954

Code of conduct

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