diff --git a/content/rancher/v2.x/en/overview/architecture/_index.md b/content/rancher/v2.x/en/overview/architecture/_index.md index a0f96765f89..6b12d1621c4 100644 --- a/content/rancher/v2.x/en/overview/architecture/_index.md +++ b/content/rancher/v2.x/en/overview/architecture/_index.md @@ -39,6 +39,22 @@ The figure below illustrates the high-level architecture of Rancher 2.x. The fig In this section we describe the functionalities of each Rancher server components. +#### Single Node and High-Availability Installations of Rancher + +You can install Rancher on a single node, or on a high-availability Kubernetes cluster. + +A single-node installation is recommended for development and testing purposes, and a high-availability installation is recommended for production. + +In a single-node installation of Rancher, the node running the Rancher server should be separate from your Kubernetes clusters. + +In high-availability installations of Rancher, it is important to note the following: + +- The Rancher server cluster should be separate from user clusters. A user cluster is a Kubernetes cluster that runs your apps and services. +- The Rancher server cluster and user clusters have separate requirements for hardware and networking. The requirements for the Rancher server can be found [here]({{}}/rancher/v2.x/en/installation/requirements) and the requirements for user clusters can be found [here.]({{}}/rancher/v2.x/en/cluster-provisioning/requirements}) +- We recommend installing Rancher on a Kubernetes cluster in which each node has all three Kubernetes roles: etcd, controlplane, and worker. However, when you set up the clusters that run your apps and services, we recommend that each node in the cluster should have a single role for stability and scalability. For details on the recommended best practices for user clusters, refer to the [production checklist]({{}}/rancher/v2.x/en/cluster-provisioning/production) or our [best practices guide.]({{}}/rancher/v2.x/en/best-practices/management/#tips-for-scaling-and-reliability) + +![Single Node vs. High-Availability Architecture]({{}}/img/rancher/rancher-single-node-and-ha-installations.svg) + #### Rancher API Server Rancher API server is built on top of an embedded Kubernetes API server and etcd database. It implements the following functionalities: @@ -51,11 +67,11 @@ Rancher API server is built on top of an embedded Kubernetes API server and etcd Rancher API server manages access control and security policies. -- **Projects** +- **Managing Projects** A _project_ is a group of multiple namespaces and access control policies within a cluster. -- **Nodes** +- **Tracking Nodes** Rancher API server tracks identities of all the nodes in all clusters. diff --git a/static/img/rancher/rancher-single-node-and-ha-installations.svg b/static/img/rancher/rancher-single-node-and-ha-installations.svg new file mode 100644 index 00000000000..ab321de6c40 --- /dev/null +++ b/static/img/rancher/rancher-single-node-and-ha-installations.svg @@ -0,0 +1,3 @@ + + +
Example User Kubernetes Cluster
<font style="font-size: 16px">Example User Kubernetes Cluster<br></font>
Single Node Installation of Rancher
<font style="font-size: 20px">Single Node Installation of Rancher</font>
High-Availability Installation of Rancher
<font style="font-size: 20px">High-Availability Installation of Rancher</font>
Rancher Server
[Not supported by viewer]
Load Balancer
[Not supported by viewer]
Rancher Users
Rancher Users
Kubernetes Master
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Node
etcd Node
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
Worker Node
Worker Node
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
Control-
plane Node
[Not supported by viewer]
Kubelet
[Not supported by viewer]
Rancher Users
Rancher Users
Rancher Server Cluster
<font style="font-size: 16px">Rancher Server Cluster<br></font>
Kubernetes Master
[Not supported by viewer]
Kubelet
[Not supported by viewer]
Kubelet
[Not supported by viewer]
etcd, Worker,
and
Controlplane
node
[Not supported by viewer]
etcd, Worker,
and
Controlplane
node
[Not supported by viewer]
Kubelet
[Not supported by viewer]
etcd, Worker,
and
Controlplane
node
[Not supported by viewer]
Example User Cluster
<font style="font-size: 16px">Example User Cluster<br></font>
Kubernetes Master
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Node
etcd Node
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
Worker Node
Worker Node
Kubelet
[Not supported by viewer]
etcd Nodes
etcd Nodes
Kubelet
[Not supported by viewer]
Control-
plane Node
[Not supported by viewer]
Kubelet
[Not supported by viewer]
\ No newline at end of file