Merge pull request #4290 from twz123/keepalived-enabled

Introduce controlPlaneLoadBalancing.enabled

Author: twz123

cmd/controller/controller.go

@@ -228,11 +228,14 @@ func (c *command) start(ctx context.Context) error {
 		nodeComponents.Add(ctx, controllerLeaseCounter)
 	}
 
-	enableCPLB := !c.SingleNode && !slices.Contains(c.DisableComponents, constant.CPLBComponentName)
-	if enableCPLB {
+	if cplb := nodeConfig.Spec.Network.ControlPlaneLoadBalancing; cplb != nil && cplb.Enabled {
+		if c.SingleNode {
+			return errors.New("control plane load balancing cannot be used in a single-node cluster")
+		}
+
 		nodeComponents.Add(ctx, &controller.Keepalived{
 			K0sVars:         c.K0sVars,
-			Config:          nodeConfig.Spec.Network.ControlPlaneLoadBalancing,
+			Config:          cplb,
 			DetailedLogging: c.Debug,
 		})
 	}

docs/configuration.md

@@ -304,9 +304,10 @@ node-local load balancing.
 
 Configuration options related to k0s's [control plane load balancing] feature
 
-| Element         | Description                                                                                                |
-| --------------- | ---------------------------------------------------------------------------------------------------------- |
-| `vrrpInstances` | Configuration options related to the VRRP. This is an array which allows to configure multiple virtual IPs |
+| Element         | Description                                                                                                 |
+| --------------- | ----------------------------------------------------------------------------------------------------------- |
+| `enabled`       | Indicates if control plane load balancing should be enabled. Default: `false`.                              |
+| `vrrpInstances` | Configuration options related to the VRRP. This is an array which allows to configure multiple virtual IPs. |
 
 [control plane load balancing]: cplb.md
 
@@ -316,7 +317,7 @@ Configuration options required for using VRRP to configure VIPs in control plane
 
 | Element           | Description                                                                                                       |
 | ----------------- | ----------------------------------------------------------------------------------------------------------------- |
-| `name`            | The name of the VRRP instance. If omitted it generates a predictive name shared across all nodes.                |
+| `name`            | The name of the VRRP instance. If omitted it generates a predictive name shared across all nodes.                 |
 | `virtualIPs`      | A list of the CIDRs handled by the VRRP instance.                                                                 |
 | `interface`       | The interface used by each VRRPInstance. If undefined k0s will try to auto detect it based on the default gateway |
 | `virtualRouterId` | Virtual router ID for the instance. Default: `51`                                                                 |

docs/cplb.md

@@ -55,6 +55,7 @@ spec:
     externalAddress: <External address> # This isn't a requirement, but it's a common use case.
   network:
     controlPlaneLoadBalancing:
+      enabled: true
       vrrpInstances:
       - virtualIPs: ["<External address IP>/<external address IP netmask"]
         authPass: <password>
@@ -72,6 +73,7 @@ spec:
           externalAddress: <External address> # This isn't a requirement, but it's a common use case.
         network:
           controlPlaneLoadBalancing:
+            enabled: true
             vrrpInstances:
             - virtualIPs: ["<External address IP>/<external address IP netmask>"]
               authPass: <password>
@@ -143,6 +145,7 @@ spec:
           externalAddress: 192.168.122.200
         network:
           controlPlaneLoadBalancing:
+            enabled: true
             vrrpInstances:
             - virtualIPs: ["192.168.122.200/24"]
               authPass: Example
@@ -274,9 +277,9 @@ All three worker nodes are ready:
 ```console
 $ kubectl get nodes
 NAME                   STATUS   ROLES           AGE     VERSION
-worker-0.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
-worker-1.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
-worker-2.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
+worker-0.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
+worker-1.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
+worker-2.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
 ```
 
 Each controller node has a dummy interface with the VIP and /32 netmask,
@@ -323,7 +326,7 @@ And the cluster will be working normally:
 ```console
 $ kubectl get nodes
 NAME                   STATUS   ROLES           AGE     VERSION
-worker-0.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
-worker-1.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
-worker-2.k0s.lab       Ready    <none>          8m51s   v1.29.2+k0s
-```
+worker-0.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
+worker-1.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
+worker-2.k0s.lab       Ready    <none>          8m51s   v{{{ extra.k8s_version }}}+k0s
+```

inttest/cplb/cplb_test.go

@@ -37,6 +37,7 @@ spec:
     externalAddress: %s
   network:
     controlPlaneLoadBalancing:
+      enabled: true
       vrrpInstances:
       - virtualIPs: ["%s/24"]
         authPass: "123456"

pkg/apis/k0s/v1beta1/cplb.go

@@ -29,6 +29,13 @@ const defaultAdvertInterval = 1
 // ControlPlaneLoadBalancingSpec defines the configuration options related to k0s's
 // keepalived feature.
 type ControlPlaneLoadBalancingSpec struct {
+	// Indicates if control plane load balancing should be enabled.
+	// Default: false
+	// +optional
+	Enabled bool `json:"enabled,omitempty"`
+
+	// Configuration options related to the VRRP. This is an array which allows
+	// to configure multiple virtual IPs.
 	VRRPInstances VRRPInstances `json:"vrrpInstances,omitempty"`
 }
 

pkg/constant/constant.go

@@ -110,7 +110,6 @@ const (
 	CoreDNSComponentname               = "coredns"
 	CsrApproverComponentName           = "csr-approver"
 	HelmComponentName                  = "helm"
-	CPLBComponentName                  = "cplb"
 	KonnectivityServerComponentName    = "konnectivity-server"
 	KubeControllerManagerComponentName = "kube-controller-manager"
 	KubeProxyComponentName             = "kube-proxy"

static/manifests/v1beta1/CustomResourceDefinition/k0s.k0sproject.io_clusterconfigs.yaml

@@ -367,8 +367,15 @@ spec:
                       ControlPlaneLoadBalancing defines the configuration options related to k0s's
                       control plane load balancing feature.
                     properties:
+                      enabled:
+                        description: |-
+                          Indicates if control plane load balancing should be enabled.
+                          Default: false
+                        type: boolean
                       vrrpInstances:
-                        description: VRRPInstances is a list of VRRPInstance
+                        description: |-
+                          Configuration options related to the VRRP. This is an array which allows
+                          to configure multiple virtual IPs.
                         items:
                           description: VRRPInstance defines the configuration options
                             for a VRRP instance.