Updating notes

2026-09-26 21:18:04 +00:00 · 2022-07-08 16:18:20 -04:00
parent 6b9095d077
commit b6237a5a7f
43 changed files with 518 additions and 190 deletions
@@ -7,16 +7,23 @@ weight: 3

 This section describes how to install a Kubernetes cluster. This cluster should be dedicated to run only the Rancher server.

-> Rancher can run on any Kubernetes cluster, included hosted Kubernetes solutions such as Amazon EKS. The below instructions represent only one possible way to install Kubernetes.
+:::note
+
+Rancher can run on any Kubernetes cluster, included hosted Kubernetes solutions such as Amazon EKS. The below instructions represent only one possible way to install Kubernetes.
+
+:::

 For systems without direct internet access, refer to [Air Gap: Kubernetes install.]({{<baseurl>}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/)

-> **Single-node Installation Tip:**
-> In a single-node Kubernetes cluster, the Rancher server does not have high availability, which is important for running Rancher in production. However, installing Rancher on a single-node cluster can be useful if you want to save resources by using a single node in the short term, while preserving a high-availability migration path.
->
-> To set up a single-node RKE cluster, configure only one node in the `cluster.yml` . The single node should have all three roles: `etcd`, `controlplane`, and `worker`.
->
-> In both single-node setups, Rancher can be installed with Helm on the Kubernetes cluster in the same way that it would be installed on any other cluster.
+:::tip Single-node Installation Tip:
+
+In a single-node Kubernetes cluster, the Rancher server does not have high availability, which is important for running Rancher in production. However, installing Rancher on a single-node cluster can be useful if you want to save resources by using a single node in the short term, while preserving a high-availability migration path.
+
+To set up a single-node RKE cluster, configure only one node in the `cluster.yml` . The single node should have all three roles: `etcd`, `controlplane`, and `worker`.
+
+In both single-node setups, Rancher can be installed with Helm on the Kubernetes cluster in the same way that it would be installed on any other cluster.
+
+:::

 # Installing Kubernetes

@@ -75,13 +82,17 @@ ingress:
 | `internal_address` | no       | The private DNS or IP address for internal cluster traffic                             |
 | `ssh_key_path`     | no       | Path to SSH private key used to authenticate to the node (defaults to `~/.ssh/id_rsa`) |

-> **Advanced Configurations:** RKE has many configuration options for customizing the install to suit your specific environment.
->
-> Please see the [RKE Documentation]({{<baseurl>}}/rke/latest/en/config-options/) for the full list of options and capabilities.
-> 
-> For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide]({{<baseurl>}}/rancher/v2.6/en/installation/resources/advanced/etcd/).
->
-> For more information regarding Dockershim support, refer to [this page]({{<baseurl>}}/rancher/v2.6/en/installation/requirements/dockershim/)
+:::note Advanced Configurations:
+
+RKE has many configuration options for customizing the install to suit your specific environment.
+
+Please see the [RKE Documentation]({{<baseurl>}}/rke/latest/en/config-options/) for the full list of options and capabilities.
+ 
+For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide]({{<baseurl>}}/rancher/v2.6/en/installation/resources/advanced/etcd/).
+
+For more information regarding Dockershim support, refer to [this page]({{<baseurl>}}/rancher/v2.6/en/installation/requirements/dockershim/)
+
+:::

 ### 2. Run RKE

@@ -99,7 +110,11 @@ Assuming you have installed `kubectl`, you need to place the `kubeconfig` file i

 When you ran `rke up`, RKE should have created a `kubeconfig` file named `kube_config_cluster.yml`. This file has the credentials for `kubectl` and `helm`.

-> **Note:** If you have used a different file name from `rancher-cluster.yml`, then the kube config file will be named `kube_config_<FILE_NAME>.yml`.
+:::note
+
+If you have used a different file name from `rancher-cluster.yml`, then the kube config file will be named `kube_config_<FILE_NAME>.yml`.
+
+:::

 Move 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_cluster.yml`:

@@ -149,8 +164,11 @@ This confirms that you have successfully installed a Kubernetes cluster that the

 ### 5. Save Your Files

-> **Important**
-> The files mentioned below are needed to maintain, troubleshoot and upgrade your cluster.
+:::note Important:
+
+The files mentioned below are needed to maintain, troubleshoot and upgrade your cluster.
+
+:::

 Save a copy of the following files in a secure location:

@@ -158,7 +176,11 @@ Save a copy of the following files in a secure location:
 - `kube_config_cluster.yml`: The [Kubeconfig file]({{<baseurl>}}/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster.
 - `rancher-cluster.rkestate`: The [Kubernetes Cluster State file]({{<baseurl>}}/rke/latest/en/installation/#kubernetes-cluster-state), this file contains credentials for full access to the cluster.<br/><br/>_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._

-> **Note:** The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file.
+:::note
+
+The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file.
+
+:::

 ### Issues or errors?

@@ -8,12 +8,15 @@ This section describes how to install a Kubernetes cluster according to the [bes

 For systems without direct internet access, refer to the air gap installation instructions.

-> **Single-node Installation Tip:**
-> In a single-node Kubernetes cluster, the Rancher server does not have high availability, which is important for running Rancher in production. However, installing Rancher on a single-node cluster can be useful if you want to save resources by using a single node in the short term, while preserving a high-availability migration path.
->
-> To set up a single-node K3s cluster, run the Rancher server installation command on just one node instead of two nodes.
->
-> In both single-node setups, Rancher can be installed with Helm on the Kubernetes cluster in the same way that it would be installed on any other cluster.
+:::tip Single-node Installation Tip:
+
+In a single-node Kubernetes cluster, the Rancher server does not have high availability, which is important for running Rancher in production. However, installing Rancher on a single-node cluster can be useful if you want to save resources by using a single node in the short term, while preserving a high-availability migration path.
+
+To set up a single-node K3s cluster, run the Rancher server installation command on just one node instead of two nodes.
+
+In both single-node setups, Rancher can be installed with Helm on the Kubernetes cluster in the same way that it would be installed on any other cluster.
+
+:::

 # Prerequisites

@@ -56,7 +56,11 @@ sudo usermod -aG docker ubuntu
 ```
 1. Repeat these steps so that Docker is installed on each node that will eventually run the Rancher management server.

-> To find out whether a script is available for installing a certain Docker version, refer to this [GitHub repository,](https://github.com/rancher/install-docker) which contains all of Rancher’s Docker installation scripts.
+:::tip
+
+To find out whether a script is available for installing a certain Docker version, refer to this [GitHub repository,](https://github.com/rancher/install-docker) which contains all of Rancher’s Docker installation scripts.
+
+:::

 **Result:** You have set up Rancher server nodes that fulfill all the node requirements for OS, Docker, hardware and networking.

@@ -9,7 +9,11 @@ The recommended infrastructure for the Rancher-only Kubernetes cluster differs d

 For more information about each installation option, refer to [this page.]({{<baseurl>}}/rancher/v2.6/en/installation)

-> **Note:** These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+:::note Important:
+
+These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+
+:::

 To install the Rancher management server on a high-availability K3s cluster, we recommend setting up the following infrastructure:

@@ -53,8 +57,11 @@ For an example showing how to set up an NGINX load balancer, refer to [this page

 For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{<baseurl>}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/)

-> **Important:**
-> Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+:::caution
+
+Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+
+:::

 ### 4. Set up the DNS Record

@@ -5,7 +5,11 @@ weight: 2

 This tutorial is intended to help you create a high-availability RKE cluster that can be used to install a Rancher server.

-> **Note:** These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+:::note Important:
+
+These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+
+:::

 To install the Rancher management server on a high-availability RKE cluster, we recommend setting up the following infrastructure:

@@ -44,8 +48,11 @@ For an example showing how to set up an NGINX load balancer, refer to [this page

 For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{<baseurl>}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/)

-> **Important:**
-> Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+:::caution
+
+Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+
+:::

 ### 3. Set up the DNS Record

@@ -7,7 +7,11 @@ This tutorial is intended to help you provision the underlying infrastructure fo

 The recommended infrastructure for the Rancher-only Kubernetes cluster differs depending on whether Rancher will be installed on a RKE2 Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container.

-> **Note:** These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+:::note Important:
+
+These nodes must be in the same region. You may place these servers in separate availability zones (datacenter).
+
+::

 To install the Rancher management server on a high-availability RKE2 cluster, we recommend setting up the following infrastructure:

@@ -38,8 +42,11 @@ For an example showing how to set up an NGINX load balancer, refer to [this page

 For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{<baseurl>}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/)

-> **Important:**
-> Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+:::caution
+
+Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications.
+
+:::

 ### 4. Set up the DNS Record

@@ -7,7 +7,11 @@ NGINX will be configured as Layer 4 load balancer (TCP) that forwards connection

 In this configuration, the load balancer is positioned in front of your nodes. The load balancer can be any host capable of running NGINX.

-One caveat: do not use one of your Rancher nodes as the load balancer.
+:::note
+
+Do not use one of your Rancher nodes as the load balancer.
+
+:::

 > These examples show the load balancer being configured to direct traffic to three Rancher server nodes. If Rancher is installed on an RKE Kubernetes cluster, three nodes are required. If Rancher is installed on a K3s Kubernetes cluster, only two nodes are required.

@@ -25,7 +29,11 @@ After installing NGINX, you need to update the NGINX configuration file, `nginx.

 2.  From `nginx.conf`, replace both occurrences (port 80 and port 443) of `<IP_NODE_1>`, `<IP_NODE_2>`, and `<IP_NODE_3>` with the IPs of your nodes.

-    > **Note:** See [NGINX Documentation: TCP and UDP Load Balancing](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/) for all configuration options.
+    :::note
+    
+    See [NGINX Documentation: TCP and UDP Load Balancing](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/) for all configuration options.
+
+    :::

    <figcaption>Example NGINX config</figcaption>
    ```
@@ -36,7 +36,11 @@ Regardless of whether an NGINX Ingress or Traefik Ingress controller is used, th
 1. Select **Services** and choose **EC2**, find the section **Load Balancing** and open **Target Groups**.
 1. Click **Create target group** to create the first target group, regarding TCP port 443.

-> **Note:** Health checks are handled differently based on the Ingress. For details, refer to [this section.](#health-check-paths-for-nginx-ingress-and-traefik-ingresses)
+:::note
+
+Health checks are handled differently based on the Ingress. For details, refer to [this section.](#health-check-paths-for-nginx-ingress-and-traefik-ingresses)
+
+:::

 ### Target Group (TCP port 443)