cluster: support setting externalTrafficPolicy for svc

clwluvw · clwluvw · commit 50dccea0f24a · 2025-11-17T19:02:14.000+01:00
Allow setting externalTrafficPolicy for the api service. useful
when using NodePort and LoadBalancer types.

Signed-off-by: Seena Fallah &lt;seenafallah@gmail.com&gt;
diff --git a/api/k0smotron.io/v1beta1/k0smotroncluster_types.go b/api/k0smotron.io/v1beta1/k0smotroncluster_types.go
@@ -19,9 +19,10 @@ package v1beta1
 import (
 	"crypto/md5"
 	"fmt"
+	"strings"
+
 	"github.com/k0sproject/version"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
-	"strings"
 
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -246,6 +247,10 @@ type ServiceSpec struct {
 	// LoadBalancerClass defines the load balancer class to be used for the service. Used only when service type is LoadBalancer.
 	//+kubebuilder:validation:Optional
 	LoadBalancerClass *string `json:"loadBalancerClass,omitempty"`
+	// ExternalTrafficPolicy defines the external traffic policy for the service. Used only when service type is NodePort or LoadBalancer.
+	//+kubebuilder:validation:Optional
+	//+kubebuilder:validation:Enum=Cluster;Local
+	ExternalTrafficPolicy v1.ServiceExternalTrafficPolicyType `json:"externalTrafficPolicy,omitempty"`
 }
 
 //+kubebuilder:object:root=true
diff --git a/config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml b/config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml
@@ -4488,6 +4488,14 @@ spec:
                       APIPort defines the kubernetes API port. If empty k0smotron
                       will pick it automatically.
                     type: integer
+                  externalTrafficPolicy:
+                    description: ExternalTrafficPolicy defines the external traffic
+                      policy for the service. Used only when service type is NodePort
+                      or LoadBalancer.
+                    enum:
+                    - Cluster
+                    - Local
+                    type: string
                   konnectivityPort:
                     default: 30132
                     description: |-
diff --git a/config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml b/config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml
@@ -4532,6 +4532,14 @@ spec:
                               APIPort defines the kubernetes API port. If empty k0smotron
                               will pick it automatically.
                             type: integer
+                          externalTrafficPolicy:
+                            description: ExternalTrafficPolicy defines the external
+                              traffic policy for the service. Used only when service
+                              type is NodePort or LoadBalancer.
+                            enum:
+                            - Cluster
+                            - Local
+                            type: string
                           konnectivityPort:
                             default: 30132
                             description: |-
diff --git a/config/clusterapi/k0smotron.io/bases/k0smotron.io_clusters.yaml b/config/clusterapi/k0smotron.io/bases/k0smotron.io_clusters.yaml
@@ -4450,6 +4450,14 @@ spec:
                       APIPort defines the kubernetes API port. If empty k0smotron
                       will pick it automatically.
                     type: integer
+                  externalTrafficPolicy:
+                    description: ExternalTrafficPolicy defines the external traffic
+                      policy for the service. Used only when service type is NodePort
+                      or LoadBalancer.
+                    enum:
+                    - Cluster
+                    - Local
+                    type: string
                   konnectivityPort:
                     default: 30132
                     description: |-
diff --git a/config/crd/bases/controlplane/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml b/config/crd/bases/controlplane/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml
@@ -4488,6 +4488,14 @@ spec:
                       APIPort defines the kubernetes API port. If empty k0smotron
                       will pick it automatically.
                     type: integer
+                  externalTrafficPolicy:
+                    description: ExternalTrafficPolicy defines the external traffic
+                      policy for the service. Used only when service type is NodePort
+                      or LoadBalancer.
+                    enum:
+                    - Cluster
+                    - Local
+                    type: string
                   konnectivityPort:
                     default: 30132
                     description: |-
diff --git a/config/crd/bases/controlplane/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml b/config/crd/bases/controlplane/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml
@@ -4532,6 +4532,14 @@ spec:
                               APIPort defines the kubernetes API port. If empty k0smotron
                               will pick it automatically.
                             type: integer
+                          externalTrafficPolicy:
+                            description: ExternalTrafficPolicy defines the external
+                              traffic policy for the service. Used only when service
+                              type is NodePort or LoadBalancer.
+                            enum:
+                            - Cluster
+                            - Local
+                            type: string
                           konnectivityPort:
                             default: 30132
                             description: |-
diff --git a/config/crd/bases/k0smotron.io/k0smotron.io_clusters.yaml b/config/crd/bases/k0smotron.io/k0smotron.io_clusters.yaml
@@ -4450,6 +4450,14 @@ spec:
                       APIPort defines the kubernetes API port. If empty k0smotron
                       will pick it automatically.
                     type: integer
+                  externalTrafficPolicy:
+                    description: ExternalTrafficPolicy defines the external traffic
+                      policy for the service. Used only when service type is NodePort
+                      or LoadBalancer.
+                    enum:
+                    - Cluster
+                    - Local
+                    type: string
                   konnectivityPort:
                     default: 30132
                     description: |-
diff --git a/docs/resource-reference/controlplane.cluster.x-k8s.io-v1beta1.md b/docs/resource-reference/controlplane.cluster.x-k8s.io-v1beta1.md
@@ -11020,6 +11020,15 @@ will pick it automatically.<br/>
             <i>Default</i>: 30443<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>externalTrafficPolicy</b></td>
+        <td>enum</td>
+        <td>
+          ExternalTrafficPolicy defines the external traffic policy for the service. Used only when service type is NodePort or LoadBalancer.<br/>
+          <br/>
+            <i>Enum</i>: Cluster, Local<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>konnectivityPort</b></td>
         <td>integer</td>
@@ -20777,6 +20786,15 @@ will pick it automatically.<br/>
             <i>Default</i>: 30443<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>externalTrafficPolicy</b></td>
+        <td>enum</td>
+        <td>
+          ExternalTrafficPolicy defines the external traffic policy for the service. Used only when service type is NodePort or LoadBalancer.<br/>
+          <br/>
+            <i>Enum</i>: Cluster, Local<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>konnectivityPort</b></td>
         <td>integer</td>
diff --git a/docs/resource-reference/k0smotron.io-v1beta1.md b/docs/resource-reference/k0smotron.io-v1beta1.md
@@ -9177,6 +9177,15 @@ will pick it automatically.<br/>
             <i>Default</i>: 30443<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>externalTrafficPolicy</b></td>
+        <td>enum</td>
+        <td>
+          ExternalTrafficPolicy defines the external traffic policy for the service. Used only when service type is NodePort or LoadBalancer.<br/>
+          <br/>
+            <i>Enum</i>: Cluster, Local<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>konnectivityPort</b></td>
         <td>integer</td>
diff --git a/go.mod b/go.mod
@@ -7,6 +7,7 @@ require (
 	github.com/coreos/butane v0.24.0
 	github.com/go-logr/logr v1.4.2
 	github.com/gobuffalo/flect v1.0.3
+	github.com/google/go-cmp v0.7.0
 	github.com/google/uuid v1.6.0
 	github.com/imdario/mergo v0.3.16
 	github.com/k0sproject/k0s v1.27.2-0.20230504131248-94378e521a29
@@ -118,7 +119,6 @@ require (
 	github.com/google/cel-go v0.22.0 // indirect
 	github.com/google/certificate-transparency-go v1.1.4 // indirect
 	github.com/google/gnostic-models v0.6.8 // indirect
-	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/go-github/v53 v53.2.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
diff --git a/go.sum b/go.sum
diff --git a/internal/controller/k0smotron.io/k0smotroncluster_service.go b/internal/controller/k0smotron.io/k0smotroncluster_service.go

-Original file line number
+Diff line change
 	github.com/coreos/butane v0.24.0
 	github.com/go-logr/logr v1.4.2
 	github.com/gobuffalo/flect v1.0.3
 +	github.com/google/go-cmp v0.7.0
 	github.com/google/uuid v1.6.0
 	github.com/imdario/mergo v0.3.16
 	github.com/k0sproject/k0s v1.27.2-0.20230504131248-94378e521a29
 	github.com/google/cel-go v0.22.0 // indirect
 	github.com/google/certificate-transparency-go v1.1.4 // indirect
 	github.com/google/gnostic-models v0.6.8 // indirect
 -	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/go-github/v53 v53.2.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect