feat: Virtual IP configuration to set different address/port

api/v1alpha1/common_types.go

@@ -47,6 +47,25 @@ type ControlPlaneVirtualIPSpec struct {
 	// +kubebuilder:validation:Enum=KubeVIP
 	// +kubebuilder:default=KubeVIP
 	Provider string `json:"provider,omitempty"`
+
+	// Configuration for the chosen control-plane virtual IP provider.
+	// +kubebuilder:validation:Optional
+	Configuration *ControlPlaneVirtualIPConfiguration `json:"configuration,omitempty"`
+}
+
+type ControlPlaneVirtualIPConfiguration struct {
+	// The virtual IP on which the API server is serving.
+	// If left empty, the value from controlPlaneEndpoint.host will be used.
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:validation:Format=ipv4
+	Address string `json:"address,omitempty"`
+
+	// The port on which the API server is serving.
+	// If left empty, the value from controlPlaneEndpoint.port will be used.
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	Port int32 `json:"port,omitempty"`
 }
 
 // LocalObjectReference contains enough information to let you locate the

api/v1alpha1/crds/caren.nutanix.com_nutanixclusterconfigs.yaml

@@ -598,6 +598,24 @@ spec:
                         virtualIP:
                           description: Configuration for the virtual IP provider.
                           properties:
+                            configuration:
+                              description: Configuration for the chosen control-plane virtual IP provider.
+                              properties:
+                                address:
+                                  description: |-
+                                    The virtual IP on which the API server is serving.
+                                    If left empty, the value from controlPlaneEndpoint.host will be used.
+                                  format: ipv4
+                                  type: string
+                                port:
+                                  description: |-
+                                    The port on which the API server is serving.
+                                    If left empty, the value from controlPlaneEndpoint.port will be used.
+                                  format: int32
+                                  maximum: 65535
+                                  minimum: 1
+                                  type: integer
+                              type: object
                             provider:
                               default: KubeVIP
                               description: Virtual IP provider to deploy.

charts/cluster-api-runtime-extensions-nutanix/templates/virtual-ip/kube-vip/manifests/kube-vip-configmap.yaml

@@ -22,7 +22,7 @@ data:
             - name: vip_arp
               value: "true"
             - name: port
-              value: '{{ `{{ .ControlPlaneEndpoint.Port }}` }}'
+              value: '{{ `{{ .Port }}` }}'
             - name: vip_nodename
               valueFrom:
                 fieldRef:
@@ -46,7 +46,7 @@ data:
             - name: vip_retryperiod
               value: "2"
             - name: address
-              value: '{{ `{{ .ControlPlaneEndpoint.Host }}` }}'
+              value: '{{ `{{ .Address }}` }}'
             - name: prometheus_server
           image: ghcr.io/kube-vip/kube-vip:v0.8.3
           imagePullPolicy: IfNotPresent

docs/content/customization/nutanix/control-plane-endpoint.md

@@ -2,7 +2,7 @@
 title = "Control Plane Endpoint"
 +++
 
-Configure Control Plane Endpoint. Defines the host IP and port of the CAPX Kubernetes cluster.
+Configure Control Plane Endpoint. Defines the host IP and port of the Nutanix Kubernetes cluster.
 
 ## Examples
 
@@ -51,6 +51,93 @@ spec:
             name: kube-vip
             namespace: kube-system
           spec:
+            containers:
+            - name: kube-vip
+              args:
+              - manager
+              env:
+              - name: port
+                value: '6443'
+              - name: address
+                value: 'x.x.x.x'
+          ...
+        owner: root:root
+        path: /etc/kubernetes/manifests/kube-vip.yaml
+        permissions: "0600"
+      postKubeadmCommands:
+        # Only added for clusters version >=v1.29.0
+        - |-
+          if [ -f /run/kubeadm/kubeadm.yaml ]; then
+            sed -i 's#path: /etc/kubernetes/super-admin.conf#path: ...
+          fi
+      preKubeadmCommands:
+        # Only added for clusters version >=v1.29.0
+        - |-
+          if [ -f /run/kubeadm/kubeadm.yaml ]; then
+            sed -i 's#path: /etc/kubernetes/admin.conf#path: ...
+          fi
+```
+
+### Set Control Plane Endpoint and a Different Virtual IP
+
+It is also possible to set a separate virtual IP to be used by kube-vip from the control plane endpoint.
+This is useful in VPC setups or other instances
+when you have an external floating IP already associated with the virtual IP.
+
+```yaml
+apiVersion: cluster.x-k8s.io/v1beta1
+kind: Cluster
+metadata:
+  name: <NAME>
+spec:
+  topology:
+    variables:
+      - name: clusterConfig
+        value:
+          nutanix:
+            controlPlaneEndpoint:
+              host: x.x.x.x
+              port: 6443
+              virtualIP:
+                configuration:
+                  address: y.y.y.y
+```
+
+Applying this configuration will result in the following value being set:
+
+- `NutanixCluster`:
+
+```yaml
+spec:
+  template:
+    spec:
+      controlPlaneEndpoint:
+        host: x.x.x.x
+        port: 6443
+```
+
+- `KubeadmControlPlaneTemplate`
+
+```yaml
+  spec:
+    kubeadmConfigSpec:
+      files:
+      - content: |
+          apiVersion: v1
+          kind: Pod
+          metadata:
+            name: kube-vip
+            namespace: kube-system
+          spec:
+            containers:
+            - name: kube-vip
+              args:
+              - manager
+              env:
+              - name: port
+                value: '6443'
+              - name: address
+                value: 'y.y.y.y'
           ...
         owner: root:root
         path: /etc/kubernetes/manifests/kube-vip.yaml

hack/addons/update-kube-vip-manifests.sh

@@ -33,8 +33,8 @@ docker container run --rm ghcr.io/kube-vip/kube-vip:"${KUBE_VIP_VERSION}" \
   gojq --yaml-input --yaml-output \
     'del(.metadata.creationTimestamp, .status) |
      .spec.containers[].imagePullPolicy |= "IfNotPresent" |
-     (.spec.containers[0].env[] | select(.name == "port").value) |= "{{ `{{ .ControlPlaneEndpoint.Port }}` }}" |
-     (.spec.containers[0].env[] | select(.name == "address").value) |= "{{ `{{ .ControlPlaneEndpoint.Host }}` }}"
+     (.spec.containers[0].env[] | select(.name == "port").value) |= "{{ `{{ .Port }}` }}" |
+     (.spec.containers[0].env[] | select(.name == "address").value) |= "{{ `{{ .Address }}` }}"
     ' >"${ASSETS_DIR}/${FILE_NAME}"
 
 kubectl create configmap "{{ .Values.hooks.virtualIP.kubeVip.defaultTemplateConfigMap.name }}" --dry-run=client --output yaml \

pkg/handlers/generic/mutation/controlplanevirtualip/inject_test.go

@@ -264,7 +264,7 @@ spec:
         - name: vip_arp
           value: "true"
         - name: address
-          value: "{{ .ControlPlaneEndpoint.Host }}"
+          value: "{{ .Address }}"
         - name: port
-          value: "{{ .ControlPlaneEndpoint.Port }}"
+          value: "{{ .Port }}"
 `

pkg/handlers/generic/mutation/controlplanevirtualip/providers/kubevip_test.go

@@ -105,6 +105,79 @@ func Test_GenerateFilesAndCommands(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "should return templated data with both IP and port from virtual IP configuration overrides",
+			controlPlaneEndpointSpec: v1alpha1.ControlPlaneEndpointSpec{
+				Host: "10.20.100.10",
+				Port: 6443,
+				VirtualIPSpec: &v1alpha1.ControlPlaneVirtualIPSpec{
+					Configuration: &v1alpha1.ControlPlaneVirtualIPConfiguration{
+						Address: "172.20.100.10",
+						Port:    8443,
+					},
+				},
+			},
+			configMap: &corev1.ConfigMap{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "default-kube-vip-template",
+					Namespace: "default",
+				},
+				Data: map[string]string{
+					"data": validKubeVIPTemplate,
+				},
+			},
+			cluster: &clusterv1.Cluster{
+				Spec: clusterv1.ClusterSpec{
+					Topology: &clusterv1.Topology{
+						Version: "v1.28.0",
+					},
+				},
+			},
+			expectedFiles: []bootstrapv1.File{
+				{
+					Content:     expectedKubeVIPPodWithOverrides,
+					Owner:       kubeVIPFileOwner,
+					Path:        kubeVIPFilePath,
+					Permissions: kubeVIPFilePermissions,
+				},
+			},
+		},
+		{
+			name: "should return templated data with IP from virtual IP configuration overrides",
+			controlPlaneEndpointSpec: v1alpha1.ControlPlaneEndpointSpec{
+				Host: "10.20.100.10",
+				Port: 8443,
+				VirtualIPSpec: &v1alpha1.ControlPlaneVirtualIPSpec{
+					Configuration: &v1alpha1.ControlPlaneVirtualIPConfiguration{
+						Address: "172.20.100.10",
+					},
+				},
+			},
+			configMap: &corev1.ConfigMap{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "default-kube-vip-template",
+					Namespace: "default",
+				},
+				Data: map[string]string{
+					"data": validKubeVIPTemplate,
+				},
+			},
+			cluster: &clusterv1.Cluster{
+				Spec: clusterv1.ClusterSpec{
+					Topology: &clusterv1.Topology{
+						Version: "v1.28.0",
+					},
+				},
+			},
+			expectedFiles: []bootstrapv1.File{
+				{
+					Content:     expectedKubeVIPPodWithOverrides,
+					Owner:       kubeVIPFileOwner,
+					Path:        kubeVIPFilePath,
+					Permissions: kubeVIPFilePermissions,
+				},
+			},
+		},
 	}
 
 	for idx := range tests {
@@ -227,9 +300,9 @@ spec:
         - name: vip_arp
           value: "true"
         - name: address
-          value: "{{ .ControlPlaneEndpoint.Host }}"
+          value: "{{ .Address }}"
         - name: port
-          value: "{{ .ControlPlaneEndpoint.Port }}"
+          value: "{{ .Port }}"
 `
 
 	expectedKubeVIPPod = `
@@ -253,4 +326,26 @@ spec:
         - name: port
           value: "6443"
 `
+
+	expectedKubeVIPPodWithOverrides = `
+apiVersion: v1
+kind: Pod
+metadata:
+  name: kube-vip
+  namespace: kube-system
+spec:
+  containers:
+    - name: kube-vip
+      image: ghcr.io/kube-vip/kube-vip:v1.1.1
+      imagePullPolicy: IfNotPresent
+      args:
+        - manager
+      env:
+        - name: vip_arp
+          value: "true"
+        - name: address
+          value: "172.20.100.10"
+        - name: port
+          value: "8443"
+`
 )

pkg/handlers/generic/mutation/controlplanevirtualip/providers/providers.go

@@ -5,6 +5,7 @@ package providers
 
 import (
 	"bytes"
+	"cmp"
 	"context"
 	"fmt"
 	"text/template"
@@ -35,11 +36,20 @@ func templateValues(
 	}
 
 	type input struct {
-		ControlPlaneEndpoint v1alpha1.ControlPlaneEndpointSpec
+		Address string
+		Port    int32
 	}
 
+	// If specified, use the virtual IP address and/or port,
+	// otherwise fall back to the control plane endpoint host and port.
+	var virtualIPConfig v1alpha1.ControlPlaneVirtualIPConfiguration
+	if controlPlaneEndpoint.VirtualIPSpec != nil &&
+		controlPlaneEndpoint.VirtualIPSpec.Configuration != nil {
+		virtualIPConfig = *controlPlaneEndpoint.VirtualIPSpec.Configuration
+	}
 	templateInput := input{
-		ControlPlaneEndpoint: controlPlaneEndpoint,
+		Address: cmp.Or(virtualIPConfig.Address, controlPlaneEndpoint.Host),
+		Port:    cmp.Or(virtualIPConfig.Port, controlPlaneEndpoint.Port),
 	}
 
 	var b bytes.Buffer