From 8869ee3df453c9d899673b14e8506047ee315dcd Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 31 Mar 2021 18:57:20 -0700 Subject: [PATCH] Edit docs for Rancher install on EKS --- .../install-rancher-on-k8s/_index.md | 42 +++++++------------ .../install-rancher-on-k8s/_index.md | 6 +-- 2 files changed, 18 insertions(+), 30 deletions(-) diff --git a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md index 0296ec0e736..5cecd22fac8 100644 --- a/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md +++ b/content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md @@ -38,10 +38,8 @@ For help setting up a Kubernetes cluster, we provide these tutorials: The following CLI tools are required for setting up the Kubernetes cluster. Please make sure these tools are installed and available in your `$PATH`. -Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. - - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. -- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. +- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. ### Ingress Controller (For Hosted Kubernetes) @@ -65,25 +63,15 @@ To choose a version of Helm to install Rancher with, refer to the [Helm version To set up Rancher, -1. [Install the required CLI tools](#1-install-the-required-cli-tools) -2. [Add the Helm chart repository](#2-add-the-helm-chart-repository) -3. [Create a namespace for Rancher](#3-create-a-namespace-for-rancher) -4. [Choose your SSL configuration](#4-choose-your-ssl-configuration) -5. [Install cert-manager](#5-install-cert-manager) (unless you are bringing your own certificates, or TLS will be terminated on a load balancer) -6. [Install Rancher with Helm and your chosen certificate option](#6-install-rancher-with-helm-and-your-chosen-certificate-option) -7. [Verify that the Rancher server is successfully deployed](#7-verify-that-the-rancher-server-is-successfully-deployed) -8. [Save your options](#8-save-your-options) +1. [Add the Helm chart repository](#1-add-the-helm-chart-repository) +2. [Create a namespace for Rancher](#2-create-a-namespace-for-rancher) +3. [Choose your SSL configuration](#3-choose-your-ssl-configuration) +4. [Install cert-manager](#4-install-cert-manager) (unless you are bringing your own certificates, or TLS will be terminated on a load balancer) +5. [Install Rancher with Helm and your chosen certificate option](#5-install-rancher-with-helm-and-your-chosen-certificate-option) +6. [Verify that the Rancher server is successfully deployed](#6-verify-that-the-rancher-server-is-successfully-deployed) +7. [Save your options](#7-save-your-options) -### 1. Install the Required CLI Tools - -The following CLI tools are required for setting up the Kubernetes cluster. Please make sure these tools are installed and available in your `$PATH`. - -Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. - -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. -- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. - -### 2. Add the Helm Chart Repository +### 1. Add the Helm Chart Repository Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). @@ -93,7 +81,7 @@ Use `helm repo add` command to add the Helm chart repository that contains chart helm repo add rancher- https://releases.rancher.com/server-charts/ ``` -### 3. Create a Namespace for Rancher +### 2. Create a Namespace for Rancher We'll need to define a Kubernetes namespace where the resources created by the Chart should be installed. This should always be `cattle-system`: @@ -101,7 +89,7 @@ We'll need to define a Kubernetes namespace where the resources created by the C kubectl create namespace cattle-system ``` -### 4. Choose your SSL Configuration +### 3. Choose your SSL Configuration The Rancher management server is designed to be secure by default and requires SSL/TLS configuration. @@ -120,7 +108,7 @@ There are three recommended options for the source of the certificate used for T | Let’s Encrypt | `ingress.tls.source=letsEncrypt` | [yes](#5-install-cert-manager) | | Certificates from Files | `ingress.tls.source=secret` | no | -### 5. Install cert-manager +### 4. Install cert-manager > You should skip this step if you are bringing your own certificate files (option `ingress.tls.source=secret`), or if you use [TLS termination on an external load balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). @@ -175,7 +163,7 @@ cert-manager-webhook-787858fcdb-nlzsq 1/1 Running 0 2m {{% /accordion %}} -### 6. Install Rancher with Helm and Your Chosen Certificate Option +### 5. Install Rancher with Helm and Your Chosen Certificate Option The exact command to install Rancher differs depending on the certificate configuration. @@ -277,7 +265,7 @@ The Rancher chart configuration has many options for customizing the installatio See the [Chart Options]({{}}/rancher/v2.5/en/installation/resources/chart-options/) for the full list of options. -### 7. Verify that the Rancher Server is Successfully Deployed +### 6. Verify that the Rancher Server is Successfully Deployed After adding the secrets, check if Rancher was rolled out successfully: @@ -297,7 +285,7 @@ rancher 3 3 3 3 3m It should show the same count for `DESIRED` and `AVAILABLE`. -### 8. Save Your Options +### 7. Save Your Options Make sure you save the `--set` options you used. You will need to use the same options when you upgrade Rancher to new versions with Helm. diff --git a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md index 1baaeb469f9..849a4aef754 100644 --- a/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md +++ b/content/rancher/v2.x/en/installation/install-rancher-on-k8s/_index.md @@ -17,7 +17,7 @@ In this section, you'll learn how to deploy Rancher on a Kubernetes cluster usin # Prerequisites -- [A Kubernetes Cluster](#kubernetes-cluster) +- [Kubernetes Cluster](#kubernetes-cluster) - [CLI Tools](#cli-tools) - [Ingress Controller (Only for Hosted Kubernetes)](#ingress-controller-for-hosted-kubernetes) @@ -38,7 +38,7 @@ For help setting up a Kubernetes cluster, we provide these tutorials: - **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.x/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) - **Amazon EKS:** To install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.x/en/installation/install-rancher-on-k8s/amazon-eks) -### Required CLI Tools +### CLI Tools The following CLI tools are required for setting up the Kubernetes cluster. Please make sure these tools are installed and available in your `$PATH`. @@ -47,7 +47,7 @@ The following CLI tools are required for setting up the Kubernetes cluster. Plea ### Ingress Controller (for Hosted Kubernetes) -To deploy Rancher v2.5+ on a hosted Kubernetes cluster such as EKS, GKE, or AKS, you should deploy a compatible Ingress controller first to configure [SSL termination on Rancher.]({{}}/rancher/v2.x/en/installation/install-rancher-on-k8s/#4-choose-your-ssl-configuration) +To deploy Rancher v2.5+ on a hosted Kubernetes cluster such as EKS, GKE, or AKS, you should deploy a compatible Ingress controller first to configure [SSL termination on Rancher.](#3-choose-your-ssl-configuration) For more information about deploying Rancher on EKS, refer to [this page.]({{}}/rancher/v2.x/en/installation/install-rancher-on-k8s/amazon-eks)