github.com/cilium/cilium@v1.16.2/operator/pkg/gateway-api/grpcroute.go

// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium

package gateway_api

import (
	"context"

	"github.com/sirupsen/logrus"
	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/fields"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/types"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/builder"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/handler"
	"sigs.k8s.io/controller-runtime/pkg/predicate"
	"sigs.k8s.io/controller-runtime/pkg/reconcile"
	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
	gatewayv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
	mcsapiv1alpha1 "sigs.k8s.io/mcs-api/pkg/apis/v1alpha1"

	"github.com/cilium/cilium/operator/pkg/gateway-api/helpers"
	"github.com/cilium/cilium/pkg/logging/logfields"
)

// grpcRouteReconciler reconciles a GRPCRoute object
type grpcRouteReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

func newGRPCRouteReconciler(mgr ctrl.Manager) *grpcRouteReconciler {
	return &grpcRouteReconciler{
		Client: mgr.GetClient(),
		Scheme: mgr.GetScheme(),
	}
}

// SetupWithManager sets up the controller with the Manager.
func (r *grpcRouteReconciler) SetupWithManager(mgr ctrl.Manager) error {
	if err := mgr.GetFieldIndexer().IndexField(context.Background(), &gatewayv1.GRPCRoute{},
		backendServiceIndex, r.getBackendServiceForGRPCRoute,
	); err != nil {
		return err
	}
	if err := mgr.GetFieldIndexer().IndexField(context.Background(), &gatewayv1.GRPCRoute{},
		backendServiceImportIndex, r.getBackendServiceImportForGRPCRoute,
	); err != nil {
		return err
	}

	// Create field indexer for Gateway parents, this allows a faster lookup for event queueing
	if err := mgr.GetFieldIndexer().IndexField(context.Background(), &gatewayv1.GRPCRoute{},
		gatewayIndex, getParentGatewayForGRPCRoute); err != nil {
		return err
	}

	builder := ctrl.NewControllerManagedBy(mgr).
		// Watch for changes to GRPCRoute
		For(&gatewayv1.GRPCRoute{}).
		// Watch for changes to Backend services
		Watches(&corev1.Service{}, r.enqueueRequestForBackendService()).
		// Watch for changes to Reference Grants
		Watches(&gatewayv1beta1.ReferenceGrant{}, r.enqueueRequestForReferenceGrant()).
		// Watch for changes to Gateways and enqueue GRPCRoutes that reference them
		Watches(&gatewayv1.Gateway{}, r.enqueueRequestForGateway(),
			builder.WithPredicates(
				predicate.NewPredicateFuncs(hasMatchingController(context.Background(), mgr.GetClient(), controllerName))))

	if helpers.HasServiceImportSupport(r.Client.Scheme()) {
		// Watch for changes to Backend Service Imports
		builder = builder.Watches(&mcsapiv1alpha1.ServiceImport{}, r.enqueueRequestForBackendServiceImport())
	}
	return builder.Complete(r)
}

func getParentGatewayForGRPCRoute(rawObj client.Object) []string {
	route, ok := rawObj.(*gatewayv1.GRPCRoute)
	if !ok {
		return nil
	}
	var gateways []string
	for _, parent := range route.Spec.ParentRefs {
		if !helpers.IsGateway(parent) {
			continue
		}
		gateways = append(gateways,
			types.NamespacedName{
				Namespace: helpers.NamespaceDerefOr(parent.Namespace, route.Namespace),
				Name:      string(parent.Name),
			}.String(),
		)
	}
	return gateways
}

func (r *grpcRouteReconciler) getBackendServiceForGRPCRoute(rawObj client.Object) []string {
	route, ok := rawObj.(*gatewayv1.GRPCRoute)
	if !ok {
		return nil
	}
	var backendServices []string
	for _, rule := range route.Spec.Rules {
		for _, backend := range rule.BackendRefs {
			namespace := helpers.NamespaceDerefOr(backend.Namespace, route.Namespace)
			backendServiceName, err := helpers.GetBackendServiceName(r.Client, namespace, backend.BackendObjectReference)
			if err != nil {
				log.WithFields(logrus.Fields{
					logfields.Controller: "grpcRoute",
					logfields.Resource:   client.ObjectKeyFromObject(rawObj),
				}).WithError(err).Error("Failed to get backend service name")
				continue
			}
			backendServices = append(backendServices,
				types.NamespacedName{
					Namespace: helpers.NamespaceDerefOr(backend.Namespace, route.Namespace),
					Name:      backendServiceName,
				}.String(),
			)
		}
	}
	return backendServices
}

func (r *grpcRouteReconciler) getBackendServiceImportForGRPCRoute(rawObj client.Object) []string {
	route, ok := rawObj.(*gatewayv1.GRPCRoute)
	if !ok {
		return nil
	}
	var backendServiceImports []string
	for _, rule := range route.Spec.Rules {
		for _, backend := range rule.BackendRefs {
			if !helpers.IsServiceImport(backend.BackendObjectReference) {
				continue
			}
			backendServiceImports = append(backendServiceImports,
				types.NamespacedName{
					Namespace: helpers.NamespaceDerefOr(backend.Namespace, route.Namespace),
					Name:      string(backend.Name),
				}.String(),
			)
		}
	}
	return backendServiceImports
}

// enqueueRequestForBackendService makes sure that GRPC Routes are reconciled
// if the backend services are updated.
func (r *grpcRouteReconciler) enqueueRequestForBackendService() handler.EventHandler {
	return handler.EnqueueRequestsFromMapFunc(r.enqueueFromIndex(backendServiceIndex))
}

// enqueueRequestForBackendServiceImport makes sure that TLS Routes are reconciled
// if the backend Service Imports are updated.
func (r *grpcRouteReconciler) enqueueRequestForBackendServiceImport() handler.EventHandler {
	return handler.EnqueueRequestsFromMapFunc(r.enqueueFromIndex(backendServiceImportIndex))
}

// enqueueRequestForReferenceGrant makes sure that all GRPC Routes are reconciled
// if a ReferenceGrant changes
func (r *grpcRouteReconciler) enqueueRequestForReferenceGrant() handler.EventHandler {
	return handler.EnqueueRequestsFromMapFunc(r.enqueueAll())
}

func (r *grpcRouteReconciler) enqueueRequestForGateway() handler.EventHandler {
	return handler.EnqueueRequestsFromMapFunc(r.enqueueFromIndex(gatewayIndex))
}

func (r *grpcRouteReconciler) enqueueFromIndex(index string) handler.MapFunc {
	return func(ctx context.Context, o client.Object) []reconcile.Request {
		scopedLog := log.WithFields(logrus.Fields{
			logfields.Controller: grpcRoute,
			logfields.Resource:   client.ObjectKeyFromObject(o),
		})
		list := &gatewayv1.GRPCRouteList{}

		if err := r.Client.List(ctx, list, &client.ListOptions{
			FieldSelector: fields.OneTermEqualSelector(index, client.ObjectKeyFromObject(o).String()),
		}); err != nil {
			scopedLog.WithError(err).Error("Failed to get related GRPCRoutes")
			return []reconcile.Request{}
		}

		requests := make([]reconcile.Request, 0, len(list.Items))
		for _, item := range list.Items {
			route := client.ObjectKey{
				Namespace: item.GetNamespace(),
				Name:      item.GetName(),
			}
			requests = append(requests, reconcile.Request{
				NamespacedName: route,
			})
			scopedLog.WithField(grpcRoute, route).Info("Enqueued GRPCRoute for resource")
		}
		return requests
	}
}

func (r *grpcRouteReconciler) enqueueAll() handler.MapFunc {
	return func(ctx context.Context, o client.Object) []reconcile.Request {
		scopedLog := log.WithFields(logrus.Fields{
			logfields.Controller: grpcRoute,
			logfields.Resource:   client.ObjectKeyFromObject(o),
		})
		list := &gatewayv1.GRPCRouteList{}

		if err := r.Client.List(ctx, list, &client.ListOptions{}); err != nil {
			scopedLog.WithError(err).Error("Failed to get GRPCRoutes")
			return []reconcile.Request{}
		}

		requests := make([]reconcile.Request, 0, len(list.Items))
		for _, item := range list.Items {
			route := client.ObjectKey{
				Namespace: item.GetNamespace(),
				Name:      item.GetName(),
			}
			requests = append(requests, reconcile.Request{
				NamespacedName: route,
			})
			scopedLog.WithField(grpcRoute, route).Info("Enqueued GRPCRoute for resource")
		}
		return requests
	}
}