feat(routing): complete Gateway API solver integration, fix spec drift and watches

Author: btjd

controllers/controller/devworkspacerouting/devworkspacerouting_controller.go

@@ -40,6 +40,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
 )
@@ -371,7 +372,8 @@ func (r *DevWorkspaceRoutingReconciler) SetupWithManager(mgr ctrl.Manager) error
 		WithOptions(controller.Options{MaxConcurrentReconciles: maxConcurrentReconciles}).
 		For(&controllerv1alpha1.DevWorkspaceRouting{}).
 		Owns(&corev1.Service{}).
-		Owns(&networkingv1.Ingress{})
+		Owns(&networkingv1.Ingress{}).
+		Owns(&gwapiv1.HTTPRoute{})
 	if infrastructure.IsOpenShift() {
 		bld.Owns(&routeV1.Route{})
 	}

controllers/controller/devworkspacerouting/devworkspacerouting_controller_test.go

@@ -561,8 +561,8 @@ var _ = Describe("DevWorkspaceRouting Controller", func() {
 					if filter.Type == gwapiv1.HTTPRouteFilterRequestRedirect {
 						hasRedirectFilter = true
 						Expect(filter.RequestRedirect).ShouldNot(BeNil(), "Redirect filter should have RequestRedirect configuration")
-						Expect(*filter.RequestRedirect.Scheme).Should(Equal(gwapiv1.HTTPSProtocolType), "Redirect should be to HTTPS")
-						Expect(*filter.RequestRedirect.StatusCode).Should(Equal(308), "Redirect should use 308 status code")
+						Expect(*filter.RequestRedirect.Scheme).Should(Equal("https"), "Redirect should be to HTTPS")
+						Expect(*filter.RequestRedirect.StatusCode).Should(Equal(301), "Redirect should use 301 status code")
 					}
 				}
 				Expect(hasRedirectFilter).Should(BeTrue(), "HTTP redirect HTTPRoute should have a redirect filter")

controllers/controller/devworkspacerouting/solvers/gateway_api_solver.go

@@ -131,7 +131,7 @@ func (s *GatewayAPISolver) createHTTPRedirectRoute(
 	routeName := fmt.Sprintf("%s-http-redirect", common.RouteName(workspaceMeta.DevWorkspaceId, endpointName))
 
 	httpsScheme := "https"
-	statusCode := 308
+	statusCode := 301
 
 	pathPrefix := gwapiv1.PathMatchPathPrefix
 	pathValue := "/"

main.go

@@ -58,6 +58,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	ctrl_webhook "sigs.k8s.io/controller-runtime/pkg/webhook"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -79,6 +80,7 @@ func init() {
 	utilruntime.Must(controllerv1alpha1.AddToScheme(scheme))
 	utilruntime.Must(dwv1.AddToScheme(scheme))
 	utilruntime.Must(dwv2.AddToScheme(scheme))
+	utilruntime.Must(gwapiv1.AddToScheme(scheme))
 
 	if infrastructure.IsOpenShift() {
 		utilruntime.Must(routev1.Install(scheme))

pkg/config/sync.go

@@ -277,6 +277,9 @@ func mergeConfig(from, to *controller.OperatorConfiguration) {
 		if from.Routing.ClusterHostSuffix != "" {
 			to.Routing.ClusterHostSuffix = from.Routing.ClusterHostSuffix
 		}
+		if from.Routing.GatewayRef != nil {
+			to.Routing.GatewayRef = from.Routing.GatewayRef.DeepCopy()
+		}
 		if from.Routing.ProxyConfig != nil {
 			if to.Routing.ProxyConfig == nil {
 				to.Routing.ProxyConfig = &controller.Proxy{}

pkg/provision/sync/diff.go

@@ -31,6 +31,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/utils/pointer"
 	crclient "sigs.k8s.io/controller-runtime/pkg/client"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
 // diffFunc represents a function that compares a spec object against the corresponding cluster object and
@@ -50,6 +51,7 @@ var diffFuncs = map[reflect.Type]diffFunc{
 	reflect.TypeOf(corev1.Service{}):               allDiffFuncs(metadataDiffFunc, serviceDiffFunc),
 	reflect.TypeOf(networkingv1.Ingress{}):         allDiffFuncs(metadataDiffFunc, basicDiffFunc(ingressDiffOpts)),
 	reflect.TypeOf(routev1.Route{}):                allDiffFuncs(metadataDiffFunc, basicDiffFunc(routeDiffOpts)),
+	reflect.TypeOf(gwapiv1.HTTPRoute{}):            allDiffFuncs(metadataDiffFunc, basicDiffFunc(httpRouteDiffOpts)),
 }
 
 // basicDiffFunc returns a diffFunc that specifies an object needs an update if cmp.Equal fails

pkg/provision/sync/diffopts.go

@@ -24,6 +24,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
 var roleDiffOpts = cmp.Options{
@@ -92,6 +93,13 @@ var ingressDiffOpts = cmp.Options{
 	cmpopts.IgnoreFields(networkingv1.HTTPIngressPath{}, "PathType"),
 }
 
+var httpRouteDiffOpts = cmp.Options{
+	cmpopts.IgnoreFields(gwapiv1.HTTPRoute{}, "TypeMeta", "ObjectMeta", "Status"),
+	cmpopts.IgnoreFields(gwapiv1.BackendRef{}, "Weight"),
+	cmpopts.IgnoreFields(gwapiv1.BackendObjectReference{}, "Group", "Kind", "Namespace"),
+	cmpopts.IgnoreFields(gwapiv1.ParentReference{}, "Group", "Kind", "Namespace"),
+}
+
 func getNameFromEnvFrom(source corev1.EnvFromSource) string {
 	switch {
 	case source.ConfigMapRef != nil: