Installation Requirements

If you install Rancher on a hardened Kubernetes cluster, check the Exempting Required Rancher Namespaces section for detailed requirements.

RKE2 bundles its own container runtime, containerd. Docker is not required for RKE2 installs.

For details on which OS versions were tested with RKE2, refer to the Rancher support matrix.

For the container runtime, K3s bundles its own containerd by default. Alternatively, you can configure K3s to use an already installed Docker runtime. For more information on using K3s with Docker see the K3s documentation.

Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the Rancher support matrix. To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script.

If you are installing Rancher on a K3s cluster with Raspbian Buster, follow these steps to switch to legacy iptables.

If you are installing Rancher on a K3s cluster with Alpine Linux, follow these steps for additional setup.

RKE requires a Docker container runtime. Supported Docker versions are specified in the Support Matrix page.

For more information, see Installing Docker.

Rancher’s hardware footprint depends on a number of factors, including:

Since there are a high number of influencing factors that may vary over time, the requirements listed here should be understood as reasonable starting points that work well for most use cases. Nevertheless, your use case may have different requirements. For inquiries about a specific scenario please contact Rancher for further guidance.

In particular, requirements on this page are subject to typical use assumptions, which include:

Higher numbers are possible but requirements might be higher. If you have more than 20,000 resources of the same type, loading time of the whole list through the Rancher UI might take several seconds.

The following table lists minimum CPU and memory requirements for each node in the upstream cluster.

Please note that a highly available setup with at least three nodes is required for production.

(*): Large deployments require that you follow best practices for adequate performance.

(†): Larger deployment sizes are generally possible with ad-hoc hardware recommendations and tuning. You can contact Rancher for a custom evaluation.

Refer to RKE2 documentation for more detailed information on RKE2 general requirements.

The following table lists minimum CPU and memory requirements for each node in the upstream cluster.

Please note that a highly available setup with at least three nodes is required for production.

(*): External Database Host refers to hosting the K3s cluster data store on an dedicated external host. This is optional. Exact requirements depend on the external data store.

(†): Large deployments require that you follow best practices for adequate performance.

Refer to the K3s documentation for more detailed information on general requirements.

The following table lists minimum CPU and memory requirements for each node in the upstream cluster.

Please note that a highly available setup with at least three nodes is required for production.

These requirements apply to hosted Kubernetes clusters such as Amazon Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), or Google Kubernetes Engine (GKE). They don’t apply to Rancher SaaS solutions such as Rancher Prime Hosted.

(*): Large deployments require that you follow best practices for adequate performance.

The following table lists minimum CPU and memory requirements for each node in the upstream cluster.

Please note that a highly available setup with at least three nodes is required for production.

(*): Large deployments require that you follow best practices for adequate performance.

Refer to the RKE documentation for more detailed information on general requirements.

The following table lists minimum CPU and memory requirements for a xref:[single Docker node installation of Rancher].

Please note that a Docker installation is only suitable for development or testing purposes and is not meant to be used in production environments.

Each node used should have a static IP configured, regardless of whether you are installing Rancher on a single node or on an HA cluster. In case of DHCP, each node should have a DHCP reservation to make sure the node gets the same IP allocated.

To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. Port Requirements lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types.

If you use a load balancer, it should be be HTTP/2 compatible.

To receive help from SUSE Support, Rancher Prime customers who use load balancers (or any other middleboxes such as firewalls), must use one that is HTTP/2 compatible.

When HTTP/2 is not available, Rancher falls back to HTTP/1.1. However, since HTTP/2 offers improved web application performance, using HTTP/1.1 can create performance issues.