add aliases and check links

This commit is contained in:
Jason Greathouse
2018-07-17 09:38:21 +10:00
parent c3b59721ac
commit e9363c7a65
28 changed files with 52 additions and 30 deletions
@@ -10,7 +10,7 @@ This section contains instructions for installing Rancher in development and pro
Install Rancher on a single Linux host. Install Rancher on a single Linux host.
- [High Availability Installation](ha-server-install/) - [High Availability Installation](ha-server-install-helm/)
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.
@@ -30,6 +30,6 @@ The following CLI tools are required for this install. Please make sure these to
## Installation Outline ## Installation Outline
1. [Create Nodes and Load Balancer](create-nodes-and-load-balancer/) 1. [Create Nodes and Load Balancer](create-nodes-and-load-balancer/)
1. [Install Kubernetes with RKE](install-kubernetese-rke/) 1. [Install Kubernetes with RKE](install-kubernetes-rke/)
1. [Initialize Helm (tiller)](helm-install/) 1. [Initialize Helm (tiller)](helm-install/)
1. [Install Rancher](rancher-install/) 1. [Install Rancher](rancher-install/)
@@ -21,7 +21,7 @@ kubectl create clusterrolebinding tiller --clusterrole cluster-admin --serviceac
<details><summary>Additional steps for Air Gap/Private Registry</summary> <details><summary>Additional steps for Air Gap/Private Registry</summary>
<p> <p>
If you have an Air Gapped network extra configuration will be required. If you have an Air Gapped network you will need the tiller image available in your private registry.
##### Create registry secret ##### Create registry secret
@@ -31,14 +31,14 @@ kubectl -n cattle-system get secret cattle-keys-ingress -o jsonpath --template='
If you specified a private CA root cert If you specified a private CA root cert
``` ```
kubectl -n cattle-system get secret cattle-keys-server -o jsonpath --template='{ .data.cacerts\.pem }' | base64 -d > tls.crt kubectl -n cattle-system get secret cattle-keys-server -o jsonpath --template='{ .data.cacerts\.pem }' | base64 -d > cacerts.pem
``` ```
### Remove previous Kubernetes objects ### Remove previous Kubernetes objects
Remove the kubernetes objects created by the RKE install. 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/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 kubectl -n cattle-system delete ingress cattle-ingress-http
@@ -84,6 +84,7 @@ Now that Rancher is running, see [Adding TLS Secrets](tls-secrets/) to publish t
The Rancher chart configuration has many options for customizing the install to suit your specific environment. Here are some common advanced scenarios. The Rancher chart configuration has many options for customizing the install to suit your specific environment. Here are some common advanced scenarios.
* [Private Docker Image Registry/Air Gap Network](chart-options/#private-or-air-gap-registry) * [Private Docker Image Registry/Air Gap Network](chart-options/#private-or-air-gap-registry)
* [TLS Termination on an External Load Balancer](chart-options/#external-tls-termination)
See the [Chart Options](chart-options/) for the full list of options. See the [Chart Options](chart-options/) for the full list of options.
@@ -1,6 +1,8 @@
--- ---
title: High Availability Installation with External Load Balancer (HTTPS/Layer 7) title: High Availability Installation with External Load Balancer (HTTPS/Layer 7)
weight: 276 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 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:
@@ -105,8 +107,8 @@ Health checks can be executed on the `/healthz` endpoint of the node, this will
We have example configurations for the following load balancers: We have example configurations for the following load balancers:
* [Amazon ALB configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install-external-lb/alb) * [Amazon ALB configuration](alb/)
* [NGINX configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install-external-lb/nginx) * [NGINX configuration](nginx/)
## 3. Configure DNS ## 3. Configure DNS
@@ -327,7 +329,7 @@ During installation, RKE automatically generates a config file named `kube_confi
You have a couple of options: You have a couple of options:
- Create a backup of your Rancher Server in case of a disaster scenario: [High Availablility Back Up and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/ha-backup-and-restoration). - Create a backup of your Rancher Server in case of a disaster scenario: [High Availablility Back Up and Restoration]({{< baseurl >}}/rancher/v2.x/en/backups/ha-backups/).
- Create a Kubernetes cluster: [Creating a Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/). - Create a Kubernetes cluster: [Creating a Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/).
<br/> <br/>
@@ -1,6 +1,8 @@
--- ---
title: Amazon ALB configuration title: Amazon ALB configuration
weight: 277 weight: 277
aliases:
- /rancher/v2.x/en/installation/ha-server-install-external-lb/alb/
--- ---
## Objectives ## Objectives
@@ -1,6 +1,8 @@
--- ---
title: NGINX configuration title: NGINX configuration
weight: 277 weight: 277
aliases:
- /rancher/v2.x/en/installation/ha-server-install-external-lb/nginx/
--- ---
## Install NGINX ## Install NGINX
@@ -1,6 +1,8 @@
--- ---
title: High Availability Installation with External Load Balancer (TCP/Layer 4) title: High Availability Installation with External Load Balancer (TCP/Layer 4)
weight: 275 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 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:
@@ -425,7 +427,7 @@ During installation, RKE automatically generates a config file named `kube_confi
You have a couple of options: You have a couple of options:
- Create a backup of your Rancher Server in case of a disaster scenario: [High Availablility Back Up and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/ha-backup-and-restoration). - Create a backup of your Rancher Server in case of a disaster scenario: [High Availablility Back Up and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups/restorations/ha-restoration).
- Create a Kubernetes cluster: [Creating a Cluster]({{ <baseurl> }}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/). - Create a Kubernetes cluster: [Creating a Cluster]({{ <baseurl> }}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/).
<br/> <br/>
@@ -1,6 +1,8 @@
--- ---
title: Amazon NLB configuration title: Amazon NLB configuration
weight: 277 weight: 277
aliases:
- /rancher/v2.x/en/installation/ha-server-install/nlb/
--- ---
## Objectives ## Objectives
@@ -1,6 +1,8 @@
--- ---
title: 404 - default backend title: 404 - default backend
weight: 30 weight: 30
aliases:
- /rancher/v2.x/en/installation/troubleshooting-ha/404-default-backend/
--- ---
To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform. To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform.
@@ -1,24 +1,25 @@
--- ---
title: Troubleshooting High Availability Installation title: Troubleshooting High Availability Installation
weight: 370 weight: 370
aliases:
- /rancher/v2.x/en/installation/troubleshooting-ha/
--- ---
This section contains common errors seen when setting up a High Availability Installation. This section contains common errors seen when setting up a High Availability Installation.
Choose from the following options: Choose from the following options:
- [Generic troubleshooting]({{< baseurl >}}/rancher/v2.x/en/installation/troubleshooting-ha/generic-troubleshooting) - [Generic troubleshooting](generic-troubleshooting/)
In this section, you can find generic ways to debug your Kubernetes cluster. In this section, you can find generic ways to debug your Kubernetes cluster.
- [Failed to set up SSH tunneling for host]({{< baseurl >}}/rancher/v2.x/en/installation/troubleshooting-ha/ssh-tunneling) - [Failed to set up SSH tunneling for host](ssh-tunneling/)
In this section, you can find errors related to SSH tunneling when you run the `rke` command to setup your nodes. In this section, you can find errors related to SSH tunneling when you run the `rke` command to setup your nodes.
- [Failed to get job complete status]({{< baseurl >}}/rancher/v2.x/en/installation/troubleshooting-ha/job-complete-status) - [Failed to get job complete status](job-complete-status/)
In this section, you can find errors related to deploying addons. In this section, you can find errors related to deploying addons.
- [404 - default backend]({{< baseurl >}}/rancher/v2.x/en/installation/troubleshooting-ha/404-default-backend) - [404 - default backend](404-default-backend/)
In this section, you can find errors related to the `404 - default backend` page that is shown when trying to access Rancher. In this section, you can find errors related to the `404 - default backend` page that is shown when trying to access Rancher.
@@ -1,6 +1,8 @@
--- ---
title: Generic troubleshooting title: Generic troubleshooting
weight: 5 weight: 5
aliases:
- /rancher/v2.x/en/installation/troubleshooting-ha/generic-troubleshooting/
--- ---
Below are steps that you can follow to determine what is wrong in your cluster. Below are steps that you can follow to determine what is wrong in your cluster.
@@ -1,6 +1,8 @@
--- ---
title: Failed to get job complete status title: Failed to get job complete status
weight: 20 weight: 20
aliases:
- /rancher/v2.x/en/installation/troubleshooting-ha/job-complete-status/
--- ---
To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform. To debug issues around this error, you will need to download the command-line tool `kubectl`. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) how to download `kubectl` for your platform.
@@ -1,6 +1,8 @@
--- ---
title: Failed to set up SSH tunneling for host title: Failed to set up SSH tunneling for host
weight: 10 weight: 10
aliases:
- /rancher/v2.x/en/installation/troubleshooting-ha/ssh-tunneling/
--- ---
### Failed to set up SSH tunneling for host [xxx.xxx.xxx.xxx]: Can't retrieve Docker Info ### Failed to set up SSH tunneling for host [xxx.xxx.xxx.xxx]: Can't retrieve Docker Info
@@ -4,11 +4,8 @@ weight: 250
--- ---
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 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?** >**Want to use an external load balancer?**
> See [Single Node Installation with an External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/single-node-install-external-lb) instead. > See [Single Node Installation with an External Load Balancer](advanced-install-options/single-node-install-external-lb) instead.
## Installation Outline ## Installation Outline
@@ -81,8 +78,6 @@ If you install Rancher without using your own certificate, Rancher generates a s
rancher/rancher:latest rancher/rancher:latest
``` ```
### Option B—Bring Your Own Certificate: Self-Signed ### Option B—Bring Your Own Certificate: Self-Signed
Your Rancher install can use a self-signed certificate that you provide to encrypt communications. Your Rancher install can use a self-signed certificate that you provide to encrypt communications.
@@ -93,7 +88,6 @@ Your Rancher install can use a self-signed certificate that you provide to encry
>- The certificate files must be in [PEM format](#pem). >- The certificate files must be in [PEM format](#pem).
>- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [SSL FAQ / Troubleshooting](#cert-order). >- In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [SSL FAQ / Troubleshooting](#cert-order).
**To Install Rancher Using a Self-Signed Cert:** **To Install Rancher Using a Self-Signed Cert:**
Your Rancher install can use a self-signed certificate that you provide to encrypt communications. Your Rancher install can use a self-signed certificate that you provide to encrypt communications.
@@ -163,7 +157,6 @@ Run the following commands from your Linux host.
--acme-domain rancher.mydomain.com --acme-domain rancher.mydomain.com
``` ```
> >
>**Remember:** Let's Encrypt provides rate limits for requesting new certificates. Therefore, limit how often you create or destroy the container. For more information, see [Let's Encrypt documentation on rate limits](https://letsencrypt.org/docs/rate-limits/). >**Remember:** Let's Encrypt provides rate limits for requesting new certificates. Therefore, limit how often you create or destroy the container. For more information, see [Let's Encrypt documentation on rate limits](https://letsencrypt.org/docs/rate-limits/).
@@ -199,4 +192,3 @@ docker run -d --restart=unless-stopped \
-p 8080:80 -p 8443:443 \ -p 8080:80 -p 8443:443 \
rancher/rancher:latest rancher/rancher:latest
``` ```
@@ -2,3 +2,7 @@
title: Advanced Install Options title: Advanced Install Options
weight: 250 weight: 250
--- ---
* [Air Gap Installation](air-gap-installation)
* [HTTP/S Proxy Configuration](proxy-configuration)
* [Using an External Load Balancer](single-node-install-external-lb)
@@ -1,6 +1,8 @@
--- ---
title: Air Gap Installation title: Air Gap Installation
weight: 345 weight: 345
aliases:
- /rancher/v2.x/en/installation/air-gap-installation/
--- ---
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. 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.
@@ -1,6 +1,8 @@
--- ---
title: Rancher HTTP Proxy Configuration title: Rancher HTTP Proxy Configuration
weight: 360 weight: 360
aliases:
- /rancher/v2.x/en/installation/proxy-configuration/
--- ---
If you operate Rancher behind a proxy and you need to reach the Internet to perform tasks (such as using Helm catalogs), you must provide Rancher information about your proxy. If you operate Rancher behind a proxy and you need to reach the Internet to perform tasks (such as using Helm catalogs), you must provide Rancher information about your proxy.
@@ -1,6 +1,8 @@
--- ---
title: Single Node Installation with External Load Balancer title: Single Node Installation with External Load Balancer
weight: 260 weight: 260
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 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.
@@ -58,7 +60,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. 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:** >**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 prepend your private registry URL to the server tag when running the installation command in the option that you choose. Replace `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL. > If you are visiting this page to complete [Air Gap Installation](../air-gap-installation/), you must prepend your private registry URL to the server tag when running the installation command in the option that you choose. Replace `<REGISTRY.DOMAIN.COM:PORT>` with your private registry URL.
> >
> Example: > Example:
``` ```
@@ -173,7 +175,7 @@ server {
## What's Next? ## What's Next?
You have a couple of options: You have a couple of options:
- Create a backup of your Rancher Server in case of a disaster scenario: [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups-and-restoration/single-node-backup-and-restoration/). - Create a backup of your Rancher Server in case of a disaster scenario: [Single Node Backup and Restoration]({{< baseurl >}}/rancher/v2.x/en/installation/backups/single-node-backups/).
- Create a Kubernetes cluster: [Creating a Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/). - Create a Kubernetes cluster: [Creating a Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/).
<br/> <br/>