From 6691b79f306b96a4a949865c75f3944404db9827 Mon Sep 17 00:00:00 2001 From: Matt Butcher Date: Tue, 4 Oct 2016 15:48:08 -0600 Subject: [PATCH] docs(install): Add information on using canary releases This includes documentation on how to use Helm and Tiller canary releases. --- README.md | 3 +++ docs/install.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/README.md b/README.md index c03676282..6c624d098 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,9 @@ Think of it like apt/yum/homebrew for Kubernetes. Download a [release tarball of helm for your platform](https://github.com/kubernetes/helm/releases). Unpack the `helm` binary and add it to your PATH and you are good to go! OS X/[Cask](https://caskroom.github.io/) users can `brew cask install helm`. +See the [installation guide](docs/install.md) for more options, +including installing pre-releases. + ## Docs - [Quick Start](docs/quickstart.md) diff --git a/docs/install.md b/docs/install.md index 1a4578a9c..43b67c1fc 100644 --- a/docs/install.md +++ b/docs/install.md @@ -34,6 +34,20 @@ brew cask install helm (Note: There is also a formula for emacs-helm, which is a different project.) +### From Canary Builds + +"Canary" builds are versions of the Helm software that are built from +the latest master branch. They are not official releases, and may not be +stable. However, they offer the opportunity to test the cutting edge +features. + +Canary Helm binaries are stored in the [Kubernetes Helm GCS bucket](http://storage.googleapis.com/kubernetes-helm). +Here are links to the common builds: + +- [Linux AMD64](http://storage.googleapis.com/kubernetes-helm/helm-canary-linux-amd64.tar.gz) +- [OSX AMD64](http://storage.googleapis.com/kubernetes-helm/helm-canary-darwin-amd64.tar.gz) +- [Experimental Windows AMD64](http://storage.googleapis.com/kubernetes-helm/helm-canary-windows-amd64.zip) + ### From Source (Linux, Mac OSX) Building Helm from source is slightly more work, but is the best way to @@ -79,6 +93,22 @@ the client and server version. (If it shows only the client version, `helm` cannot yet connect to the server. Use `kubectl` to see if any `tiller` pods are running.) +### Installing Tiller Canary Builds + +Canary images are built from the `master` branch. They may not be +stable, but they offer you the chance to test out the latest features. + +The easiest way to install a canary image is to use `helm init` with the +`--tiller-image` flag: + +```console +$ helm init -i "gcr.io/kubernetes-helm/tiller:canary" +``` + +This will use the most recently built container image. You can always +uninstall Tiller by deleting the Tiller deployment from the +`kube-system` namespace using `kubectl`. + ### Running Tiller Locally For development, it is sometimes easier to work on Tiller locally, and