RKE2 Cluster Configuration Reference (Tech Preview)
This section covers the configuration options that are available in Rancher for a new or existing RKE2 Kubernetes cluster.
Overview
You can configure the Kubernetes options one of two ways:
- Rancher UI: Use the Rancher UI to select options that are commonly customized when setting up a Kubernetes cluster.
- Cluster Config File: Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE2 config file. Using a config file allows you to set any of the options available in an RKE2 installation.
Configuration Options in the Rancher UI
> Some advanced configuration options are not exposed in the Rancher UI forms, but they can be enabled by editing the RKE2 cluster configuration file in YAML. For the complete reference of configurable options for RKE2 Kubernetes clusters in YAML, see the RKE2 documentation.
Basics#
Kubernetes Version#
The version of Kubernetes installed on your cluster nodes. Rancher packages its own version of Kubernetes based on hyperkube.
For more detail, see Upgrading Kubernetes.
Container Network Provider#
The Network Provider that the cluster uses.
> After you launch the cluster, you cannot change your network provider. Therefore, choose which network provider you want to use carefully, as Kubernetes doesn't allow switching between network providers. Once a cluster is created with a network provider, changing network providers would require you tear down the entire cluster and all its applications.
Out of the box, Rancher is compatible with the following network providers:
For more details on the different networking providers and how to configure them, please view our RKE2 documentation.
Cloud Provider#
You can configure a Kubernetes cloud provider. If you want to use dynamically provisioned volumes and storage in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the aws cloud provider.
>Note: If the cloud provider you want to use is not listed as an option, you will need to use the config file option to configure the cloud provider. Please reference this documentation on how to configure the cloud provider.
Default Pod Security Policy#
Choose the default pod security policy for the cluster. Please refer to the RKE2 documentation on the specifications of each available policy.
Worker CIS Profile#
Select a CIS benchmark to validate the system configuration against.
Project Network Isolation#
If your network provider allows project network isolation, you can choose whether to enable or disable inter-project communication.
Project network isolation is available if you are using any RKE2 network plugin that supports the enforcement of Kubernetes network policies, such as Canal.
SELinux#
Option to enable or disable SELinux support.
CoreDNS#
By default, CoreDNS is installed as the default DNS provider. If CoreDNS is not installed, an alternate DNS provider must be installed yourself. Refer to the RKE2 documentation for additional CoreDNS configurations.
NGINX Ingress#
If you want to publish your applications in a high-availability configuration, and you're hosting your nodes with a cloud-provider that doesn't have a native load-balancing feature, enable this option to use NGINX Ingress within the cluster. Refer to the RKE2 documentation for additional configuration options.
Refer to the RKE2 documentation for additional configuration options.
Metrics Server#
Option to enable or disable Metrics Server.
Each cloud provider capable of launching a cluster using RKE2 can collect metrics and monitor for your cluster nodes. Enable this option to view your node metrics from your cloud provider's portal.
Add-On Config#
Additional Kubernetes manifests, managed as a Add-on, to apply to the cluster on startup. Refer to the RKE2 documentation for details.
Agent Environment Vars#
Option to set environment variables for Rancher agents. The environment variables can be set using key value pairs. Refer to the RKE2 documentation for more details.
etcd#
Automatic Snapshots#
Option to enable or disable recurring etcd snapshots. If enabled, users have the option to configure the frequency of snapshots. For details, refer to the RKE2 documentation.
Metrics#
Option to choose whether to expose etcd metrics to the public or only within the cluster.
Networking#
Cluster CIDR#
IPv4/IPv6 network CIDRs to use for pod IPs (default: 10.42.0.0/16).
Service CIDR#
IPv4/IPv6 network CIDRs to use for service IPs (default: 10.43.0.0/16).
Cluster DNS#
IPv4 Cluster IP for coredns service. Should be in your service-cidr range (default: 10.43.0.10).
Cluster Domain#
Select the domain for the cluster. The default is cluster.local.
NodePort Service Port Range#
Option to change the range of ports that can be used for NodePort services. The default is 30000-32767.
TLS Alternate Names#
Add additional hostnames or IPv4/IPv6 addresses as Subject Alternative Names on the server TLS cert.
Authorized Cluster Endpoint#
Authorized Cluster Endpoint can be used to directly access the Kubernetes API server, without requiring communication through Rancher.
This is enabled by default in Rancher-launched Kubernetes clusters, using the IP of the node with the controlplane role and the default Kubernetes self signed certificates.
For more detail on how an authorized cluster endpoint works and why it is used, refer to the architecture section.
We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the recommended architecture section.
Registries#
Select the image repository to pull Rancher images from. For more details and configuration options, see the RKE2 documentation.
Upgrade Strategy#
Controle Plane Concurrency#
Select how many nodes can be upgraded at the same time. Can be a fixed number or percentage.
Worker Concurrency#
Select how many nodes can be upgraded at the same time. Can be a fixed number or percentage.
Drain Nodes (Control Plane)#
Option to remove all pods from the node prior to upgrading.
Drain Nodes (Worker Nodes)#
Option to remove all pods from the node prior to upgrading.
Advanced#
Option to set kubelet options for different nodes. For available options, refer to the Kubernetes documentation.
Cluster Config File
Instead of using the Rancher UI forms to choose Kubernetes options for the cluster, advanced users can create an RKE2 config file. Using a config file allows you to set any of the options available in an RKE2 installation.
To edit an RKE2 config file directly from the Rancher UI, click Edit as YAML.