Helm Classic - The Kubernetes Package Manager
Go Makefile
Latest commit a9c55cf Aug 20, 2016 @mboersma mboersma committed on GitHub Merge pull request #491 from mboersma/update-go-compiler
chore(Makefile): update to go-dev 0.17.0
Permalink
Failed to load latest commit information.
action feat(action): add ConfigMap install ordering May 31, 2016
chart feat(action): add ConfigMap install ordering May 31, 2016
cli chore(*): Update comments and help strings for Helm Classic May 6, 2016
codec feat(action): add ConfigMap install ordering May 31, 2016
config chore(*): Update comments and help strings for Helm Classic May 6, 2016
dependency ref(*): Use HELMC_HOME instead of HELM_HOME May 3, 2016
docs docs(generate-and-template): mention the env function May 25, 2016
generator ref(build): Change binary name from helm to helmc May 4, 2016
kubectl feat(kubectl): added Apply func May 12, 2016
log feat(*): exit(1) when log.Err() is called Dec 2, 2015
manifest feat(manifest|action): handle "helm-keep" annotation May 12, 2016
plugins Merge pull request #460 from krancour/change-helm-home May 4, 2016
release chore(*): Update comments and help strings for Helm Classic May 6, 2016
search chore(*): Update comments and help strings for Helm Classic May 6, 2016
test ref(*): Use HELMC_HOME instead of HELM_HOME May 3, 2016
testdata feat(action): add ConfigMap install ordering May 31, 2016
util chore(*): Update comments and help strings for Helm Classic May 6, 2016
validation ref(package names): Change to reflect upcoming repo name change May 2, 2016
.gitignore chore(.gitignore): ignore swp files Dec 3, 2015
.travis.yml fix(.travis.yml): upload to correct bucket Jun 14, 2016
CONTRIBUTING.md doc(*): Update docs for helm-classic May 3, 2016
DCO update LF address Oct 21, 2015
LICENSE initial add Oct 19, 2015
MAINTAINERS.md doc(*): Update docs for helm-classic May 3, 2016
Makefile chore(Makefile): update to go-dev 0.17.0 Aug 19, 2016
README.md doc(README.md): change links to executables to point to the appropria… Jun 16, 2016
glide.lock chore(glide): update k8s requirement to 1.2.4 May 31, 2016
glide.yaml chore(glide): update k8s requirement to 1.2.4 May 31, 2016
helmc.go ref(build): Change binary name from helm to helmc May 4, 2016
mkdocs.yml add basic doc on using additional repositories and update read the do… Mar 9, 2016

README.md

Helm Classic - A Kubernetes Package Manager

Helm Classic (the helm/helm repository) is no longer actively developed but will remain available until kubernetes/helm has stabilized.

Helm and Deployment Manager have recently joined forces to make deploying and managing software on Kubernetes as simple as possible. The combined effort now lives in the Kubernetes GitHub organization at kubernetes/helm.

For more information about the architecture of kubernetes/helm read the architecture documentation.

Overview

Build Status Go Report Card

Helm Classic bootstraps your Kubernetes cluster with Charts that provide ready-to-use workloads like:

  • A Redis cluster
  • A Postgres database
  • An HAProxy edge load balancer

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

Installing Helm Classic

From a Linux or Mac OS X client:

curl -s https://get.helm.sh | bash

or:

Grab a prebuilt binary from the latest release:

Once you've downloaded the appropriate binary for your OS and architecture, ensure that it's executable:

chmod +x helmc

And then put it on your PATH.

Migration Notes

If you are a user of the original Helm tool (versions prior to v0.7.0), take note that Helm Classic is a re-branding of that tool-- new name, same great taste!

Helm Classic is fully compatible with previously existing Helm charts!

Anyone migrating to Helm Classic from an older version should complete the following steps to fully replace their existing tool with Helm Classic. Doing so will clear the path for eventual installation of the new and improved Helm (kubernetes/helm).

First, you may optionally define a custom home directory for use by Helm Classic. If opting for this, the instruction should be added to your shell's profile.

$ HELMC_HOME=/custom/path

Next, we migrate the contents from its old location to its new location (because the default location has changed).

$ mv $(helm home) $(helmc home)

Finally, remove the old version:

$ rm $(which helm)

You may now use the new binary, helmc, just as you previously used helm. Soon, the helm name will be taken over by the new and improved Helm (kubernetes/helm) and you will be able to make use of helmc in parallel with helm for as long as you have that need.

Prerequisite

Helm Classic requires an appropriately wired kubectl client to speak with a running Kubernetes cluster.

Using Helm Classic

To quickly install a redis cluster:

$ helmc update
---> Cloning into '$HOME/.helmc/cache/charts'...
---> Updating cache from https://github.com/helmc/charts
---> Done
$ helmc search redis
--->    redis-cluster (redis-cluster 0.0.5) - Highly available Redis cluster with multiple sentinels and standbys.
--->    redis-standalone (redis-standalone 0.0.1) - Standalone Redis Master
$ helmc info redis-cluster
Name: redis-cluster
Home: http://github.com/deis/redis-cluster
Version: 0.0.5
Description: Highly available Redis cluster with multiple sentinels and standbys.
Details: This package provides a highly available Redis cluster with multiple sentinels and standbys. Note the `redis-master` pod is used for bootstrapping only and can be deleted once the cluster is up and running.
$ helmc install redis-cluster
---> No chart named "redis-cluster" in your workspace. Fetching now.
---> Fetched chart into workspace $HOME/.helmc/workspace/charts/redis-cluster
---> Running `kubectl create -f` ...
services/redis-sentinel
pods/redis-master
replicationcontrollers/redis
replicationcontrollers/redis-sentinel
---> Done

To fetch, modify and install a chart out of your local workspace:

$ helmc update
---> Updating cache from https://github.com/helm/charts
---> Done
$ helmc fetch redis-standalone redis
---> Fetched chart into workspace $HOME/.helmc/workspace/charts/redis
---> Done
$ helmc edit redis
$ helmc install redis
---> Running `kubectl create -f` ...
replicationcontrollers/redis-standalone
---> Done

Building the Helm Classic CLI

  • Make sure you have a kubectl client installed and configured to speak with a running Kubernetes cluster.
  • Helm Classic utilizes a containerized build and test process. Making use of the containerized development environment only requires make and a local Docker daemon or docker-machine.
git clone https://github.com/helm/helm-classic.git

cd helm-classic

make bootstrap # installs all of helm classic's dependencies

make build # generates bin/helmc binary

./bin/helmc # prints usage

# optional

make install # installs helmc system-wide

helmc # prints usage

License

See LICENSE