diff --git a/content/rancher/v2.x/en/installation/single-node/advanced-options/air-gap-installation/_index.md b/content/rancher/v2.x/en/installation/air-gap-installation/_index.md similarity index 72% rename from content/rancher/v2.x/en/installation/single-node/advanced-options/air-gap-installation/_index.md rename to content/rancher/v2.x/en/installation/air-gap-installation/_index.md index df38b9ca48a..3bcf38cb402 100644 --- a/content/rancher/v2.x/en/installation/single-node/advanced-options/air-gap-installation/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap-installation/_index.md @@ -1,14 +1,11 @@ --- -title: Air Gap Installation -weight: 345 -aliases: -- /rancher/v2.x/en/installation/air-gap-installation/ +title: Preparing for Air Gap Install +weight: 300 --- Rancher supports installing from a private registry. In every [release](https://github.com/rancher/rancher/releases), we provide you with the needed Docker images and scripts to mirror those images to your own registry. The Docker images are used when nodes are added to a cluster, or when you enable features like pipelines or logging. >**Prerequisite:** It is assumed you either have your own private registry or other means of distributing docker images to your machine. If you need help with creating a private registry, please refer to the [Docker documentation for private registries](https://docs.docker.com/registry/). - >**Note:** In Rancher v2.0.0, registries with authentication are not supported for installing from a private registry. The Docker images can only be pulled from a registry without authentication enabled. This limitation only applies to Docker images. ## Release files @@ -17,14 +14,14 @@ Rancher supports installing from a private registry. In every [release](https:// * **rancher-save-images.sh**: This script will pull all needed images from DockerHub, and save all of the images as a compressed file called `rancher-images.tar.gz`. This file can be transferred to your on-premise host that can access your private registry. * **rancher-load-images.sh**: This script will load images from rancher-images.tar.gz and push them to your private registry. You have to supply the hostname of your private registry as first argument to the script.
`rancher-load-images.sh registry.yourdomain.com:5000` -### Making the Rancher images available +## Making the Rancher images available We will cover two scenarios: -* **Scenario 1**: You have one host that can access DockerHub to pull and save the images, and a separate host that access your private registry to push the images. -* **Scenario 2**: You have one host that can access both DockerHub and your private registry. +* **Scenario 1**: You have a node that can access DockerHub to pull and save the images, and a separate node(s) that access your private registry to push the images. +* **Scenario 2**: You have node(s) that can access both DockerHub and your private registry. -#### Scenario 1: One host that can access DockerHub, separate host that can access private registry +### Scenario 1: A node that can access DockerHub, separate node(s) that can access the private registry ![Scenario1]({{< baseurl >}}/img/rancher/airgap/privateregistry.svg) @@ -36,19 +33,7 @@ We will cover two scenarios: 4. Transfer and run `rancher-load-images.sh` on the host that can access the private registry. It should be run in the same directory as `rancher-images.tar.gz`. -5. Complete installation of Rancher using the instructions in [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/). - - >**Note:** - > When completing [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/), prepend your private registry URL to the image when running the `docker run` command. - > - > Example: - > ``` - docker run -d --restart=unless-stopped \ - -p 80:80 -p 443:443 \ - /rancher/rancher:latest - ``` - -#### Scenario 2: You have one host that can access both DockerHub and your private registry. +### Scenario 2: You have node(s) that can access both DockerHub and your private registry. ![Scenario2]({{< baseurl >}}/img/rancher/airgap/privateregistrypushpull.svg) @@ -68,20 +53,29 @@ for IMAGE in $IMAGES; do done ``` -3. Complete installation of Rancher using the instructions in [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/). +## Completing the Rancher installation - >**Note:** - > When completing [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/), prepend your private registry URL to the image when running the `docker run` command. - > - > Example: - > ``` +After your private registry is setup on all node(s) for your Rancher installation, complete your Rancher installation. + +### Single Node Install + +Complete installation of Rancher using the instructions in [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/). + +>**Note:** +> When completing [Single Node Install]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/), prepend your private registry URL to the image when running the `docker run` command. +> +> Example: +> ``` docker run -d --restart=unless-stopped \ -p 80:80 -p 443:443 \ /rancher/rancher:latest - ``` +``` +### High Availability Install -### Configuring Rancher to use the private registry +Complete the installation of Rancher following the [High Availability instructions]({{< baseurl >}}/rancher/v2.x/en/installation/ha/). + +## Configuring Rancher to use the private registry Rancher needs to be configured to use the private registry as source for the needed images. diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index ba365960641..2dee2f962a1 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -1,5 +1,5 @@ --- -title: High Availability Installation +title: High Availability (HA) Install weight: 275 draft: true --- @@ -36,5 +36,5 @@ The following CLI tools are required for this install. Please make sure these to ## Additional Install Options -* [Migrating from RKE all-in-one install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/) -* [RKE all-in-one install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-all-in-one/) \ No newline at end of file +* [Migrating from RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) +* [RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/) diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/_index.md similarity index 51% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/_index.md index 4b3cb65c1f0..eab29cd6494 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/_index.md @@ -1,10 +1,11 @@ --- -title: RKE All-In-One Install +title: Advanced Install - RKE Add-on weight: 276 --- Rancher can be installed by providing the appropriate Kubernetes manifest configurations to RKE's `addons` feature. See the following instructions for examples appropriate to your environment. -* [High Availability Installation with External Load Balancer (TCP/Layer 4)]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-all-in-one/layer-4-lb/) -* [High Availability Installation with External Load Balancer (HTTPS/Layer 7)]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-all-in-one/layer-7-lb/) -* [Troubleshooting RKE All-In-One Installs]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-all-in-one/troubleshooting/) +* [High Availability Installation with External Load Balancer (TCP/Layer 4)]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-add-on/layer-4-lb/) +* [High Availability Installation with External Load Balancer (HTTPS/Layer 7)]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-add-on/layer-7-lb/) +* [HTTP Proxy Configuration for a High Availability Installation]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-add-on/proxy/) +* [Troubleshooting RKE Add-on Installs]({{< baseurl >}}/rancher/v2.x/installation/ha/rke-add-on/troubleshooting/) diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md similarity index 99% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md index 99cd3f429c8..581fa1b6f21 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/_index.md @@ -1,5 +1,5 @@ --- -title: High Availability Installation with External Load Balancer (TCP/Layer 4) +title: HA Install with External Load Balancer (TCP/Layer 4) weight: 275 aliases: - /rancher/v2.x/en/installation/ha-server-install/ @@ -111,7 +111,7 @@ After installing NGINX, you need to update the NGINX config file, `nginx.conf`, 2. From `nginx.conf`, replace `IP_NODE_1`, `IP_NODE_2`, and `IP_NODE_3` with the IPs of your [Linux hosts](#1-provision-linux-hosts). >**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/). - + **Example NGINX config:** ``` worker_processes 4; diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/nlb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/nlb/_index.md similarity index 99% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/nlb/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/nlb/_index.md index f2eebef4170..316b0ce50f4 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-4-lb/nlb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-4-lb/nlb/_index.md @@ -1,5 +1,5 @@ --- -title: Amazon NLB configuration +title: Amazon NLB Configuration weight: 277 aliases: - /rancher/v2.x/en/installation/ha-server-install/nlb/ diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md similarity index 99% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md index 9fb112f4045..a000c8089ea 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/_index.md @@ -1,5 +1,5 @@ --- -title: High Availability Installation with External Load Balancer (HTTPS/Layer 7) +title: HA Install with External Load Balancer (HTTPS/Layer 7) weight: 276 aliases: - /rancher/v2.x/en/installation/ha-server-install-external-lb/ diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/alb/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/alb/_index.md similarity index 99% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/alb/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/alb/_index.md index bc96496e99e..abeb64eaded 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/alb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/alb/_index.md @@ -1,5 +1,5 @@ --- -title: Amazon ALB configuration +title: Amazon ALB Configuration weight: 277 aliases: - /rancher/v2.x/en/installation/ha-server-install-external-lb/alb/ diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/nginx/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/nginx/_index.md similarity index 99% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/nginx/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/nginx/_index.md index 3b748b01559..d62c2c2c53f 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/layer-7-lb/nginx/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/layer-7-lb/nginx/_index.md @@ -1,5 +1,5 @@ --- -title: NGINX configuration +title: NGINX Configuration weight: 277 aliases: - /rancher/v2.x/en/installation/ha-server-install-external-lb/nginx/ diff --git a/content/rancher/v2.x/en/installation/single-node/advanced-options/proxy-configuration/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/proxy/_index.md similarity index 77% rename from content/rancher/v2.x/en/installation/single-node/advanced-options/proxy-configuration/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/proxy/_index.md index 3dd3fa231c2..05cb1f6ef2a 100644 --- a/content/rancher/v2.x/en/installation/single-node/advanced-options/proxy-configuration/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/proxy/_index.md @@ -1,8 +1,6 @@ --- title: HTTP Proxy Configuration -weight: 360 -aliases: -- /rancher/v2.x/en/installation/proxy-configuration/ +weight: 277 --- If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below. @@ -16,25 +14,6 @@ NO_PROXY | Network address(es), network address range(s) and do > **Note** NO_PROXY must be in uppercase to use network range (CIDR) notation. -## Single Node Installation - -Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Single Node Installation]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/) are: - -* `localhost` -* `127.0.0.1` -* `0.0.0.0` - -The example below is based on a proxy server accessible at `http://192.168.0.1:3128`, and excluding usage the proxy when accessing network range `192.168.10.0/24` and every hostname under the domain `example.com`. - -``` -docker run -d --restart=unless-stopped \ - -p 80:80 -p 443:443 \ - -e HTTP_PROXY="http://192.168.10.1:3128" \ - -e HTTPS_PROXY="http://192.168.10.1:3128" \ - -e NO_PROXY="localhost,127.0.0.1,0.0.0.0,192.168.10.0/24,example.com" \ - rancher/rancher:latest -``` - ## High Availability Installation When using High Availability Installation, the environment variables need to be added to the RKE Config File template. diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/404-default-backend/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/404-default-backend/_index.md similarity index 100% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/404-default-backend/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/404-default-backend/_index.md diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/_index.md similarity index 93% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/_index.md index 7023eb3dfbe..2ab9ccf7147 100644 --- a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/_index.md +++ b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/_index.md @@ -1,5 +1,5 @@ --- -title: Troubleshooting High Availability Installation +title: Troubleshooting HA RKE Add-On Install weight: 370 aliases: - /rancher/v2.x/en/installation/troubleshooting-ha/ diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/generic-troubleshooting/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/generic-troubleshooting/_index.md similarity index 100% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/generic-troubleshooting/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/generic-troubleshooting/_index.md diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/job-complete-status/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/job-complete-status/_index.md similarity index 100% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/job-complete-status/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/job-complete-status/_index.md diff --git a/content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/ssh-tunneling/_index.md b/content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/ssh-tunneling/_index.md similarity index 100% rename from content/rancher/v2.x/en/installation/ha/rke-all-in-one/troubleshooting/ssh-tunneling/_index.md rename to content/rancher/v2.x/en/installation/ha/rke-add-on/troubleshooting/ssh-tunneling/_index.md diff --git a/content/rancher/v2.x/en/installation/references/_index.md b/content/rancher/v2.x/en/installation/references/_index.md index 840bd550840..3f2e7facc22 100644 --- a/content/rancher/v2.x/en/installation/references/_index.md +++ b/content/rancher/v2.x/en/installation/references/_index.md @@ -1,6 +1,6 @@ --- title: Port Requirements -weight: 355 +weight: 280 aliases: - /rancher/v2.x/en/hosts/amazon/#required-ports-for-rancher-to-work/ --- 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 c3f3130667f..2dde9a9e39b 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -1,6 +1,6 @@ --- title: Server Tags -weight: 2000 +weight: 230 --- {{< product >}} Server is distributed as a Docker image, which have _tags_ attached to them. Tags are used to identify what version is included in the image. Rancher includes additional tags that point to a specific version. Remember that if you use the additional tags, you must explicitly pull a new version of that image tag. Otherwise it will use the cached image on the host. 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 8c4df50be0c..e4e920cea7f 100644 --- a/content/rancher/v2.x/en/installation/single-node/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/_index.md @@ -1,11 +1,13 @@ --- -title: Single Node Installation +title: Single Node Install weight: 250 +aliases: + - /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. >**Want to use an external load balancer?** -> See [Single Node Installation with an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/advanced-options/single-node-install-external-lb) instead. +> See [Single Node Install with an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/single-node-install-external-lb) instead. ## Installation Outline @@ -50,7 +52,7 @@ The following diagram depicts the basic port requirements for Rancher. For a com For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster. >**Attention Air Gap Users:** -> If you are visiting this page to complete [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Replace `` with your private registry URL. +> If you are visiting this page to complete an [Air Gap]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/) Installation, you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `` with your private registry URL in front of `rancher/rancher:latest`. > > Example: ``` @@ -62,7 +64,8 @@ Choose from the following options: - [Option A—Default Self-Signed Certificate](#option-a-default-self-signed-certificate) - [Option B—Bring Your Own Certificate: Self-Signed](#option-b-bring-your-own-certificate-self-signed) - [Option C—Bring Your Own Certificate: Signed by Recognized CA](#option-c-bring-your-own-certificate-signed-by-recognized-ca) -- [Option D—Let's Encrypt Certificate](#option-d-let-s-encrypt-certificate) +- [Option D—Bring Your Own Certificate: Private CA Root Certificate CA](#option-d-bring-your-own-certificate-private-ca-root-certificate) +- [Option E—Let's Encrypt Certificate](#option-e-let-s-encrypt-certificate) ### Option A—Default Self-Signed Certificate @@ -103,7 +106,6 @@ Your Rancher install can use a self-signed certificate that you provide to encry rancher/rancher:latest ``` - ### Option C—Bring Your Own Certificate: Signed by Recognized CA If you're publishing your app publicly, you should ideally be using a certificate signed by a recognized CA. @@ -126,7 +128,38 @@ If you're publishing your app publicly, you should ideally be using a certificat rancher/rancher:latest --no-cacerts ``` -### Option D—Let's Encrypt Certificate +### Option D—Bring Your Own Certificate: Private CA Root Certificate + +Services that Rancher needs to access are sometimes configured with a certificate from an custom/internal Certificate Authority (CA) root, also known as self signed certificate. If the presented certificate from the service cannot be validated by Rancher, the following error will appear: `x509: certificate signed by unknown authority`. + +To validate the certificate, the CA root certificates need to be added to Rancher. As Rancher is written in Go, we can use the environment variable `SSL_CERT_DIR` to point to the directory where the CA root certificates are located in the container. The CA root certificates directory can be mounted using the Docker volume option (`-v host-source-directory:container-destination-directory`) when starting the Rancher container. + +Examples of services that Rancher can access: + +* Catalogs +* Authentication providers +* Accessing hosting/cloud API when using Node Drivers + +#### Start Rancher Container with custom CA root certificates + +The requirements are: + +* Mount the host directory containing the CA root certificates in the container using the volume option. +* Add the environment variable `SSL_CERT_DIR` with as value the mounted CA root certificates directory location inside the container. + +Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`, mounting a host directory inside the container can be done using `-v host-source-directory:container-destination-directory` or `--volume host-source-directory:container-destination-directory`. + +The example below is based on having the CA root certificates in the `/host/certs` directory on the host and mounting this directory on `/container/certs` inside the Rancher container. + +``` +docker run -d --restart=unless-stopped \ + -p 80:80 -p 443:443 \ + -v /host/certs:/container/certs \ + -e SSL_CERT_DIR="/container/certs" \ + rancher/rancher:latest +``` + +### Option E—Let's Encrypt Certificate Rancher supports Let's Encrypt certificates. Let's Encrypt uses an `http-01 challenge` to verify that you have control over your domain. You can confirm that you control the domain by pointing the hostname that you want to use for Rancher access (for example, `rancher.mydomain.com`) to the IP of the machine it is running on. You can bind the hostname to the IP address by creating an A record in DNS. @@ -174,7 +207,7 @@ You have a couple of options: In the situation where you want to use a single node to run Rancher and to be able to add the same node to a cluster, you have to adjust the host ports mapped for the `rancher/rancher` container. -If a node is added to a cluster, it deploys the nginx ingress controller which will use port 80 and 443. This will conflict with the default ports we advice to expose for the `rancher/rancher` container. +If a node is added to a cluster, it deploys the nginx ingress controller which will use port 80 and 443. This will conflict with the default ports we advice to expose for the `rancher/rancher` container. Please note that this setup is not recommended for production use, but can be convenient for development/demo purposes. diff --git a/content/rancher/v2.x/en/installation/single-node/advanced-options/_index.md b/content/rancher/v2.x/en/installation/single-node/advanced-options/_index.md deleted file mode 100644 index 64d66862152..00000000000 --- a/content/rancher/v2.x/en/installation/single-node/advanced-options/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Advanced Install Options -weight: 250 ---- - -* [Air Gap Installation]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/advanced-options/air-gap-installation) -* [HTTP/S Proxy Configuration]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/advanced-options/proxy-configuration) -* [Using an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/advanced-options/single-node-install-external-lb) -* [Using a Private CA Root Certificate]({{< baseurl >}}/rancher/v2.x/en/installation/single-node/advanced-options/private-ca-root-certificate) \ No newline at end of file diff --git a/content/rancher/v2.x/en/installation/single-node/advanced-options/private-ca-root-certificate/_index.md b/content/rancher/v2.x/en/installation/single-node/advanced-options/private-ca-root-certificate/_index.md deleted file mode 100644 index 275fc2408a8..00000000000 --- a/content/rancher/v2.x/en/installation/single-node/advanced-options/private-ca-root-certificate/_index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Using a Private CA Root Certificate -weight: 365 ---- -Services that Rancher needs to access are sometimes configured with a certificate from an custom/internal Certificate Authority (CA) root, also known as self signed certificate. If the presented certificate from the service cannot be validated by Rancher, the following error will appear: `x509: certificate signed by unknown authority`. - -To validate the certificate, the CA root certificates need to be added to Rancher. As Rancher is written in Go, we can use the environment variable `SSL_CERT_DIR` to point to the directory where the CA root certificates are located in the container. The CA root certificates directory can be mounted using the Docker volume option (`-v host-source-directory:container-destination-directory`) when starting the Rancher container. - -Examples of services that Rancher can access: - -* Catalogs -* Authentication providers -* Accessing hosting/cloud API when using Node Drivers - -## Start Rancher Container with custom CA root certificates - -The requirements are: - -* Mount the host directory containing the CA root certificates in the container using the volume option. -* Add the environment variable `SSL_CERT_DIR` with as value the mounted CA root certificates directory location inside the container. - -Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`, mounting a host directory inside the container can be done using `-v host-source-directory:container-destination-directory` or `--volume host-source-directory:container-destination-directory`. - -The example below is based on having the CA root certificates in the `/host/certs` directory on the host and mounting this directory on `/container/certs` inside the Rancher container. - -``` -docker run -d --restart=unless-stopped \ - -p 80:80 -p 443:443 \ - -v /host/certs:/container/certs \ - -e SSL_CERT_DIR="/container/certs" \ - rancher/rancher:latest -``` diff --git a/content/rancher/v2.x/en/installation/single-node/proxy/_index.md b/content/rancher/v2.x/en/installation/single-node/proxy/_index.md new file mode 100644 index 00000000000..9a82c8bbdc2 --- /dev/null +++ b/content/rancher/v2.x/en/installation/single-node/proxy/_index.md @@ -0,0 +1,36 @@ +--- +title: HTTP Proxy Configuration +weight: 251 +aliases: +- /rancher/v2.x/en/installation/proxy-configuration/ +--- +If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below. + +Make sure `NO_PROXY` contains the network addresses, network address ranges and domains that should be excluded from using the proxy. + +Environment variable | Purpose +--------------------------|--------- +HTTP_PROXY | Proxy address to use when initiating HTTP connection(s) +HTTPS_PROXY | Proxy address to use when initiating HTTPS connection(s) +NO_PROXY | Network address(es), network address range(s) and domains to exclude from using the proxy when initiating connection(s) + +> **Note** NO_PROXY must be in uppercase to use network range (CIDR) notation. + +## Single Node Installation + +Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Single Node Installation]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install/) are: + +* `localhost` +* `127.0.0.1` +* `0.0.0.0` + +The example below is based on a proxy server accessible at `http://192.168.0.1:3128`, and excluding usage the proxy when accessing network range `192.168.10.0/24` and every hostname under the domain `example.com`. + +``` +docker run -d --restart=unless-stopped \ + -p 80:80 -p 443:443 \ + -e HTTP_PROXY="http://192.168.10.1:3128" \ + -e HTTPS_PROXY="http://192.168.10.1:3128" \ + -e NO_PROXY="localhost,127.0.0.1,0.0.0.0,192.168.10.0/24,example.com" \ + rancher/rancher:latest +``` diff --git a/content/rancher/v2.x/en/installation/single-node/advanced-options/single-node-install-external-lb/_index.md b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md similarity index 98% rename from content/rancher/v2.x/en/installation/single-node/advanced-options/single-node-install-external-lb/_index.md rename to content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md index b85ee0326a5..0340095d70b 100644 --- a/content/rancher/v2.x/en/installation/single-node/advanced-options/single-node-install-external-lb/_index.md +++ b/content/rancher/v2.x/en/installation/single-node/single-node-install-external-lb/_index.md @@ -1,6 +1,6 @@ --- -title: Single Node Installation with External Load Balancer -weight: 260 +title: Single Node Install with External Load Balancer +weight: 252 aliases: - /rancher/v2.x/en/installation/single-node-install-external-lb/ --- @@ -134,7 +134,7 @@ The load balancer or proxy has to be configured to support the following: This 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/). - + ``` upstream rancher { server rancher-server:80; diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/_index.md b/content/rancher/v2.x/en/upgrades/rollbacks/_index.md new file mode 100644 index 00000000000..53b3f8920f9 --- /dev/null +++ b/content/rancher/v2.x/en/upgrades/rollbacks/_index.md @@ -0,0 +1,8 @@ +--- +title: Rollbacks +weight: 1010 +--- +This section contains information about how to rollback your Rancher server to a previous version. + +- [Rolling back a Single Node Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/) +- [Rolling back a High Availability Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/) diff --git a/content/rancher/v2.x/en/upgrades/ha-server-rollbacks/_index.md b/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md similarity index 94% rename from content/rancher/v2.x/en/upgrades/ha-server-rollbacks/_index.md rename to content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md index 71a3d78fde6..02745f1d2fc 100644 --- a/content/rancher/v2.x/en/upgrades/ha-server-rollbacks/_index.md +++ b/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md @@ -1,8 +1,9 @@ --- -title: High Availability Rollback +title: High Availability (HA) Rollback weight: 1025 aliases: - - /rancher/v2.x/en/backups/rollbacks/ha-server-rollbacks + - /rancher/v2.x/en/backups/rollbacks/ha-server-rollbacks/ + - /rancher/v2.x/en/upgrades/ha-server-rollbacks --- If you upgrade Rancher, but the upgrade does not complete successfully, you may need to roll back your Rancher Server to its last healthy state before upgrade. To restore Rancher: @@ -75,4 +76,4 @@ docker container inspect rke-bundle-cert The important thing to note is the mounts of the container and location of the **pki.bundle.tar.gz**. As of **RKE v0.1.9**, the **rke-bundle-cert** container is removed on both success and -failure of a restore. To debug any issues, you will need to look at the **logs** generated from rke. +failure of a restore. To debug any issues, you will need to look at the **logs** generated from rke. diff --git a/content/rancher/v2.x/en/upgrades/single-node-rollbacks/_index.md b/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md similarity index 96% rename from content/rancher/v2.x/en/upgrades/single-node-rollbacks/_index.md rename to content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md index 19526036620..a7f6e85e8ab 100644 --- a/content/rancher/v2.x/en/upgrades/single-node-rollbacks/_index.md +++ b/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md @@ -3,6 +3,7 @@ title: Single Node Rollback weight: 1015 aliases: - /rancher/v2.x/en/backups/rollbacks/single-node-rollbacks + - /rancher/v2.x/en/upgrades/single-node-rollbacks --- Rolling back an unsuccessful Rancher upgrade requires you to diff --git a/content/rancher/v2.x/en/upgrades/upgrades/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/_index.md new file mode 100644 index 00000000000..fd0d80c242b --- /dev/null +++ b/content/rancher/v2.x/en/upgrades/upgrades/_index.md @@ -0,0 +1,10 @@ +--- +title: Upgrades +weight: 1005 +--- +This section contains information about how to upgrade your Rancher server to a newer version. + +- [Upgrading a Single Node Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/) +- [Upgrading an Air Gapped Single Node Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-air-gap-upgrade/) +- [Upgrading a High Availability Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/) +- [Migrating from a High Availability RKE Add-on Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) diff --git a/content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md similarity index 95% rename from content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md index 0eeb03fd682..0e699a7a9df 100644 --- a/content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade/_index.md @@ -1,6 +1,8 @@ --- -title: High Availability Upgrade +title: High Availability (HA) Upgrade weight: 1020 +aliases: + - /rancher/v2.x/en/upgrades/ha-server-upgrade/ --- To upgrade Rancher 2.x running in a high availability configuration, run an upgrade command that points to your upgrade config file. diff --git a/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/_index.md similarity index 94% rename from content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md rename to content/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/_index.md index a90aabe6a3b..0041f925b23 100644 --- a/content/rancher/v2.x/en/installation/ha/migrating-from-rke-all-in-one/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/_index.md @@ -1,9 +1,9 @@ --- -title: Migrating from RKE All-In-One Install -weight: 235 +title: Migrating from a HA RKE Add-on Install +weight: 1030 --- -The following instructions will help guide you through migrating from the RKE All-In-One install to managing Rancher with the Helm package manager. +The following instructions will help guide you through migrating from the RKE Add-on install to managing Rancher with the Helm package manager. 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. diff --git a/content/rancher/v2.x/en/upgrades/air-gap-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/single-node-air-gap-upgrade/_index.md similarity index 88% rename from content/rancher/v2.x/en/upgrades/air-gap-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/upgrades/single-node-air-gap-upgrade/_index.md index 097a644b2bb..62684f0a054 100644 --- a/content/rancher/v2.x/en/upgrades/air-gap-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/single-node-air-gap-upgrade/_index.md @@ -1,6 +1,8 @@ --- -title: Air Gap Upgrade -weight: 1500 +title: Single Node Air Gap Upgrade +weight: 1011 +aliases: + - /rancher/v2.x/en/upgrades/air-gap-upgrade/ --- To upgrade an air gapped Rancher Server, update your private registry with the latest Docker images, and then run the upgrade command. diff --git a/content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md similarity index 98% rename from content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md index f2e7dafd952..6247147afa8 100644 --- a/content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md @@ -1,6 +1,8 @@ --- title: Single Node Upgrade weight: 1010 +aliases: + - /rancher/v2.x/en/upgrades/single-node-upgrade/ --- To upgrade Rancher Server 2.x after a new version is released, create a backup of your server and then run the upgrade command. diff --git a/layouts/shortcodes/note_server-tags.html b/layouts/shortcodes/note_server-tags.html index 82aa0aaabcf..6a03c80a3ca 100644 --- a/layouts/shortcodes/note_server-tags.html +++ b/layouts/shortcodes/note_server-tags.html @@ -1,7 +1,7 @@

Note:

-

The rancher/rancher container is hosted on DockerHub. If you don't have access to DockerHub, or you are installing Rancher without an Internet connection, refer to Air Gap Installation.

+

The rancher/rancher container is hosted on DockerHub. If you don't have access to DockerHub, or you are installing Rancher without an Internet connection, refer to how to prepare for an Air Gap Installation.

Note:

For a list of other Rancher Server tags available, refer to Rancher Server Tags.