add reconciliation logic for HTTPRoutes

Co-Authored-By: Aleksei Sviridkin <[email protected]>
Co-Authored-By: sure <[email protected]>

Author: 3 people

api/v1beta1/zz_generated.deepcopy.go

@@ -11,6 +11,7 @@ var _ AutoDetect = (*autoDetect)(nil)
 // AutoDetect provides an assortment of routines that auto-detect traits based on the runtime.
 type AutoDetect interface {
 	IsOpenshift() (bool, error)
+	HasGatewayAPI() (bool, error)
 }
 
 type autoDetect struct {
@@ -32,19 +33,28 @@ func New(restConfig *rest.Config) (AutoDetect, error) {
 	}, nil
 }
 
-// Platform returns the detected platform this operator is running on. Possible values: Kubernetes, OpenShift.
-func (a *autoDetect) IsOpenshift() (bool, error) {
+func (a *autoDetect) hasAPIGroup(target string) (bool, error) {
 	apiList, err := a.dcl.ServerGroups()
 	if err != nil {
 		return false, err
 	}
 
 	apiGroups := apiList.Groups
-	for i := range apiGroups {
-		if apiGroups[i].Name == "route.openshift.io" {
+	for _, group := range apiGroups {
+		if group.Name == target {
 			return true, nil
 		}
 	}
 
 	return false, nil
 }
+
+// Tests for the presence of the `route.openshift.io` api group as an indicator of if we're running in OpenShift
+func (a *autoDetect) IsOpenshift() (bool, error) {
+	return a.hasAPIGroup("route.openshift.io")
+}
+
+// Tests if the GatewayAPI CRDs are present
+func (a *autoDetect) HasGatewayAPI() (bool, error) {
+	return a.hasAPIGroup("gateway.networking.k8s.io")
+}

controllers/autodetect/main.go

@@ -11,6 +11,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
 func GetCommonLabels() map[string]string {
@@ -127,6 +128,19 @@ func GetGrafanaRoute(cr *grafanav1beta1.Grafana, scheme *runtime.Scheme) *routev
 	return route
 }
 
+func GetGrafanaHTTPRoute(cr *grafanav1beta1.Grafana, scheme *runtime.Scheme) *gwapiv1.HTTPRoute {
+	httpRoute := &gwapiv1.HTTPRoute{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      fmt.Sprintf("%s-httproute", cr.Name),
+			Namespace: cr.Namespace,
+			Labels:    GetCommonLabels(),
+		},
+	}
+	controllerutil.SetControllerReference(cr, httpRoute, scheme) //nolint:errcheck
+
+	return httpRoute
+}
+
 func GetGrafanaDeployment(cr *grafanav1beta1.Grafana, scheme *runtime.Scheme) *v13.Deployment {
 	deployment := &v13.Deployment{
 		ObjectMeta: metav1.ObjectMeta{

controllers/model/grafana_resources.go

@@ -15,6 +15,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
 const (
@@ -42,6 +43,11 @@ func (r *IngressReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana,
 		return r.reconcileRoute(ctx, cr, vars, scheme)
 	}
 
+	if cr.Spec.HTTPRoute != nil {
+		log.Info("reconciling HTTPRoute")
+		return r.reconcileHTTPRoute(ctx, cr, vars, scheme)
+	}
+
 	log.Info("reconciling ingress")
 
 	return r.reconcileIngress(ctx, cr, vars, scheme)
@@ -139,6 +145,42 @@ func (r *IngressReconciler) reconcileRoute(ctx context.Context, cr *v1beta1.Graf
 	return v1beta1.OperatorStageResultSuccess, nil
 }
 
+func (r *IngressReconciler) reconcileHTTPRoute(ctx context.Context, cr *v1beta1.Grafana, _ *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
+	if cr.Spec.HTTPRoute == nil {
+		return v1beta1.OperatorStageResultSuccess, nil
+	}
+
+	route := model.GetGrafanaHTTPRoute(cr, scheme)
+
+	_, err := controllerutil.CreateOrUpdate(ctx, r.client, route, func() error {
+		route.Spec = getHTTPRouteSpec(cr, scheme)
+
+		err := v1beta1.Merge(route, cr.Spec.HTTPRoute)
+		if err != nil {
+			setInvalidMergeCondition(cr, "HTTPRoute", err)
+			return err
+		}
+
+		removeInvalidMergeCondition(cr, "HTTPRoute")
+
+		if scheme != nil {
+			err = controllerutil.SetControllerReference(cr, route, scheme)
+			if err != nil {
+				return err
+			}
+		}
+
+		model.SetInheritedLabels(route, cr.Labels)
+
+		return nil
+	})
+	if err != nil {
+		return v1beta1.OperatorStageResultFailed, err
+	}
+
+	return v1beta1.OperatorStageResultSuccess, nil
+}
+
 // getIngressAdminURL returns the first valid URL (Host field is set) from the ingress spec
 func (r *IngressReconciler) getIngressAdminURL(ingress *v1.Ingress) string {
 	if ingress == nil {
@@ -229,6 +271,29 @@ func getRouteSpec(cr *v1beta1.Grafana, scheme *runtime.Scheme) routev1.RouteSpec
 	}
 }
 
+func getHTTPRouteSpec(cr *v1beta1.Grafana, scheme *runtime.Scheme) gwapiv1.HTTPRouteSpec {
+	service := model.GetGrafanaService(cr, scheme)
+	port := gwapiv1.PortNumber(GetGrafanaPort(cr)) //nolint:gosec
+	backendRefs := []gwapiv1.HTTPBackendRef{
+		{
+			BackendRef: gwapiv1.BackendRef{
+				BackendObjectReference: gwapiv1.BackendObjectReference{
+					Name: gwapiv1.ObjectName(service.Name),
+					Port: &port,
+				},
+			},
+		},
+	}
+
+	return gwapiv1.HTTPRouteSpec{
+		Rules: []gwapiv1.HTTPRouteRule{
+			{
+				BackendRefs: backendRefs,
+			},
+		},
+	}
+}
+
 func getIngressSpec(cr *v1beta1.Grafana, scheme *runtime.Scheme) v1.IngressSpec {
 	service := model.GetGrafanaService(cr, scheme)
 

controllers/reconcilers/grafana/ingress_reconciler.go

@@ -12,6 +12,7 @@ import (
 	networkingv1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
 var _ = Describe("Allow use of Ingress on OpenShift", func() {
@@ -72,3 +73,35 @@ var _ = Describe("Allow use of Ingress on OpenShift", func() {
 		Expect(status).To(Equal(v1beta1.OperatorStageResultFailed), "Route does not exist in Scheme outside of OpenShift")
 	})
 })
+
+var _ = Describe("GatewayAPI support", func() {
+	It("Creates HTTPRoute when .spec.httpRoute is defined", func() {
+		r := NewIngressReconciler(k8sClient, false)
+		cr := &v1beta1.Grafana{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "httproute-test",
+				Namespace: "default",
+				Labels:    map[string]string{"test": "httproute"},
+			},
+			Spec: v1beta1.GrafanaSpec{
+				HTTPRoute: &v1beta1.HTTPRouteV1{},
+			},
+		}
+
+		ctx := context.Background()
+		Expect(k8sClient.Create(ctx, cr)).To(Succeed())
+
+		vars := &v1beta1.OperatorReconcileVars{}
+		status, err := r.Reconcile(ctx, cr, vars, scheme.Scheme)
+
+		Expect(err).ToNot(HaveOccurred())
+		Expect(status).To(Equal(v1beta1.OperatorStageResultSuccess))
+
+		httpRoute := &gwapiv1.HTTPRoute{}
+		err = k8sClient.Get(ctx, types.NamespacedName{
+			Name:      fmt.Sprintf("%s-httproute", cr.Name),
+			Namespace: "default",
+		}, httpRoute)
+		Expect(err).ToNot(HaveOccurred())
+	})
+})

controllers/reconcilers/grafana/ingress_reconciler_test.go

@@ -27,6 +27,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	grafanav1beta1 "github.com/grafana/grafana-operator/v5/api/v1beta1"
 	//+kubebuilder:scaffold:imports
@@ -55,7 +56,10 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "config", "crd", "bases")},
+		CRDDirectoryPaths: []string{
+			filepath.Join("..", "..", "..", "config", "crd", "bases"),
+			filepath.Join("..", "..", "..", "tests", "fixtures"),
+		},
 		ErrorIfCRDPathMissing: true,
 	}
 
@@ -65,7 +69,8 @@ var _ = BeforeSuite(func() {
 
 	err = grafanav1beta1.AddToScheme(scheme.Scheme)
 	Expect(err).NotTo(HaveOccurred())
-
+	err = gwapiv1.Install(scheme.Scheme)
+	Expect(err).NotTo(HaveOccurred())
 	//+kubebuilder:scaffold:scheme
 
 	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})

controllers/reconcilers/grafana/suite_test.go

@@ -56,6 +56,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	grafanav1beta1 "github.com/grafana/grafana-operator/v5/api/v1beta1"
 	"github.com/grafana/grafana-operator/v5/controllers"
@@ -101,6 +102,8 @@ func init() {
 	utilruntime.Must(grafanav1beta1.AddToScheme(scheme))
 
 	utilruntime.Must(routev1.AddToScheme(scheme))
+
+	utilruntime.Must(gwapiv1.Install(scheme))
 	//+kubebuilder:scaffold:scheme
 }
 
@@ -191,6 +194,12 @@ func main() { // nolint:gocyclo
 		os.Exit(1)
 	}
 
+	hasGatewayAPI, err := autodetect.HasGatewayAPI()
+	if err != nil {
+		setupLog.Error(err, "unable to detect the GatewayAPI CRDs")
+		os.Exit(1)
+	}
+
 	mgrOptions := ctrl.Options{
 		Scheme:                 scheme,
 		Metrics:                metricsserver.Options{BindAddress: metricsAddr},
@@ -235,6 +244,9 @@ func main() { // nolint:gocyclo
 		if isOpenShift {
 			mgrOptions.Cache.ByObject[&routev1.Route{}] = cacheLabelConfig
 		}
+		if hasGatewayAPI {
+			mgrOptions.Cache.ByObject[&gwapiv1.HTTPRoute{}] = cacheLabelConfig
+		}
 
 		if enforceCacheLabelsLevel == cachingLevelSafe {
 			mgrOptions.Client.Cache = &client.CacheOptions{