*: Migrate default GatewayClass creation to controller (#10912)

Signed-off-by: timflannagan <timflannagan@gmail.com>

Author: timflannagan

api/v1alpha1/doc.go

@@ -6,6 +6,7 @@ package v1alpha1
 // Gateway API resources with status management
 // +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gatewayclasses;gateways;httproutes;tcproutes;tlsroutes;referencegrants;backendtlspolicies,verbs=get;list;watch
 // +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gatewayclasses/status;gateways/status;httproutes/status;tcproutes/status;tlsroutes/status;backendtlspolicies/status,verbs=patch;update
+// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gatewayclasses,verbs=create
 
 // Controller resources
 // +kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch

install/helm/kgateway/templates/gatewayclass.yaml

@@ -96,7 +96,6 @@ rules:
   - gateway.networking.k8s.io
   resources:
   - backendtlspolicies
-  - gatewayclasses
   - gateways
   - httproutes
   - referencegrants
@@ -118,6 +117,15 @@ rules:
   verbs:
   - patch
   - update
+- apiGroups:
+  - gateway.networking.k8s.io
+  resources:
+  - gatewayclasses
+  verbs:
+  - create
+  - get
+  - list
+  - watch
 - apiGroups:
   - networking.istio.io
   resources:

install/helm/kgateway/templates/role.yaml

@@ -63,25 +63,6 @@ controller:
     ports:
       grpc: 9977
 
-# GatewayClass configuration
-gatewayClass:
-  enabled: true
-  name: "kgateway"
-  description: "kgateway controller"
-  controllerName: "kgateway.dev/kgateway"
-  labels: {}
-  annotations: {}
-
-# WaypointClass configuration
-waypointClass:
-  enabled: true
-  name: "kgateway-waypoint"
-  description: "kgateway waypoint controller"
-  controllerName: "kgateway.dev/kgateway"
-  labels: {}
-  annotations:
-    ambient.istio.io/waypoint-inbound-binding: PROXY/15088
-
 image:
   registry: cr.kgateway.dev/kgateway-dev
   tag: ""

install/helm/kgateway/values.yaml

@@ -12,6 +12,7 @@ import (
 	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/event"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
@@ -33,18 +34,36 @@ const (
 	InferencePoolField = "inferencepool-index"
 )
 
+// ClassInfo describes the desired configuration for a GatewayClass.
+type ClassInfo struct {
+	// Description is a human-readable description of the GatewayClass.
+	Description string
+	// Labels are the labels to be added to the GatewayClass.
+	Labels map[string]string
+	// Annotations are the annotations to be added to the GatewayClass.
+	Annotations map[string]string
+	// ParametersRef is the reference to the GatewayParameters object.
+	ParametersRef *apiv1.ParametersReference
+}
+
 // TODO [danehans]: Refactor so controller config is organized into shared and Gateway/InferencePool-specific controllers.
 type GatewayConfig struct {
 	Mgr manager.Manager
-
-	Dev            bool
+	// Dev enables development mode for the controller.
+	Dev bool
+	// ControllerName is the name of the controller. Any GatewayClass objects
+	// managed by this controller must have this name as their ControllerName.
 	ControllerName string
-	AutoProvision  bool
-
-	ControlPlane            deployer.ControlPlaneInfo
+	// AutoProvision enables auto-provisioning of GatewayClasses.
+	AutoProvision bool
+	// ControlPlane sets the default control plane information the deployer will use.
+	ControlPlane deployer.ControlPlaneInfo
+	// IstioIntegrationEnabled enables Istio integration for the controller.
 	IstioIntegrationEnabled bool
-
+	// ImageInfo sets the default image information the deployer will use.
 	ImageInfo *deployer.ImageInfo
+	// ClassInfo sets the default configuration for GatewayClasses managed by this controller.
+	ClassInfo map[string]*ClassInfo
 }
 
 func NewBaseGatewayController(ctx context.Context, cfg GatewayConfig) error {
@@ -59,7 +78,8 @@ func NewBaseGatewayController(ctx context.Context, cfg GatewayConfig) error {
 		},
 	}
 
-	return run(ctx,
+	return run(
+		ctx,
 		controllerBuilder.watchGwClass,
 		controllerBuilder.watchGw,
 		controllerBuilder.addIndexes,
@@ -384,24 +404,27 @@ func shouldIgnoreStatusChild(gvk schema.GroupVersionKind) bool {
 
 func (c *controllerBuilder) watchGwClass(_ context.Context) error {
 	return ctrl.NewControllerManagedBy(c.cfg.Mgr).
+		For(&apiv1.GatewayClass{}, builder.WithPredicates(predicate.Funcs{
+			CreateFunc:  func(e event.CreateEvent) bool { return true },
+			DeleteFunc:  func(e event.DeleteEvent) bool { return false },
+			UpdateFunc:  func(e event.UpdateEvent) bool { return true },
+			GenericFunc: func(e event.GenericEvent) bool { return false },
+		})).
 		WithEventFilter(predicate.GenerationChangedPredicate{}).
 		WithEventFilter(predicate.NewPredicateFuncs(func(object client.Object) bool {
 			// we only care about GatewayClasses that use our controller name
-			if gwClass, ok := object.(*apiv1.GatewayClass); ok {
-				return gwClass.Spec.ControllerName == apiv1.GatewayController(c.cfg.ControllerName)
-			}
-			return false
+			gwClass, ok := object.(*apiv1.GatewayClass)
+			return ok && gwClass.Spec.ControllerName == apiv1.GatewayController(c.cfg.ControllerName)
 		})).
-		For(&apiv1.GatewayClass{}).
-		Complete(reconcile.Func(c.reconciler.ReconcileGatewayClasses))
+		Complete(c.reconciler)
 }
 
 type controllerReconciler struct {
 	cli    client.Client
 	scheme *runtime.Scheme
 }
 
-func (r *controllerReconciler) ReconcileGatewayClasses(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+func (r *controllerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	log := log.FromContext(ctx).WithValues("gwclass", req.NamespacedName)
 
 	gwclass := &apiv1.GatewayClass{}
@@ -415,24 +438,21 @@ func (r *controllerReconciler) ReconcileGatewayClasses(ctx context.Context, req
 
 	log.Info("reconciling gateway class")
 
-	// mark it as accepted:
-	acceptedCondition := metav1.Condition{
+	meta.SetStatusCondition(&gwclass.Status.Conditions, metav1.Condition{
 		Type:               string(apiv1.GatewayClassConditionStatusAccepted),
 		Status:             metav1.ConditionTrue,
 		Reason:             string(apiv1.GatewayClassReasonAccepted),
 		ObservedGeneration: gwclass.Generation,
 		// no need to set LastTransitionTime, it will be set automatically by SetStatusCondition
-	}
-	meta.SetStatusCondition(&gwclass.Status.Conditions, acceptedCondition)
+	})
 
 	// TODO: This should actually check the version of the CRDs in the cluster to be 100% sure
-	supportedVersionCondition := metav1.Condition{
+	meta.SetStatusCondition(&gwclass.Status.Conditions, metav1.Condition{
 		Type:               string(apiv1.GatewayClassConditionStatusSupportedVersion),
 		Status:             metav1.ConditionTrue,
 		ObservedGeneration: gwclass.Generation,
 		Reason:             string(apiv1.GatewayClassReasonSupportedVersion),
-	}
-	meta.SetStatusCondition(&gwclass.Status.Conditions, supportedVersionCondition)
+	})
 
 	if err := r.cli.Status().Update(ctx, gwclass); err != nil {
 		return ctrl.Result{}, err