CP/DP Split: Add ability to set loadBalancerClass for load balancer Service (#3319)

Add ability to set loadBalancerClass for load balancer Service

Problem: We would like the ability to specify the loadBalanacerClass field on a load balancer service.

Solution: Add ability to set loadBalancerClass for load balancer Service.

Testing: Manually tested that deploying NGF with the nginx.service.loadBalancerClass Helm flag would correctly set the field. Also tested that modifying the NginxProxy resource would set the loadBalancerClass when the service was re-created (the field can only be set upon creation).

Author: bjee19

apis/v1alpha2/nginxproxy_types.go

@@ -517,6 +517,12 @@ type ServiceSpec struct {
 	// +optional
 	LoadBalancerIP *string `json:"loadBalancerIP,omitempty"`
 
+	// LoadBalancerClass is the class of the load balancer implementation this Service belongs to.
+	// Requires service type to be LoadBalancer.
+	//
+	// +optional
+	LoadBalancerClass *string `json:"loadBalancerClass,omitempty"`
+
 	// Annotations contain any Service-specific annotations.
 	//
 	// +optional

apis/v1alpha2/zz_generated.deepcopy.go

@@ -427,6 +427,10 @@ nginx:
     # -- The static IP address for the load balancer. Requires nginx.service.type set to LoadBalancer.
     # loadBalancerIP: ""
 
+    # -- LoadBalancerClass is the class of the load balancer implementation this Service belongs to.
+    # Requires nginx.service.type set to LoadBalancer.
+    # loadBalancerClass: ""
+
     # -- The IP ranges (CIDR) that are allowed to access the load balancer. Requires nginx.service.type set to LoadBalancer.
     # loadBalancerSourceRanges: []
 

charts/nginx-gateway-fabric/values.yaml

@@ -3482,6 +3482,11 @@ spec:
                         - Cluster
                         - Local
                         type: string
+                      loadBalancerClass:
+                        description: |-
+                          LoadBalancerClass is the class of the load balancer implementation this Service belongs to.
+                          Requires service type to be LoadBalancer.
+                        type: string
                       loadBalancerIP:
                         description: LoadBalancerIP is a static IP address for the
                           load balancer. Requires service type to be LoadBalancer.

config/crd/bases/gateway.nginx.org_nginxproxies.yaml

@@ -4067,6 +4067,11 @@ spec:
                         - Cluster
                         - Local
                         type: string
+                      loadBalancerClass:
+                        description: |-
+                          LoadBalancerClass is the class of the load balancer implementation this Service belongs to.
+                          Requires service type to be LoadBalancer.
+                        type: string
                       loadBalancerIP:
                         description: LoadBalancerIP is a static IP address for the
                           load balancer. Requires service type to be LoadBalancer.

deploy/crds.yaml

@@ -460,6 +460,9 @@ func buildNginxService(
 	if serviceCfg.LoadBalancerIP != nil {
 		svc.Spec.LoadBalancerIP = *serviceCfg.LoadBalancerIP
 	}
+	if serviceCfg.LoadBalancerClass != nil {
+		svc.Spec.LoadBalancerClass = serviceCfg.LoadBalancerClass
+	}
 	if serviceCfg.LoadBalancerSourceRanges != nil {
 		svc.Spec.LoadBalancerSourceRanges = serviceCfg.LoadBalancerSourceRanges
 	}

internal/mode/static/provisioner/objects.go

@@ -253,6 +253,7 @@ func TestBuildNginxResourceObjects_NginxProxyConfig(t *testing.T) {
 				ServiceType:              helpers.GetPointer(ngfAPIv1alpha2.ServiceTypeNodePort),
 				ExternalTrafficPolicy:    helpers.GetPointer(ngfAPIv1alpha2.ExternalTrafficPolicyCluster),
 				LoadBalancerIP:           helpers.GetPointer("1.2.3.4"),
+				LoadBalancerClass:        helpers.GetPointer("myLoadBalancerClass"),
 				LoadBalancerSourceRanges: []string{"5.6.7.8"},
 			},
 			Deployment: &ngfAPIv1alpha2.DeploymentSpec{
@@ -299,6 +300,7 @@ func TestBuildNginxResourceObjects_NginxProxyConfig(t *testing.T) {
 	g.Expect(svc.Spec.Type).To(Equal(corev1.ServiceTypeNodePort))
 	g.Expect(svc.Spec.ExternalTrafficPolicy).To(Equal(corev1.ServiceExternalTrafficPolicyTypeCluster))
 	g.Expect(svc.Spec.LoadBalancerIP).To(Equal("1.2.3.4"))
+	g.Expect(*svc.Spec.LoadBalancerClass).To(Equal("myLoadBalancerClass"))
 	g.Expect(svc.Spec.LoadBalancerSourceRanges).To(Equal([]string{"5.6.7.8"}))
 
 	depObj := objects[5]