helm
/
helm
mirror of https://github.com/helm/helm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Kubernetes Package Manager
1,280 Commits 60 Branches 225 Tags 143 MiB
Go 98.5%
Shell 1.1%
Makefile 0.4%
Go to file
Matt Butcher 87429c66e9 Merge pull request #755 from technosophos/fix/chart-any 
fix(proto): let chart take multiple Files.
 		2016-05-23 10:24:01 -06:00
_proto fix(proto): let chart take multiple Files. 2016-05-20 18:11:44 -06:00
cmd Merge pull request #745 from michelleN/repo-index 2016-05-20 16:26:37 -04:00
docs Update quickstart.md 2016-05-19 12:21:02 +02:00
pkg Merge pull request #755 from technosophos/fix/chart-any 2016-05-23 10:24:01 -06:00
rootfs feat(Makefile): add a placeholder Dockerfile 2016-04-13 14:42:20 -07:00
scripts fix(local-cluster): fix missing namespace issue 2016-05-05 00:43:42 -07:00
.gitignore fix(.gitignore): remove old helm cross build 2016-05-06 12:03:50 -07:00
CONTRIBUTING.md docs(README): udate core docs pre-merge 2016-04-27 14:40:40 -06:00
LICENSE docs(README): udate core docs pre-merge 2016-04-27 14:40:40 -06:00
Makefile fix(make): add protoc target to top Makefile 2016-05-10 12:24:32 -06:00
README.md Fix bootstrap instructions 2016-05-08 09:45:09 -05:00
circle.yml fix(circleci): fix working directory 2016-04-27 22:05:59 -06:00
glide.lock fix(glide): use https instead of git protocol 2016-05-19 16:14:49 -06:00
glide.yaml fix(glide): use https instead of git protocol 2016-05-19 16:14:49 -06:00
versioning.mk ref(Makefile): add default registry + "/"s 2016-04-14 14:38:00 -06:00

README.md

Kubernetes Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

Features:

  • Helm now has both a client (helm) and a server (tiller). The server runs inside of Kubernetes, and manages your resources.
  • Helm's chart format has changed for the better:
    • Dependencies are immutable and stored inside of a chart's charts/ directory.
    • Charts are strongly versioned using SemVer 2
    • Charts can be loaded from directories or from chart archive files
    • Helm supports Go templates without requiring you to run generate or template commands.
    • Helm makes it easy to configure your releases -- and share the configuration with the rest of your team.
  • Helm chart repositories now use plain HTTP instead of Git/GitHub. There is no longer any GitHub dependency.
    • A chart server is a simple HTTP server
    • Charts are referenced by version
    • The helm serve command will run a local chart server, though you can easily use object storage (S3, GCS) or a regular web server.
    • And you can still load charts from a local directory.
  • The Helm workspace is gone. You can now work anywhere on your filesystem that you want to work.

Install

Helm is in its early stages of development. At this time there are no releases.

To install Helm from source, follow this process:

Make sure you have the prerequisites:

  • Go 1.6
  • A running Kubernetes cluster
  • kubectl properly configured to talk to your cluster
  • Glide 0.10 or greater with both git and mercurial installed.
  1. Properly set your $GOPATH
  2. Clone (or otherwise download) this repository into $GOPATH/src/github.com/kubernetes/helm
  3. Run make bootstrap build

You will now have two binaries built:

  • bin/helm is the client
  • bin/tiller is the server

You can locally run Tiller, or you build a Docker image (make docker-build) and then deploy it (helm init -i IMAGE_NAME).

The documentation folder contains more information about the architecture and usage of Helm/Tiller.

The History of the Project

Kubernetes Helm is the merged result of Helm Classic and the Kubernetes port of GCS Deployment Manager. The project was jointly started by Google and Deis, though it is now part of the CNCF.