feat: Add custom backendRef support for Gateway API

Signed-off-by: kahirokunn <okinakahiro@gmail.com>
fluxcd · Dec 16, 2024 · cdf638e · cdf638e
1 parent a85887d
commit cdf638e
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 22 deletions.
diff --git a/pkg/apis/flagger/v1beta1/canary.go b/pkg/apis/flagger/v1beta1/canary.go
@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"time"
 
+	v1 "github.com/fluxcd/flagger/pkg/apis/gatewayapi/v1"
 	"github.com/fluxcd/flagger/pkg/apis/gatewayapi/v1beta1"
 	istiov1beta1 "github.com/fluxcd/flagger/pkg/apis/istio/v1beta1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -213,11 +214,11 @@ type CanaryService struct {
 
 	// Primary is the metadata to add to the primary service
 	// +optional
-	Primary *CustomMetadata `json:"primary,omitempty"`
+	Primary *Custom `json:"primary,omitempty"`
 
 	// Canary is the metadata to add to the canary service
 	// +optional
-	Canary *CustomMetadata `json:"canary,omitempty"`
+	Canary *Custom `json:"canary,omitempty"`
 }
 
 // CanaryAnalysis is used to describe how the analysis should be done
@@ -496,6 +497,16 @@ type CustomMetadata struct {
 	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
+// Custom holds labels, annotations, and proxyRef to set on generated objects.
+type Custom struct {
+	CustomMetadata
+
+	// BackendRef is a reference to a backend to forward matched requests to.
+	// Defaults to the primary or canary service.
+	// +optional
+	BackendRef *v1.HTTPBackendRef `json:"backendRef,omitempty"`
+}
+
 // HTTPRewrite holds information about how to modify a request URI during
 // forwarding.
 type HTTPRewrite struct {

diff --git a/pkg/apis/flagger/v1beta1/zz_generated.deepcopy.go b/pkg/apis/flagger/v1beta1/zz_generated.deepcopy.go
diff --git a/pkg/router/gateway_api.go b/pkg/router/gateway_api.go
@@ -97,10 +97,12 @@ func (gwr *GatewayAPIRouter) Reconcile(canary *flaggerv1.Canary) error {
 				Filters: gwr.makeFilters(canary),
 				BackendRefs: []v1.HTTPBackendRef{
 					{
-						BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port),
+						BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
+						Filters:    canary.Spec.Service.Primary.BackendRef.Filters,
 					},
 					{
-						BackendRef: gwr.makeBackendRef(canarySvcName, initialCanaryWeight, canary.Spec.Service.Port),
+						BackendRef: gwr.makeBackendRef(canarySvcName, initialCanaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Canary.BackendRef.BackendRef),
+						Filters:    canary.Spec.Service.Canary.BackendRef.Filters,
 					},
 				},
 			},
@@ -123,7 +125,8 @@ func (gwr *GatewayAPIRouter) Reconcile(canary *flaggerv1.Canary) error {
 			Filters: gwr.makeFilters(canary),
 			BackendRefs: []v1.HTTPBackendRef{
 				{
-					BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port),
+					BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
+					Filters:    canary.Spec.Service.Primary.BackendRef.Filters,
 				},
 			},
 		})
@@ -341,10 +344,12 @@ func (gwr *GatewayAPIRouter) SetRoutes(
 		Filters: gwr.makeFilters(canary),
 		BackendRefs: []v1.HTTPBackendRef{
 			{
-				BackendRef: gwr.makeBackendRef(primarySvcName, pWeight, canary.Spec.Service.Port),
+				BackendRef: gwr.makeBackendRef(primarySvcName, pWeight, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
+				Filters:    canary.Spec.Service.Primary.BackendRef.Filters,
 			},
 			{
-				BackendRef: gwr.makeBackendRef(canarySvcName, cWeight, canary.Spec.Service.Port),
+				BackendRef: gwr.makeBackendRef(canarySvcName, cWeight, canary.Spec.Service.Port, &canary.Spec.Service.Canary.BackendRef.BackendRef),
+				Filters:    canary.Spec.Service.Canary.BackendRef.Filters,
 			},
 		},
 	}
@@ -400,7 +405,8 @@ func (gwr *GatewayAPIRouter) SetRoutes(
 			Filters: gwr.makeFilters(canary),
 			BackendRefs: []v1.HTTPBackendRef{
 				{
-					BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port),
+					BackendRef: gwr.makeBackendRef(primarySvcName, initialPrimaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
+					Filters:    canary.Spec.Service.Primary.BackendRef.Filters,
 				},
 			},
 			Timeouts: &v1.HTTPRouteTimeouts{
@@ -485,10 +491,12 @@ func (gwr *GatewayAPIRouter) getSessionAffinityRouteRules(canary *flaggerv1.Cana
 		stickyRouteRule.Matches = mergedMatches
 		stickyRouteRule.BackendRefs = []v1.HTTPBackendRef{
 			{
-				BackendRef: gwr.makeBackendRef(primarySvcName, 0, canary.Spec.Service.Port),
+				BackendRef: gwr.makeBackendRef(primarySvcName, 0, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
+				Filters:    canary.Spec.Service.Primary.BackendRef.Filters,
 			},
 			{
-				BackendRef: gwr.makeBackendRef(canarySvcName, 100, canary.Spec.Service.Port),
+				BackendRef: gwr.makeBackendRef(canarySvcName, 100, canary.Spec.Service.Port, &canary.Spec.Service.Canary.BackendRef.BackendRef),
+				Filters:    canary.Spec.Service.Canary.BackendRef.Filters,
 			},
 		}
 	} else {
@@ -612,7 +620,12 @@ func (gwr *GatewayAPIRouter) mapRouteMatches(requestMatches []istiov1beta1.HTTPM
 	return matches, nil
 }
 
-func (gwr *GatewayAPIRouter) makeBackendRef(svcName string, weight, port int32) v1.BackendRef {
+func (gwr *GatewayAPIRouter) makeBackendRef(svcName string, weight, port int32, backendRefTemplate *v1.BackendRef) v1.BackendRef {
+	if backendRefTemplate != nil {
+		backendRefTemplate.Weight = &weight
+		return *backendRefTemplate
+	}
+
 	return v1.BackendRef{
 		BackendObjectReference: v1.BackendObjectReference{
 			Group: (*v1.Group)(&backendRefGroup),

diff --git a/pkg/router/gateway_api_test.go b/pkg/router/gateway_api_test.go
@@ -296,10 +296,10 @@ func TestGatewayAPIRouter_getSessionAffinityRouteRules(t *testing.T) {
 	weightedRouteRule := &v1.HTTPRouteRule{
 		BackendRefs: []v1.HTTPBackendRef{
 			{
-				BackendRef: router.makeBackendRef(pSvcName, initialPrimaryWeight, canary.Spec.Service.Port),
+				BackendRef: router.makeBackendRef(pSvcName, initialPrimaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Primary.BackendRef.BackendRef),
 			},
 			{
-				BackendRef: router.makeBackendRef(cSvcName, initialCanaryWeight, canary.Spec.Service.Port),
+				BackendRef: router.makeBackendRef(cSvcName, initialCanaryWeight, canary.Spec.Service.Port, &canary.Spec.Service.Canary.BackendRef.BackendRef),
 			},
 		},
 	}

diff --git a/pkg/router/kubernetes_default.go b/pkg/router/kubernetes_default.go
@@ -50,13 +50,13 @@ func (c *KubernetesDefaultRouter) Initialize(canary *flaggerv1.Canary) error {
 	_, primaryName, canaryName := canary.GetServiceNames()
 
 	// canary svc
-	err := c.reconcileService(canary, canaryName, c.labelValue, canary.Spec.Service.Canary)
+	err := c.reconcileService(canary, canaryName, c.labelValue, &canary.Spec.Service.Canary.CustomMetadata)
 	if err != nil {
 		return fmt.Errorf("reconcileService failed: %w", err)
 	}
 
 	// primary svc
-	err = c.reconcileService(canary, primaryName, fmt.Sprintf("%s-primary", c.labelValue), canary.Spec.Service.Primary)
+	err = c.reconcileService(canary, primaryName, fmt.Sprintf("%s-primary", c.labelValue), &canary.Spec.Service.Primary.CustomMetadata)
 	if err != nil {
 		return fmt.Errorf("reconcileService failed: %w", err)
 	}

diff --git a/pkg/router/kubernetes_default_test.go b/pkg/router/kubernetes_default_test.go
@@ -375,13 +375,13 @@ func TestServiceRouter_InitializeMetadata(t *testing.T) {
 		labelSelector: "app",
 	}
 
-	metadata := &flaggerv1.CustomMetadata{
-		Labels:      map[string]string{"test": "test"},
-		Annotations: map[string]string{"test": "test"},
+	mocks.canary.Spec.Service.Canary = &flaggerv1.Custom{
+		CustomMetadata: flaggerv1.CustomMetadata{
+			Labels:      map[string]string{"test": "test"},
+			Annotations: map[string]string{"test": "test"},
+		},
 	}
 
-	mocks.canary.Spec.Service.Canary = metadata
-
 	err := router.Initialize(mocks.canary)
 	require.NoError(t, err)