Setting up Kubernetes Clusters in Rancher
Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case.
This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the concepts page.
For a conceptual overview of how the Rancher server provisions clusters and what tools it uses to provision them, refer to the architecture page.
Cluster Management Capabilities by Cluster Type
The following table summarizes the options and settings available for each cluster type:
|Action||Rancher Launched Kubernetes Clusters||EKS, GKE and AKS Clusters1||Other Hosted Kubernetes Clusters||Non-EKS or GKE Registered Clusters|
|Using kubectl and a kubeconfig file to Access a Cluster||✓||✓||✓||✓|
|Managing Cluster Members||✓||✓||✓||✓|
|Editing and Upgrading Clusters||✓||✓||✓||✓2|
|Managing Persistent Volumes and Storage Classes||✓||✓||✓||✓|
|Managing Projects, Namespaces and Workloads||✓||✓||✓||✓|
|Using App Catalogs||✓||✓||✓||✓|
|Configuring Tools (Alerts, Notifiers, Monitoring, Logging, Istio)||✓||✓||✓||✓|
|Running Security Scans||✓||✓||✓||✓|
|Ability to rotate certificates||✓||✓|
|Ability to backup and restore Rancher-launched clusters||✓||✓||✓4|
|Cleaning Kubernetes components when clusters are no longer reachable from Rancher||✓|
|Configuring Pod Security Policies||✓||✓|
Registered EKS, GKE and AKS clusters have the same options available as EKS, GKE and AKS clusters created from the Rancher UI. The difference is that when a registered cluster is deleted from the Rancher UI, it is not destroyed.
Cluster configuration options can't be edited for registered clusters, except for K3s and RKE2 clusters.
For registered cluster nodes, the Rancher UI exposes the ability to cordon, drain, and edit the node.
For registered clusters using etcd as a control plane, snapshots must be taken manually outside of the Rancher UI to use for backup and recovery.
Setting up Clusters in a Hosted Kubernetes Provider
In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service.
If you use a Kubernetes provider such as Google GKE, Rancher integrates with its cloud APIs, allowing you to create and manage role-based access control for the hosted cluster from the Rancher UI.
For more information, refer to the section on hosted Kubernetes clusters.
Launching Kubernetes with Rancher
Rancher uses the Rancher Kubernetes Engine (RKE) as a library when provisioning Kubernetes on your own nodes. RKE is Rancher’s own lightweight Kubernetes installer.
In RKE clusters, Rancher manages the deployment of Kubernetes. These clusters can be deployed on any bare metal server, cloud provider, or virtualization platform.
These nodes can be dynamically provisioned through Rancher's UI, which calls Docker Machine to launch nodes on various cloud providers.
If you already have a node that you want to add to an RKE cluster, you can add it to the cluster by running a Rancher agent container on it.
For more information, refer to the section on RKE clusters.
Launching Kubernetes and Provisioning Nodes in an Infrastructure Provider
Rancher can dynamically provision nodes in infrastructure providers such as Amazon EC2, DigitalOcean, Azure, or vSphere, then install Kubernetes on them.
Using Rancher, you can create pools of nodes based on a node template. This template defines the parameters used to launch nodes in your cloud providers.
One benefit of using nodes hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically replace it, thus maintaining the expected cluster configuration.
The cloud providers available for creating a node template are decided based on the node drivers active in the Rancher UI.
For more information, refer to the section on nodes hosted by an infrastructure provider
Launching Kubernetes on Existing Custom Nodes
When setting up this type of cluster, Rancher installs Kubernetes on existing custom nodes, which creates a custom cluster.
You can bring any nodes you want to Rancher and use them to create a cluster.
These nodes include on-prem bare metal servers, cloud-hosted virtual machines, or on-prem virtual machines.
Registering Existing Clusters
The cluster registration feature replaces the feature to import clusters.
Registering EKS clusters now provides additional benefits. For the most part, registered EKS clusters and EKS clusters created in Rancher are treated the same way in the Rancher UI, except for deletion.
When you delete an EKS cluster that was created in Rancher, the cluster is destroyed. When you delete an EKS cluster that was registered in Rancher, it is disconnected from the Rancher server, but it still exists and you can still access it in the same way you did before it was registered in Rancher.
For more information, see this page.
Programmatically Creating Clusters
The most common way to programmatically deploy Kubernetes clusters through Rancher is by using the Rancher2 Terraform provider. The documentation for creating clusters with Terraform is here.
EKS, GKE, AKS clusters and RKE clusters can be created or imported with Terraform.