From 2caa94285c97bd4b75812472e9faf24cb40ff727 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Thu, 30 Aug 2018 16:50:00 -0700 Subject: [PATCH] adding better contextual lead-ins for install procedures --- content/rancher/v2.x/en/installation/_index.md | 8 ++++++-- content/rancher/v2.x/en/installation/ha/_index.md | 6 +++--- .../en/installation/ha/rke-add-on/layer-4-lb/_index.md | 4 +++- .../en/installation/ha/rke-add-on/layer-7-lb/_index.md | 4 +++- .../rancher/v2.x/en/installation/single-node/_index.md | 2 +- .../single-node/single-node-install-external-lb/_index.md | 7 +++---- 6 files changed, 19 insertions(+), 12 deletions(-) diff --git a/content/rancher/v2.x/en/installation/_index.md b/content/rancher/v2.x/en/installation/_index.md index 33c34020f8e..55431c72e4f 100644 --- a/content/rancher/v2.x/en/installation/_index.md +++ b/content/rancher/v2.x/en/installation/_index.md @@ -8,14 +8,18 @@ This section contains instructions for installing Rancher in development and pro - [Single Node Installation]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/) - Install Rancher on a single Linux host. + Install Rancher on a single Linux host. Single node installs are recommended for development and test environments, as setup is simple and the server doesn't have to be readily available for a user base—only the developer or tester. - [High Availability Installation]({{< baseurl >}}/rancher/v2.x/en/installation/ha/) - This install scenario creates a new Kubernetes cluster dedicated to running Rancher Server in a high-availability (HA) configuration. + This install scenario creates a new Kubernetes cluster dedicated to running Rancher Server in a high-availability (HA) configuration, which runs Rancher Server on multiple hosts so that it's always accessible provided that one of your cluster nodes is running. We recommend high-availability installs in production environments, where your user base requires 24/7 access to your applications. ### Reference +- [Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/requirements/) + + A reference of hardware and software requirements for the server(s) hosting Rancher. + - [Port Requirements]({{< baseurl >}}/rancher/v2.x/en/installation/references/) List of required ports you must open to operate Rancher. diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index 0ac1c7a02a5..cfac1fc5f23 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -3,7 +3,7 @@ title: High Availability (HA) Install weight: 275 --- -When installed in a Kubernetes cluster, Rancher will integrate with the cluster's etcd database and take advantage of Kubernetes scheduling for High-Availability. +For production environments, we recommend installing Rancher in a high-availability configuration so that your user base can always access Rancher Server. 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. @@ -11,10 +11,10 @@ This procedure walks you through setting up a 3-node cluster with RKE and instal ## Recommended Architecture -* DNS for Rancher should resolve to a Layer 4 Load Balancer +* DNS for Rancher should resolve to a layer 4 load balancer * The Load Balancer should forward ports 80 and 443 TCP to all 3 nodes in the Kubernetes cluster. * The Ingress controller will redirect http port 80 to https and terminate SSL/TLS on port 443. -* The Ingress controller will forward traffic to port 80 on the Pod in the Rancher Deployment. +* The Ingress controller will forward traffic to port 80 on the pod in the Rancher deployment. ![Rancher HA]({{< baseurl >}}/img/rancher/ha/rancher2ha.svg) diff --git a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md index bbe51264d3b..4cc31cca769 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md @@ -4,10 +4,12 @@ weight: 275 aliases: - /rancher/v2.x/en/installation/ha-server-install/ --- -This set of instructions creates a new Kubernetes cluster that's dedicated to running Rancher in a high-availability (HA) configuration. This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on: +This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on: - Layer 4 load balancer (TCP) - [NGINX ingress controller with SSL termination (HTTPS)](https://kubernetes.github.io/ingress-nginx/) + +In a HA setup that uses a layer 4 load balancer, the load balancer accepts Rancher client connections over the TCP/UDP protocols (i.e., the transport level). The load balancer then forwards these connections to individual cluster nodes without reading the request itself. Because the load balancer cannot read the packets it's forwarding, the routing decisions it can make are limited. ![Rancher HA]({{< baseurl >}}/img/rancher/ha/rancher2ha.svg) diff --git a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md index de0af86fde4..263b7522d54 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md @@ -4,11 +4,13 @@ weight: 276 aliases: - /rancher/v2.x/en/installation/ha-server-install-external-lb/ --- -This set of instructions creates a new Kubernetes cluster that's dedicated to running Rancher in a high-availability (HA) configuration. This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on: +This procedure walks you through setting up a 3-node cluster using the Rancher Kubernetes Engine (RKE). The cluster's sole purpose is running pods for Rancher. The setup is based on: - Layer 7 Loadbalancer with SSL termination (HTTPS) - [NGINX Ingress controller (HTTP)](https://kubernetes.github.io/ingress-nginx/) +In a HA setup that uses a layer 7 load balancer, the load balancer accepts Rancher client connections over the HTTP protocol (i.e., the application level). This application-level access allows the load balancer to read client requests and then redirect to them to cluster nodes using logic that optimally distributes load. + ![Rancher HA]({{< baseurl >}}/img/rancher/ha/rancher2ha-l7.svg) ## Installation Outline diff --git a/content/rancher/v2.x/en/installation/single-node/_index.md b/content/rancher/v2.x/en/installation/single-node/_index.md index 6a578ecd16e..0b5ac19717d 100644 --- a/content/rancher/v2.x/en/installation/single-node/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/_index.md @@ -5,7 +5,7 @@ aliases: - /rancher/v2.x/en/installation/single-node-install/ - /rancher/v2.x/en/installation/custom-ca-root-certificate/ --- -For development environments, we recommend installing Rancher by running a single Docker container. In this installation scenario, you'll install Docker on a single Linux host, and then install Rancher on your host using a single Docker container. +For development and testing environments, we recommend installing Rancher by running a single Docker container. In this installation scenario, you'll install Docker on a single Linux host, and then deploy Rancher on your host using a single Docker container. >**Want to use an external load balancer?** > See [Single Node Install with an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/single-node-install-external-lb) instead. diff --git a/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md index 3f1698f7f7f..4ac255820ec 100644 --- a/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md @@ -4,8 +4,7 @@ weight: 252 aliases: - /rancher/v2.x/en/installation/single-node-install-external-lb/ --- -For development environments, we recommend installing Rancher by running a single Docker container. In this installation scenario, you'll deploy Rancher to a Linux host using a single Docker container. Then you will configure an external load balancer to work with Rancher. - +For development and testing environments that have a special requirement to terminate TLS/SSL at a load balancer instead of your Rancher Server container, deploy Rancher and configure a load balancer to work with it it conjunction. This install procedure walks you through deployment of Rancher using a single container, and then provides a sample configuration for a layer 7 Nginx load balancer. >**Want to skip the external load balancer?** > See [Single Node Installation]({{< baseurl >}}/rancher/v2.x/en/installation/single-node) instead. @@ -37,7 +36,7 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher Choose from the following options: {{% accordion id="option-a" label="Option A-Bring Your Own Certificate: Self-Signed" %}} -If you elect to use a self-signed certificate to encrypt communication, you must install the certificate on your load balancer (which you'll do later) and your Rancher container. Run the docker command to deploy Rancher, pointing it toward your certificate. +If you elect to use a self-signed certificate to encrypt communication, you must install the certificate on your load balancer (which you'll do later) and your Rancher container. Run the Docker command to deploy Rancher, pointing it toward your certificate. >**Prerequisites:** >Create a self-signed certificate. @@ -97,7 +96,7 @@ The load balancer or proxy has to be configured to support the following: ### Example Nginx configuration -This Nginx configuration is tested on Nginx version 1.13 (mainline) and 1.14 (stable). +This layer 7 Nginx configuration is tested on Nginx version 1.13 (mainline) and 1.14 (stable). >**Note:** This Nginx configuration is only an example and may not suit your environment. For complete documentation, see [NGINX Load Balancing - TCP and UDP Load Balancer](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/).