SUSE® Rancher Prime RKE2 Hardening Guides
This document provides prescriptive guidance for how to harden an RKE2 cluster intended for production, before provisioning it with Rancher. It outlines the configurations and controls required for Center for Information Security (CIS) Kubernetes benchmark controls.
This hardening guide describes how to secure the nodes in your cluster. We recommended that you follow this guide before you install Kubernetes. |
This hardening guide is intended to be used for RKE2 clusters and is associated with the following versions of the CIS Kubernetes Benchmark, Kubernetes, and Rancher:
Rancher Version | CIS Benchmark Version | Kubernetes Version |
---|---|---|
Rancher v2.7 |
Benchmark v1.23 |
Kubernetes v1.23 |
Rancher v2.7 |
Benchmark v1.24 |
Kubernetes v1.24 |
Rancher v2.7 |
Benchmark v1.7 |
Kubernetes v1.25 up to v1.26 |
|
For more details on how to evaluate a hardened RKE2 cluster against the official CIS benchmark, refer to the RKE2 self-assessment guides for specific Kubernetes and CIS benchmark versions.
RKE2 passes a number of the Kubernetes CIS controls without modification, as it applies several security mitigations by default. There are some notable exceptions to this that require manual intervention to fully comply with the CIS Benchmark:
-
RKE2 will not modify the host operating system. Therefore, you, the operator, must make a few host-level modifications.
-
Certain CIS controls for Network Policies and Pod Security Standards (or Pod Security Policies (PSP) on RKE2 versions prior to v1.25) will restrict the functionality of the cluster. You must opt into having RKE2 configure these for you. To help ensure these requirements are met, RKE2 can be started with the profile flag set to
cis-1.23
for v1.25 and newer orcis-1.6
for v1.24 and older.
Host-level requirements
There are two areas of host-level requirements: kernel parameters and etcd process/directory configuration. These are outlined in this section.
Ensure protect-kernel-defaults
is set
-
v1.25 and Newer
-
v1.24 and Older
The protect-kernel-defaults
is no longer required since CIS benchmark 1.7.
This is a kubelet flag that will cause the kubelet to exit if the required kernel parameters are unset or are set to values that are different from the kubelet’s defaults.
The protect-kernel-defaults
flag can be set in the cluster configuration in Rancher.
spec:
rkeConfig:
machineSelectorConfig:
- config:
protect-kernel-defaults: true
Set kernel parameters
The following sysctl
configuration is recommended for all nodes type in the cluster. Set the following parameters in /etc/sysctl.d/90-kubelet.conf
:
vm.panic_on_oom=0
vm.overcommit_memory=1
kernel.panic=10
kernel.panic_on_oops=1
Run sudo sysctl -p /etc/sysctl.d/90-kubelet.conf
to enable the settings.
Ensure etcd is configured properly
The CIS Benchmark requires that the etcd data directory be owned by the etcd
user and group. This implicitly requires the etcd process run as the host-level etcd
user. To achieve this, RKE2 takes several steps when started with a valid cis-1.xx
profile:
-
Check that the
etcd
user and group exists on the host. If they don’t, exit with an error. -
Create etcd’s data directory with
etcd
as the user and group owner. -
Ensure the etcd process is ran as the
etcd
user and group by setting the etcd static pod’sSecurityContext
appropriately.
To meet the above requirements, you must:
Kubernetes runtime requirements
The runtime requirements to pass the CIS Benchmark are centered around pod security, network policies and kernel parameters. Most of this is automatically handled by RKE2 when using a valid cis-1.xx
profile, but some additional operator intervention is required. These are outlined in this section.
PodSecurity
RKE2 always runs with some amount of pod security.
-
v1.25 and Newer
-
v1.24 and Older
On v1.25 and newer, Pod Security Admissions (PSAs) are used for pod security.
Below is the minimum necessary configuration needed for hardening RKE2 to pass CIS v1.23 hardened profile rke2-cis-1.7-hardened
available in Rancher.
spec:
defaultPodSecurityAdmissionConfigurationTemplateName: rancher-restricted
rkeConfig:
machineSelectorConfig:
- config:
profile: cis-1.23
When both the defaultPodSecurityAdmissionConfigurationTemplateName
and profile
flags are set, Rancher and RKE2 does the following:
-
Checks that host-level requirements have been met. If they haven’t, RKE2 will exit with a fatal error describing the unmet requirements.
-
Applies network policies that allow the cluster to pass associated controls.
-
Configures the Pod Security Admission Controller with the PSA configuration template
rancher-restricted
, to enforce restricted mode in all namespaces, except the ones in the template’s exemption list. These namespaces are exempted to allow system pods to run without restrictions, which is required for proper operation of the cluster.
If you intend to import an RKE cluster into Rancher, please consult the documentation for how to configure the PSA to exempt Rancher system namespaces. |
On Kubernetes v1.24 and older, the PodSecurityPolicy
admission controller is always enabled.
Below is the minimum necessary configuration needed for hardening RKE2 to pass CIS v1.23 hardened profile rke2-cis-1.23-hardened
available in Rancher.
In the following example the profile is set to |
spec:
defaultPodSecurityPolicyTemplateName: restricted-noroot
rkeConfig:
machineSelectorConfig:
- config:
profile: cis-1.6
When both the defaultPodSecurityPolicyTemplateName
and profile
flags are set, Rancher and RKE2 does the following:
-
Checks that host-level requirements have been met. If they haven’t, RKE2 will exit with a fatal error describing the unmet requirements.
-
Applies network policies that allow the cluster to pass associated controls.
-
Configures runtime pod security policies that allow the cluster to pass associated controls.
The Kubernetes control plane components and critical additions such as CNI, DNS, and Ingress are ran as pods in the |
NetworkPolicies
When ran with a valid cis-1.xx
profile, RKE2 will put NetworkPolicies
in place that passes the CIS Benchmark for Kubernetes' built-in namespaces. These namespaces are: kube-system
, kube-public
, kube-node-lease
, and default
.
The NetworkPolicy
used will only allow pods within the same namespace to talk to each other. The notable exception to this is that it allows DNS requests to be resolved.
Operators must manage network policies as normal for additional namespaces that are created. |
Configure default
service account
Set automountServiceAccountToken
to false
for default
service accounts
Kubernetes provides a default
service account which is used by cluster workloads where no specific service account is assigned to the pod. Where access to the Kubernetes API from a pod is required, a specific service account should be created for that pod, and rights granted to that service account. The default
service account should be configured such that it does not provide a service account token and does not have any explicit rights assignments.
For each namespace including default
and kube-system
on a standard RKE2 install, the default
service account must include this value:
automountServiceAccountToken: false
For namespaces created by the cluster operator, the following script and configuration file can be used to configure the default
service account.
The configuration bellow must be saved to a file called account_update.yaml
.
apiVersion: v1
kind: ServiceAccount
metadata:
name: default
automountServiceAccountToken: false
Create a bash script file called account_update.sh
. Be sure to sudo chmod +x account_update.sh
so the script has execute permissions.
#!/bin/bash -e
for namespace in $(kubectl get namespaces -A -o=jsonpath="{.items[*]['metadata.name']}"); do
echo -n "Patching namespace $namespace - "
kubectl patch serviceaccount default -n ${namespace} -p "$(cat account_update.yaml)"
done
Execute this script to apply the account_update.yaml
configuration to default
service account in all namespaces.
API Server audit configuration
CIS requirements 1.2.19 to 1.2.22 are related to configuring audit logs for the API Server. When RKE2 is started with the profile
flag set, it will automatically configure hardened --audit-log-
parameters in the API Server to pass those CIS checks.
RKE2’s default audit policy is configured to not log requests in the API Server. This is done to allow cluster operators flexibility to customize an audit policy that suits their auditing requirements and needs, as these are specific to each users' environment and policies.
A default audit policy is created by RKE2 when started with the profile
flag set. The policy is defined in /etc/rancher/rke2/audit-policy.yaml
.
apiVersion: audit.k8s.io/v1
kind: Policy
metadata:
creationTimestamp: null
rules:
- level: None
Reference Hardened SUSE® Rancher Prime RKE2 Template Configuration
The reference template configuration is used in Rancher to create a hardened RKE2 custom cluster. This reference does not include other required cluster configuration directives which will vary depending on your environment.
-
v1.25 and Newer
-
v1.24 and Older
apiVersion: provisioning.cattle.io/v1
kind: Cluster
metadata:
name: # Define cluster name
spec:
defaultPodSecurityAdmissionConfigurationTemplateName: rancher-restricted
kubernetesVersion: # Define RKE2 version
rkeConfig:
machineSelectorConfig:
- config:
profile: cis-1.23
apiVersion: provisioning.cattle.io/v1
kind: Cluster
metadata:
name: # Define cluster name
spec:
defaultPodSecurityPolicyTemplateName: restricted-noroot
kubernetesVersion: # Define RKE2 version
rkeConfig:
machineSelectorConfig:
- config:
profile: cis-1.6
protect-kernel-defaults: true