From e52dbc2c2b31f3d095dddae67e6a2421df88484a Mon Sep 17 00:00:00 2001 From: Matt Farina Date: Thu, 2 Jul 2020 12:47:48 -0400 Subject: [PATCH] Updating the install instructions This mirrors the change already merged into v3 at https://github.com/helm/helm-www/pull/713 Signed-off-by: Matt Farina --- docs/install.md | 65 +++++++++++++++++++++++++++++++------------------ 1 file changed, 41 insertions(+), 24 deletions(-) diff --git a/docs/install.md b/docs/install.md index 35c4d6146..6b141d0f2 100755 --- a/docs/install.md +++ b/docs/install.md @@ -11,7 +11,14 @@ proceeds to show two ways to install the server. The Helm client can be installed either from source, or from pre-built binary releases. -### From the Binary Releases +### From The Helm Project + +The Helm project provides two ways to fetch and install Helm. These are the +official methods to get Helm releases. In addition to that, the Helm community +provides methods to install Helm through different package managers. Installation +through those methods can be found below the official methods. + +#### From the Binary Releases Every [release](https://github.com/helm/helm/releases) of Helm provides binary releases for a variety of OSes. These binary versions @@ -24,7 +31,29 @@ can be manually downloaded and installed. From there, you should be able to run the client: `helm help`. -### From Snap (Linux) +#### From Script + +Helm now has an installer script that will automatically grab the latest version +of the Helm client and [install it locally](https://git.io/get_helm.sh). + +You can fetch that script, and then execute it locally. It's well documented so +that you can read through it and understand what it is doing before you run it. + +``` +$ curl -LO https://git.io/get_helm.sh +$ chmod 700 get_helm.sh +$ ./get_helm.sh +``` + +Yes, you can `curl -L https://git.io/get_helm.sh | bash` that if you want to live on the edge. + +### Through Package Managers + +The Helm community provides the ability to install Helm through operating system +package managers. These are not supported by the Helm project and are not considered +trusted 3rd parties. + +#### From Snap (Linux) The Snap package for Helm is maintained by [Snapcrafters](https://github.com/snapcrafters/helm). @@ -33,9 +62,9 @@ The Snap package for Helm is maintained by sudo snap install helm --classic ``` -### From Homebrew (macOS) +#### From Homebrew (macOS) -Members of the Kubernetes community have contributed a Helm formula build to +Members of the Helm community have contributed a Helm formula build to Homebrew. This formula is generally up to date. ``` @@ -45,9 +74,9 @@ brew install kubernetes-helm (Note: There is also a formula for emacs-helm, which is a different project.) -### From Chocolatey or scoop (Windows) +### #From Chocolatey or scoop (Windows) -Members of the Kubernetes community have contributed a [Helm package](https://chocolatey.org/packages/kubernetes-helm) build to +Members of the Helm community have contributed a [Helm package](https://chocolatey.org/packages/kubernetes-helm) build to [Chocolatey](https://chocolatey.org/). This package is generally up to date. ``` @@ -60,9 +89,9 @@ The binary can also be installed via [`scoop`](https://scoop.sh) command-line in scoop install helm ``` -### From Apt (Debian/Ubuntu) +#### From Apt (Debian/Ubuntu) -Members of the Kubernetes community have contributed a [Helm +Members of the Helm community have contributed a [Helm package](https://helm.baltorepo.com/stable/debian/) for Apt. This package is generally up to date. ``` @@ -73,23 +102,11 @@ sudo apt-get update sudo apt-get install helm2 ``` -### From Script - -Helm now has an installer script that will automatically grab the latest version -of the Helm client and [install it locally](https://git.io/get_helm.sh). - -You can fetch that script, and then execute it locally. It's well documented so -that you can read through it and understand what it is doing before you run it. - -``` -$ curl -LO https://git.io/get_helm.sh -$ chmod 700 get_helm.sh -$ ./get_helm.sh -``` +### Development Builds -Yes, you can `curl -L https://git.io/get_helm.sh | bash` that if you want to live on the edge. +In addition to releases you can download or install development snapshots of Helm. -### From Canary Builds +#### 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 @@ -103,7 +120,7 @@ Here are links to the common builds: - [macOS AMD64](https://get.helm.sh/helm-canary-darwin-amd64.tar.gz) - [Experimental Windows AMD64](https://get.helm.sh/helm-canary-windows-amd64.zip) -### From Source (Linux, macOS) +#### From Source (Linux, macOS) Building Helm from source is slightly more work, but is the best way to go if you want to test the latest (pre-release) Helm version.