load balancer class support

wondersd · Donald Wonders · commit 633194a55ab4 · 2023-08-28T15:52:41.000-04:00
Signed-off-by: Don Wonders &lt;wonders.don@gmail.com&gt;
diff --git a/api/config/v1alpha1/shared_types.go b/api/config/v1alpha1/shared_types.go
@@ -172,6 +172,11 @@ type KubernetesServiceSpec struct {
 	// +optional
 	Type *ServiceType `json:"type,omitempty"`
 
+	// LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider
+	// implementation if more than one are available or is otherwise expected to be specified
+	// +optional
+	LoadBalancerClass *string `json:"loadBalancerClass,omitempty"`
+
 	// TODO: Expose config as use cases are better understood, e.g. labels.
 }
 
diff --git a/api/config/v1alpha1/zz_generated.deepcopy.go b/api/config/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/config.gateway.envoyproxy.io_envoyproxies.yaml b/charts/gateway-helm/crds/generated/config.gateway.envoyproxy.io_envoyproxies.yaml
@@ -3807,6 +3807,12 @@ spec:
                             description: Annotations that should be appended to the
                               service. By default, no annotations are appended.
                             type: object
+                          loadBalancerClass:
+                            description: LoadBalancerClass, when specified, allows
+                              for choosing the LoadBalancer provider implementation
+                              if more than one are available or is otherwise expected
+                              to be specified
+                            type: string
                           type:
                             default: LoadBalancer
                             description: Type determines how the Service is exposed.
diff --git a/docs/latest/api/config_types.md b/docs/latest/api/config_types.md
@@ -550,6 +550,7 @@ _Appears in:_
 | --- | --- |
 | `annotations` _object (keys:string, values:string)_ | Annotations that should be appended to the service. By default, no annotations are appended. |
 | `type` _[ServiceType](#servicetype)_ | Type determines how the Service is exposed. Defaults to LoadBalancer. Valid options are ClusterIP, LoadBalancer and NodePort. "LoadBalancer" means a service will be exposed via an external load balancer (if the cloud provider supports it). "ClusterIP" means a service will only be accessible inside the cluster, via the cluster IP. "NodePort" means a service will be exposed on a static Port on all Nodes of the cluster. |
+| `loadBalancerClass` _string_ | LoadBalancerClass, when specified, allows for choosing the LoadBalancer provider implementation if more than one are available or is otherwise expected to be specified |
 
 
 ## KubernetesWatchMode
diff --git a/internal/infrastructure/kubernetes/proxy/resource_provider.go b/internal/infrastructure/kubernetes/proxy/resource_provider.go
@@ -97,7 +97,7 @@ func (r *ResourceRender) Service() (*corev1.Service, error) {
 	}
 
 	// Set the spec of gateway service
-	serviceSpec := resource.ExpectedServiceSpec(envoyServiceConfig.Type)
+	serviceSpec := resource.ExpectedServiceSpec(envoyServiceConfig)
 	serviceSpec.Ports = ports
 	serviceSpec.Selector = resource.GetSelector(labels).MatchLabels
 	serviceSpec.ExternalIPs = r.infra.Addresses
diff --git a/internal/infrastructure/kubernetes/ratelimit/resource_provider.go b/internal/infrastructure/kubernetes/ratelimit/resource_provider.go
@@ -69,8 +69,10 @@ func (r *ResourceRender) Service() (*corev1.Service, error) {
 	}
 
 	labels := rateLimitLabels()
-
-	serviceSpec := resource.ExpectedServiceSpec(egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeClusterIP))
+	kubernetesServiceSpec := &egcfgv1a1.KubernetesServiceSpec{
+		Type: egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeClusterIP),
+	}
+	serviceSpec := resource.ExpectedServiceSpec(kubernetesServiceSpec)
 	serviceSpec.Ports = ports
 	serviceSpec.Selector = resource.GetSelector(labels).MatchLabels
 
diff --git a/internal/infrastructure/kubernetes/resource/resource.go b/internal/infrastructure/kubernetes/resource/resource.go
@@ -23,11 +23,14 @@ func GetSelector(labels map[string]string) *metav1.LabelSelector {
 }
 
 // ExpectedServiceSpec returns service spec.
-func ExpectedServiceSpec(serviceType *egcfgv1a1.ServiceType) corev1.ServiceSpec {
+func ExpectedServiceSpec(service *egcfgv1a1.KubernetesServiceSpec) corev1.ServiceSpec {
 	serviceSpec := corev1.ServiceSpec{}
-	serviceSpec.Type = corev1.ServiceType(*serviceType)
+	serviceSpec.Type = corev1.ServiceType(*service.Type)
 	serviceSpec.SessionAffinity = corev1.ServiceAffinityNone
-	if *serviceType == egcfgv1a1.ServiceTypeLoadBalancer {
+	if *service.Type == egcfgv1a1.ServiceTypeLoadBalancer {
+		if service.LoadBalancerClass != nil {
+			serviceSpec.LoadBalancerClass = service.LoadBalancerClass
+		}
 		// Preserve the client source IP and avoid a second hop for LoadBalancer.
 		serviceSpec.ExternalTrafficPolicy = corev1.ServiceExternalTrafficPolicyTypeLocal
 	}
diff --git a/internal/infrastructure/kubernetes/resource/resource_test.go b/internal/infrastructure/kubernetes/resource/resource_test.go
@@ -19,25 +19,43 @@ import (
 
 func TestExpectedServiceSpec(t *testing.T) {
 	type args struct {
-		serviceType *egcfgv1a1.ServiceType
+		service *egcfgv1a1.KubernetesServiceSpec
 	}
+	loadbalancerClass := "foobar"
 	tests := []struct {
 		name string
 		args args
 		want corev1.ServiceSpec
 	}{
 		{
 			name: "LoadBalancer",
-			args: args{serviceType: egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeLoadBalancer)},
+			args: args{service: &egcfgv1a1.KubernetesServiceSpec{
+				Type: egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeLoadBalancer),
+			}},
 			want: corev1.ServiceSpec{
 				Type:                  corev1.ServiceTypeLoadBalancer,
 				SessionAffinity:       corev1.ServiceAffinityNone,
 				ExternalTrafficPolicy: corev1.ServiceExternalTrafficPolicyTypeLocal,
 			},
 		},
+		{
+			name: "LoadBalancerWithClass",
+			args: args{service: &egcfgv1a1.KubernetesServiceSpec{
+				Type:              egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeLoadBalancer),
+				LoadBalancerClass: &loadbalancerClass,
+			}},
+			want: corev1.ServiceSpec{
+				Type:                  corev1.ServiceTypeLoadBalancer,
+				LoadBalancerClass:     &loadbalancerClass,
+				SessionAffinity:       corev1.ServiceAffinityNone,
+				ExternalTrafficPolicy: corev1.ServiceExternalTrafficPolicyTypeLocal,
+			},
+		},
 		{
 			name: "ClusterIP",
-			args: args{serviceType: egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeClusterIP)},
+			args: args{service: &egcfgv1a1.KubernetesServiceSpec{
+				Type: egcfgv1a1.GetKubernetesServiceType(egcfgv1a1.ServiceTypeClusterIP),
+			}},
 			want: corev1.ServiceSpec{
 				Type:            corev1.ServiceTypeClusterIP,
 				SessionAffinity: corev1.ServiceAffinityNone,
@@ -46,7 +64,7 @@ func TestExpectedServiceSpec(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			assert.Equalf(t, tt.want, ExpectedServiceSpec(tt.args.serviceType), "expectedServiceSpec(%v)", tt.args.serviceType)
+			assert.Equalf(t, tt.want, ExpectedServiceSpec(tt.args.service), "expectedServiceSpec(%v)", tt.args.service)
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ func (r ResourceRender) Service() (corev1.Service, error) {`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`// Set the spec of gateway service`
`100`		`- serviceSpec := resource.ExpectedServiceSpec(envoyServiceConfig.Type)`
	`100`	`+ serviceSpec := resource.ExpectedServiceSpec(envoyServiceConfig)`
`101`	`101`	`serviceSpec.Ports = ports`
`102`	`102`	`serviceSpec.Selector = resource.GetSelector(labels).MatchLabels`
`103`	`103`	`serviceSpec.ExternalIPs = r.infra.Addresses`