From ae99bb1972427977abc45780a8a5e633afa94307 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Thu, 24 Oct 2019 11:43:31 -0700 Subject: [PATCH] Say that Helm v2.15+ is required for K8s v1.16 Update note about required Helm version Update Helm version info Update note about Helm version requirements Update Helm version info Say to refer to the default Kubernetes version for your RKE version Minor edit to installation doc Edit installation docs Edit Helm version requirements Update language about Helm chart --- .../v2.x/en/installation/air-gap/_index.md | 2 +- .../air-gap/install-rancher/_index.md | 2 +- .../rancher/v2.x/en/installation/ha/_index.md | 5 +---- .../en/installation/ha/helm-init/_index.md | 5 +++-- .../en/installation/ha/helm-rancher/_index.md | 4 +++- .../en/installation/helm-version/_index.md | 10 ++++++++++ .../v2.x/en/installation/server-tags/_index.md | 18 +++++++++++------- 7 files changed, 30 insertions(+), 16 deletions(-) create mode 100644 content/rancher/v2.x/en/installation/helm-version/_index.md diff --git a/content/rancher/v2.x/en/installation/air-gap/_index.md b/content/rancher/v2.x/en/installation/air-gap/_index.md index 61628b4a872..e4b72412447 100644 --- a/content/rancher/v2.x/en/installation/air-gap/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap/_index.md @@ -24,7 +24,7 @@ The following CLI tools are required for the HA install. Make sure these tools a * [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. * [rke]({{< baseurl >}}/rke/latest/en/installation/) - Rancher Kubernetes Engine, cli for building Kubernetes clusters. -* [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. +* [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. {{% /tab %}} {{% /tabs %}} diff --git a/content/rancher/v2.x/en/installation/air-gap/install-rancher/_index.md b/content/rancher/v2.x/en/installation/air-gap/install-rancher/_index.md index 4907b879ba7..b395b88fcc3 100644 --- a/content/rancher/v2.x/en/installation/air-gap/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap/install-rancher/_index.md @@ -28,7 +28,7 @@ This section describes installing Rancher in five parts: From a system that has access to the internet, fetch the latest Helm chart and copy the resulting manifests to a system that has access to the Rancher server cluster. -1. If you haven't already, initialize `helm` locally on a workstation that has internet access. +1. If you haven't already, initialize `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. ```plain helm init -c diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index 9fb2256d89c..5c720e2373d 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -28,10 +28,7 @@ The following CLI tools are required for this install. Please make sure these to * [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. * [rke]({{< baseurl >}}/rke/latest/en/installation/) - Rancher Kubernetes Engine, cli for building Kubernetes clusters. -* [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. - -> **Known issues:** -> Do not use Helm v2.15.0 (issue with converting/comparing numbers) +* [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. ## Installation Outline diff --git a/content/rancher/v2.x/en/installation/ha/helm-init/_index.md b/content/rancher/v2.x/en/installation/ha/helm-init/_index.md index 3dc99fdcd48..4eb518162ab 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-init/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-init/_index.md @@ -3,10 +3,11 @@ title: "3. Initialize Helm (Install Tiller)" weight: 195 --- - Helm is the package management tool of choice for Kubernetes. Helm "charts" provide templating syntax for Kubernetes YAML manifest documents. With Helm we can create configurable deployments instead of just using static files. For more information about creating your own catalog of deployments, check out the docs at [https://helm.sh/](https://helm.sh/). To be able to use Helm, the server-side component `tiller` needs to be installed on your cluster. -> **Note:** For systems without direct internet access see [Helm - Air Gap]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#helm) for install details. +For systems without direct internet access, see [Helm - Air Gap]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#helm) for install details. + +Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. ### Install Tiller on the Cluster diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md index 246f58ba88c..23eb02a9cf9 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md @@ -5,7 +5,9 @@ weight: 200 Rancher installation is managed using the Helm package manager for Kubernetes. Use `helm` to install the prerequisite and charts to install Rancher. -> **Note:** For systems without direct internet access see [Air Gap: High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/). +For systems without direct internet access, see [Air Gap: High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/). + +Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. ### Add the Helm Chart Repository diff --git a/content/rancher/v2.x/en/installation/helm-version/_index.md b/content/rancher/v2.x/en/installation/helm-version/_index.md new file mode 100644 index 00000000000..175fe9cbb78 --- /dev/null +++ b/content/rancher/v2.x/en/installation/helm-version/_index.md @@ -0,0 +1,10 @@ +--- +title: Helm Version Requirements +weight: 400 +--- + +This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster. + +- Helm v2.15.1 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using. +- Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers. +- Helm v2.12.0 should not be used, because of an issue with `cert-manager`. \ No newline at end of file diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index 2b5a412831a..0bce71fe02f 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -1,9 +1,15 @@ --- -title: Choosing a Version +title: Choosing a Rancher Version weight: 230 --- -## Single Node Installs +This section describes how to choose a Rancher version. + +For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a Helm chart on a Kubernetes cluster. Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. + +For single node installations of Rancher, which is used for development and testing, you will install Rancher as a Docker image. + +# Single Node Installs When performing [single-node installs]({{< baseurl >}}/rancher/v2.x/en/installation/single-node), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. @@ -17,9 +23,6 @@ Tag | Description `rancher/rancher:stable` | Our newest stable release. This tag is recommended for production. `rancher/rancher:` | You can install specific versions of Rancher by using the tag from a previous release. See what's available at DockerHub. - - - >**Notes:** > >- The `master` tag or any tag with `-rc` or another suffix is meant for the Rancher testing team to validate. You should not use these tags, as these builds are not officially supported. @@ -27,11 +30,12 @@ Tag | Description > > _Caveat:_ Alpha releases cannot be upgraded to or from any other release. - -## High Availability Installs +# High Availability Installs When installing, upgrading, or rolling back Rancher Server in a [high availability configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher. +Refer to the [Helm version requirements]({{}}/rancher/v2.x/en/installation/helm-version) to choose a version of Helm to install Rancher. + ### Helm Chart Repositories Rancher provides several different Helm chart repositories to choose from. We align our latest and stable Helm chart repositories with the Docker tags that are used for a single node installation. Therefore, the `rancher-latest` repository will contain charts for all the Rancher versions that have been tagged as `rancher/rancher:latest`. When a Rancher version has been promoted to the `rancher/rancher:stable`, it will get added to the `rancher-stable` repository.