Helm helps you bootstrap your Kubernetes cluster with Charts that provide ready-to-use workloads like:

• A Postgres database
• A scale-out etcd cluster
• An HAProxy Edge Load Balancer

A Chart is a unit of Kubernetes manifests that reflect best practices as determined by the Helm community. Helm's architecture is heavily influenced by Homebrew.

To view or contribute Charts, head over to the charts repo.

helm is changing quickly. Your feedback and participation are more than welcome, but be aware that this project is considered a work in progress.

Grab a prebuilt binary straight off our build pipeline:

Or grab the latest release:

To install helm for daily use, you will need the Go 1.5 runtime. Once that is installed and $GOPATH is set, you can run the following:

$ go get github.com/deis/helm/...

This will install helm into $GOPATH/bin/helm.

To use Helm you'll need a kubectl client installed and configured to speak with a running Kubernetes cluster.

To quickly install a standalone etcd instance:

$ helm update
---> Fetching updates...
---> Done
$ helm search etcd
	etcd-standalone: etcd-standalone is a single Etcd instance (no cluster)
	etcd-ha-cluster: an HA Etcd cluster (3+ pods)
	etcd-discovery:  a single-pod Etcd service discovery server
$ helm info etcd-standalone
	Description: etcd-standalone is a single Etcd instance (no cluster)
	Version: 2.2.0-beta3
	Website: https://github.com/coreos/etcd
	Built: Oct. 21, 2015
	Provides: etcd-rc.yaml etcd-service.yaml
$ helm install etcd-standalone
---> Downloading etcd-standalone-2.2.0-beta3
---> Cached files into $HELM_WORKDIR/charts/etcd-standalone/
---> Running kubectl create -f ...
---> Done

To fetch, customize and install the same chart:

$ helm update
---> Fetching updates...
---> Done
$ helm fetch etcd-standalone etcd
---> Downloading etcd-standalone-2.2.0-beta3
---> Cached files into $HELM_WORKDIR/charts/etcd/
---> Done
$ helm edit etcd
$ helm install etcd
---> Found etcd in $HELM_WORKDIR/charts/etcd/ ...
---> Running kubectl create -f ...

Helm charts are developed as part of a community effort. To contribute:

1. Fork Helm
2. helm create mychart && helm edit mychart
3. helm publish mychart
4. cd $HELM_CACHEDIR && git checkout -b mychart
5. git add charts/mychart && git commit && git push
6. Submit a Pull Request

For helm Go developers, we suggest installing glide and then running make build or make install.

Copyright 2015 Engine Yard, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.