diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index 0f6ab3746fc..ea8072ec8b3 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -4,11 +4,11 @@ weight: 275 draft: true --- -When installed as a Deployment in a Kubernetes cluster, Rancher will take integrate with the cluster's etcd database and Kubernetes scheduling for High-Availability. +When installed in a Kubernetes cluster, Rancher will integrate with the cluster's etcd database and take advantage of Kubernetes scheduling for High-Availability. This procedure walks you through setting up a 3-node cluster with RKE and installing the Rancher chart with the Helm package manager. -> NOTE: For the best performance, we recommend this Kubernetes cluster is dedicated to only the Rancher workload. +> **Note:** For the best performance, we recommend this Kubernetes cluster be dedicated only to the Rancher workload. ## Recommended Architecture @@ -21,7 +21,7 @@ This procedure walks you through setting up a 3-node cluster with RKE and instal ## Required Tools -The following CLI tools are required for this install. Please make sure these tools installed and available in your `$PATH` +The following CLI tools are required for this install. Please make sure these tools are installed and available in your `$PATH` * [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. * [rke]({{< baseurl >}}/rke/v0.1.x/en/installation/) - Rancher Kubernetes Engine, cli for building Kubernetes clusters. diff --git a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md index 60f1135c858..69d37b8220b 100644 --- a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md @@ -5,9 +5,9 @@ weight: 185 Use your provider of choice to provision 3 nodes and a Load Balancer endpoint for your RKE install. -> Note: These nodes must be in the same region/datacenter. You may place these servers in separate availability zones. +> **Note:** These nodes must be in the same region/datacenter. You may place these servers in separate availability zones. -Collect the SSH credentials and DNS or IP addresses for your nodes to provide to RKE in the next step. +**Don't forget to collect the SSH credentials and DNS or IP addresses of your nodes to provide to RKE in the next step.** ### Host Requirements @@ -35,9 +35,9 @@ If you block ports internally on the nodes see the full [ports list]({{< baseurl ### Load Balancer -RKE will configure an ingress-controller pod, on each of your nodes. The ingress-controller pods are bound to ports 80 and 443 tcp on the host network and are the entry point for https traffic to the Rancher server. +RKE will configure an ingress-controller pod, on each of your nodes. The ingress-controller pods are bound to ports 80 and 443 TCP on the host network and are the entry point for HTTPS traffic to the Rancher server. -Configure a load balancer as a basic Layer 4 tcp forwarder. The exact configuration will vary depending on your environment. +Configure a load balancer as a basic Layer 4 TCP forwarder. The exact configuration will vary depending on your environment. #### Examples 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 c28458fa89c..8bf567a9d86 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,11 +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/) +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/). -### Initialize Helm on your Cluster +### Initialize Helm on the cluster -`helm` installs the `tiller` service on your cluster to manage `chart` deployments. Since `rke` has RBAC enabled by default we will need to use `kubectl` to create a `serviceaccount` and `clusterrolebinding` so `tiller` can deploy to our cluster for us. +Helm installs the `tiller` service on your cluster to manage charts. Since RKE enables RBAC by default we will need to use `kubectl` to create a `serviceaccount` and `clusterrolebinding` so `tiller` has permission to deploy to the cluster. * Create the `ServiceAccount` in the `kube-system` namespace. * Create the `ClusterRoleBinding` to give the `tiller` account access to the cluster. @@ -21,7 +21,7 @@ kubectl create clusterrolebinding tiller --clusterrole cluster-admin --serviceac
Additional steps for Air Gap/Private Registry

-If you have an Air Gapped network you will need the tiller image available in your private registry. +If you have an Air Gapped network you will need the `tiller` image available in your private registry. ##### Create registry secret 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 0428fc02681..4070ead937c 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 @@ -15,6 +15,8 @@ helm repo add rancher-stable https://releases.rancher.com/server-charts/stable ### Install cert-manager +> **Note:** cert-manager is only required for Rancher generated and LetsEncrypt issued certificates. You may skip this step if you are bringing your own certificates and using the `ingress.tls.source=secret` option. + Rancher relies on [cert-manager](https://github.com/kubernetes/charts/tree/master/stable/cert-manager) from the Kubernetes Helm "stable" catalog to issue self-signed or LetsEncrypt certificates. Install `cert-manager` from the Helm stable catalog. @@ -37,7 +39,7 @@ There are three options for the source of the certificate. #### (Default) Rancher Generated Certificates -The default is to use the Rancher to generate a CA and use the `cert-manager` to issue the certificate for access to the Rancher server interface. +The default is for Rancher to generate a CA and use the `cert-manager` to issue the certificate for access to the Rancher server interface. The only requirement is to set the `hostname` to the DNS name you pointed at your Load Balancer. @@ -89,6 +91,10 @@ The Rancher chart configuration has many options for customizing the install to See the [Chart Options](chart-options/) for the full list of options. +### 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. + ### Finishing Up That's it you should have a functional Rancher server. Point a browser at the hostname you picked and you should be greeted by the colorful login page. diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md index 5fdb8813b04..0cc9df9bee8 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md @@ -32,17 +32,25 @@ weight: 276 ### HTTP Proxy -Rancher requires internet access for some functionality (helm charts). Set proxy to your proxy server. Add your domain name or ip exceptions to the noProxy list. Make sure your worker cluster `controlplane` nodes are included in this list. +Rancher requires internet access for some functionality (helm charts). Use `proxy` to set your proxy server. + +Add your IP exceptions to the `noProxy` list. Make sure you add the Service cluster IP range (default: 10.43.0.1/16) and any worker cluster `controlplane` nodes. Rancher supports CIDR notation ranges in this list. ``` --set proxy="http://:@:/" ---set noProxy="127.0.0.1,localhost,myinternaldomain.example.com" +--set noProxy="127.0.0.1,localhost,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" ``` ### Private or Air Gap Registry You can point to a private registry for an "Air Gap" install. +#### Images + +Populate your private registry with Rancher images. + +You can get the list of images required for rancher and worker cluster installs from the [Releases](https://github.com/rancher/rancher/releases/latest) page. + #### Create Registry Secret Use `kubectl` to create a docker-registry secret in the `cattle-system` namespace. @@ -66,7 +74,7 @@ Add the `rancherImage` to point to your private registry image and `imagePullSec ### External TLS Termination -If you wish to terminate the SSL/TLS on a load-balancer external to the Rancher cluster (ingress), use the `--tls=external` option and point your load balancer at port http 80. +If you wish to terminate the SSL/TLS on a load-balancer external to the Rancher cluster (ingress), use the `--tls=external` option and point your load balancer at port http 80 on all of the rancher cluster nodes. > NOTE: If you are using a Private CA signed cert, add `--set privateCA=true` and see [Adding TLS Secrets - Private CA Signed - Additional Steps](../tls-secrets/#private-ca-signed---additional-steps) to add the CA cert for Rancher. diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/tls-secrets/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/tls-secrets/_index.md index 50f2a4dff57..b77e4e1e9ba 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/tls-secrets/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/tls-secrets/_index.md @@ -7,7 +7,7 @@ Kubernetes will create all the objects and services for Rancher, but it will not Combine the server certificate followed by the intermediate cert chain your CA provided into a file named `tls.crt`. Copy your key into a file name `tls.key`. -Use `kubectl` with the `tls` type to create the secrets. +Use `kubectl` with the `tls` secret type to create the secrets. ``` kubectl -n cattle-system create secret tls tls-rancher-ingress \ diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/troubleshooting/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/troubleshooting/_index.md index 2fce8e8d444..fd12a12e04f 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/troubleshooting/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/troubleshooting/_index.md @@ -5,7 +5,7 @@ weight: 276 ### Where is everything -Most of the troubleshooting will be done on Objects in these 3 namespaces. +Most of the troubleshooting will be done on objects in these 3 namespaces. * `cattle-system` - `rancher` deployment and pods. * `ingress-nginx` - Ingress controller pods and services. diff --git a/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md b/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md index 61c1f212969..fffac4ad1ba 100644 --- a/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md +++ b/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md @@ -3,11 +3,11 @@ title: 2 - Install Kubernetes with RKE weight: 190 --- -Configure the RKE `rancher-cluster.yml` and run `rke` to install Kubernetes with a HA `etcd` install. +Use RKE to install Kubernetes with a high-availability etcd configuration. -### Create a `rancher-cluster.yml` File +### Create the rancher-cluster.yml file -Using the sample below create a `rancher-cluster.yml` file. Replace the IP Addresses in the `nodes` list with the IP address or DNS names of the 3 Nodes you created. +Using the sample below create the `rancher-cluster.yml` file. Replace the IP Addresses in the `nodes` list with the IP address or DNS names of the 3 Nodes you created. ```yaml nodes: @@ -20,11 +20,9 @@ nodes: - address: 165.227.127.226 user: ubuntu role: [controlplane,worker,etcd] - # internal_address: 10.10.0.1 - # ssh_key_path: /home/user/.ssh/id_rsa ``` -#### Common RKE Options +#### Common RKE nodes: options | Option | Description | | --- | --- | @@ -36,11 +34,10 @@ nodes:
-#### Advanced Configurations +#### Advanced configurations RKE has many configuration options for customizing the install to suit your specific environment. Here are some common advanced scenarios. -* [SSH Bastion/Jump Server]({{< baseurl >}}/rke/v0.1.x/en/config-options/bastion-host/) * [System Images for Air Gap Network]({{< baseurl >}}/rke/v0.1.x/en/config-options/system-images/) * [Private Docker Image Registry]({{< baseurl >}}/rke/v0.1.x/en/config-options/private-registries/) @@ -54,9 +51,9 @@ rke up --config ./rancher-cluster.yaml ### Testing your cluster -`rke` should have created a file `kube_config_rancher-cluster.yml`. This file has the credentials for `kubectl` and `helm`. +RKE should have created a file `kube_config_rancher-cluster.yml`. This file has the credentials for `kubectl` and `helm`. -You can copy this file to `$HOME/.kube/config` or if you are working with multiple Kubernetes clusters, set`KUBECONFIG` environmental variable to the path of `kube_config_rancher-cluster.yml`. +You can copy this file to `$HOME/.kube/config` or if you are working with multiple Kubernetes clusters, set the `KUBECONFIG` environmental variable to the path of `kube_config_rancher-cluster.yml`. ``` export KUBECONFIG=$(pwd)/kube_config_rancher-cluster.yml @@ -75,7 +72,7 @@ NAME STATUS ROLES AGE VER ### Save your files -You will need to save a copy of the `kube_config_rancher-cluster.yml` and `rancher-cluster.yml` files. You will need these files to maintain and upgrade your Rancher instance. +Save a copy of the `kube_config_rancher-cluster.yml` and `rancher-cluster.yml` files. You will need these files to maintain and upgrade your Rancher instance. ### Issues or errors? diff --git a/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md b/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md index b6b750a1dbb..ec8d135ccbf 100644 --- a/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md +++ b/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md @@ -7,7 +7,7 @@ The following instructions will help guide you through migrating from the RKE Al You will need the to have [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) installed and `kube_config_rancher-cluster.yml` credentials file generated by RKE. -> NOTE: This guide assumes a standard Rancher install. If you have modified any of the object names or namespaces, please adjust accordingly. +> **Note:** This guide assumes a standard Rancher install. If you have modified any of the object names or namespaces, please adjust accordingly. ### Point kubectl at your Rancher Cluster @@ -38,7 +38,7 @@ kubectl -n cattle-system get secret cattle-keys-server -o jsonpath --template='{ Remove the kubernetes objects created by the RKE install. -> NOTE: Removing these Kubernetes components will not affect the Rancher configuration or database, but with any maintenance it is a good idea to create a backup of the data before hand. See [Creating Backups-HA Install]({{< baseurl >}}/rancher/v2.x/en/backups/backups/ha-backups) for details. +> **Note:** Removing these Kubernetes components will not affect the Rancher configuration or database, but with any maintenance it is a good idea to create a backup of the data before hand. See [Creating Backups-HA Install]({{< baseurl >}}/rancher/v2.x/en/backups/backups/ha-backups) for details. ``` kubectl -n cattle-system delete ingress cattle-ingress-http