msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity
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.
1427 Commits
64 Branches
208 Tags
91 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5e63b5e925'
${ noResults }
Go to file
Matt Butcher 5e63b5e925
docs(examples): unify the examples 		9 years ago
_proto Merge pull request #833 from migmartri/689-linter-errors 9 years ago
cmd feat(tiller): record release status deployed 9 years ago
docs docs(examples): unify the examples 9 years ago
pkg Merge pull request #863 from adamreese/fix/686-tunnel-error 9 years ago
rootfs feat(Makefile): add a placeholder Dockerfile 9 years ago
scripts feat(scripts): add script to sync repo 9 years ago
.gitignore fix(gitignore): die, DS_Store, die. 9 years ago
CONTRIBUTING.md docs(developer): update developer documentation 9 years ago
LICENSE docs(README): udate core docs pre-merge 9 years ago
Makefile fix(proto): keep a local protoc Go plugin 9 years ago
README.md chore(*): use k8s.io as the import path 9 years ago
circle.yml fix(ci): use gcloud absolute path 9 years ago
glide.lock Merge pull request #833 from migmartri/689-linter-errors 9 years ago
glide.yaml Merge pull request #833 from migmartri/689-linter-errors 9 years ago
versioning.mk chore(*): use k8s.io as the import path 9 years ago

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/k8s.io/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.