chore: change fmt.Print to logger call and add context param to Setup…

…WithManager() (#564)
Kong · Sep 9, 2024 · dcb56ad · dcb56ad
1 parent 74ba82d
commit dcb56ad
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 22 deletions.
diff --git a/controller/controlplane/controller.go b/controller/controlplane/controller.go
@@ -47,7 +47,7 @@ type Reconciler struct {
 const requeueWithoutBackoff = time.Millisecond * 200
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	// for owned objects we need to check if updates to the objects resulted in the
 	// removal of an OwnerReference to the parent object, and if so we need to
 	// enqueue the parent object so that reconciliation can create a replacement.

diff --git a/controller/dataplane/bluegreen_controller.go b/controller/dataplane/bluegreen_controller.go
@@ -67,7 +67,7 @@ type BlueGreenReconciler struct {
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *BlueGreenReconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *BlueGreenReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	delegate, ok := r.DataPlaneController.(*Reconciler)
 	if !ok {
 		return fmt.Errorf("incorrect delegate controller type: %T", r.DataPlaneController)

diff --git a/controller/dataplane/controller.go b/controller/dataplane/controller.go
@@ -46,7 +46,7 @@ type Reconciler struct {
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	r.eventRecorder = mgr.GetEventRecorderFor("dataplane")
 
 	return DataPlaneWatchBuilder(mgr).

diff --git a/controller/dataplane/owned_finalizer_controller.go b/controller/dataplane/owned_finalizer_controller.go
@@ -86,7 +86,7 @@ func NewDataPlaneOwnedResourceFinalizerReconciler[T DataPlaneOwnedResource, PT D
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *DataPlaneOwnedResourceFinalizerReconciler[T, PT]) SetupWithManager(mgr ctrl.Manager) error {
+func (r *DataPlaneOwnedResourceFinalizerReconciler[T, PT]) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	objectIsBeingDeleted := func(obj client.Object) bool {
 		return obj.GetDeletionTimestamp() != nil
 	}

diff --git a/controller/gateway/controller.go b/controller/gateway/controller.go
@@ -58,7 +58,7 @@ type Reconciler struct {
 const provisionDataPlaneFailRetryAfter = 5 * time.Second
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		// watch Gateway objects, filtering out any Gateways which are not configured with
 		// a supported GatewayClass controller name.

diff --git a/controller/gatewayclass/controller.go b/controller/gatewayclass/controller.go
@@ -30,7 +30,7 @@ type Reconciler struct {
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&gatewayv1.GatewayClass{},
 			builder.WithPredicates(predicate.NewPredicateFuncs(r.gatewayClassMatches))).

diff --git a/controller/kongplugininstallation/controller.go b/controller/kongplugininstallation/controller.go
@@ -34,7 +34,7 @@ type Reconciler struct {
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&v1alpha1.KongPluginInstallation{}).
 		WithEventFilter(predicate.GenerationChangedPredicate{}).

diff --git a/controller/konnect/reconciler_generic.go b/controller/konnect/reconciler_generic.go
@@ -90,7 +90,7 @@ const (
 )
 
 // SetupWithManager sets up the controller with the given manager.
-func (r *KonnectEntityReconciler[T, TEnt]) SetupWithManager(mgr ctrl.Manager) error {
+func (r *KonnectEntityReconciler[T, TEnt]) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	var (
 		e   T
 		ent = TEnt(&e)
@@ -99,11 +99,13 @@ func (r *KonnectEntityReconciler[T, TEnt]) SetupWithManager(mgr ctrl.Manager) er
 			WithOptions(controller.Options{
 				MaxConcurrentReconciles: MaxConcurrentReconciles,
 			})
+		entityTypeName = constraints.EntityTypeName[T]()
+		logger         = log.GetLogger(ctx, entityTypeName, r.DevelopmentMode)
 	)
 
 	for _, ind := range ReconciliationIndexOptionsForEntity(ent) {
-		if err := mgr.GetCache().IndexField(context.Background(), ind.IndexObject, ind.IndexField, ind.ExtractValue); err != nil {
-			fmt.Println("Create index:", err)
+		logger.Info("creating index", "entityTypeName", entityTypeName, "indexObject", ind.IndexObject, "indexField", ind.IndexField)
+		if err := mgr.GetCache().IndexField(ctx, ind.IndexObject, ind.IndexField, ind.ExtractValue); err != nil {
 			return err
 		}
 	}

diff --git a/controller/konnect/reconciler_generic_test.go b/controller/konnect/reconciler_generic_test.go
@@ -1,6 +1,7 @@
 package konnect
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -45,12 +46,11 @@ func testNewKonnectEntityReconciler[
 	t.Run(ent.GetTypeName(), func(t *testing.T) {
 		cl := fakectrlruntimeclient.NewFakeClient()
 		mgr, err := ctrl.NewManager(&rest.Config{}, ctrl.Options{
-
 			Scheme: scheme.Get(),
 		})
 		require.NoError(t, err)
 
 		reconciler := NewKonnectEntityReconciler[T, TEnt](sdkFactory, false, cl)
-		require.NoError(t, reconciler.SetupWithManager(mgr))
+		require.NoError(t, reconciler.SetupWithManager(context.Background(), mgr))
 	})
 }
diff --git a/controller/konnect/reconciler_konnectapiauth.go b/controller/konnect/reconciler_konnectapiauth.go
@@ -58,7 +58,7 @@ func NewKonnectAPIAuthConfigurationReconciler(
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *KonnectAPIAuthConfigurationReconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *KonnectAPIAuthConfigurationReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	secretLabelPredicate, err := predicate.LabelSelectorPredicate(
 		metav1.LabelSelector{
 			MatchLabels: map[string]string{

diff --git a/controller/specialized/aigateway_controller.go b/controller/specialized/aigateway_controller.go
@@ -35,7 +35,7 @@ type AIGatewayReconciler struct {
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *AIGatewayReconciler) SetupWithManager(mgr ctrl.Manager) error {
+func (r *AIGatewayReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		// watch AIGateway objects, filtering out any Gateways which are not
 		// configured with a supported GatewayClass controller name.

diff --git a/modules/manager/controller_setup.go b/modules/manager/controller_setup.go
@@ -90,7 +90,7 @@ func SetupControllersShim(mgr manager.Manager, c *Config) ([]ControllerDef, erro
 
 // Controller is a Kubernetes controller that can be plugged into Manager.
 type Controller interface {
-	SetupWithManager(ctrl.Manager) error
+	SetupWithManager(context.Context, ctrl.Manager) error
 }
 
 // AutoHandler decides whether the specific controller shall be enabled (true) or disabled (false).
@@ -109,12 +109,12 @@ func (c *ControllerDef) Name() string {
 
 // MaybeSetupWithManager runs SetupWithManager on the controller if it is enabled
 // and its AutoHandler (if any) indicates that it can load.
-func (c *ControllerDef) MaybeSetupWithManager(mgr ctrl.Manager) error {
+func (c *ControllerDef) MaybeSetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
 	if !c.Enabled {
 		return nil
 	}
 
-	return c.Controller.SetupWithManager(mgr)
+	return c.Controller.SetupWithManager(ctx, mgr)
 }
 
 func setupIndexes(ctx context.Context, mgr manager.Manager, cfg Config) error {

diff --git a/modules/manager/run.go b/modules/manager/run.go
@@ -204,7 +204,9 @@ func Run(
 		return fmt.Errorf("unable to start manager: %w", err)
 	}
 
-	if err := setupIndexes(context.Background(), mgr, cfg); err != nil {
+	ctx := context.Background()
+
+	if err := setupIndexes(ctx, mgr, cfg); err != nil {
 		return err
 	}
 
@@ -218,7 +220,7 @@ func Run(
 			logger: ctrl.Log.WithName("webhook_manager"),
 			cfg:    &cfg,
 		}
-		if err := webhookMgr.PrepareWebhookServerWithControllers(context.Background(), setupControllers, admissionRequestHandler); err != nil {
+		if err := webhookMgr.PrepareWebhookServerWithControllers(ctx, setupControllers, admissionRequestHandler); err != nil {
 			return fmt.Errorf("unable to create webhook server: %w", err)
 		}
 
@@ -239,7 +241,7 @@ func Run(
 			return err
 		}
 		for _, c := range controllers {
-			if err := c.MaybeSetupWithManager(mgr); err != nil {
+			if err := c.MaybeSetupWithManager(ctx, mgr); err != nil {
 				return fmt.Errorf("unable to create controller %q: %w", c.Name(), err)
 			}
 		}
@@ -261,7 +263,7 @@ func Run(
 	// Enable anonnymous reporting when configured but not for development builds
 	// to reduce the noise.
 	if cfg.AnonymousReports && !cfg.DevelopmentMode {
-		stopAnonymousReports, err := setupAnonymousReports(context.Background(), restCfg, setupLog, metadata)
+		stopAnonymousReports, err := setupAnonymousReports(ctx, restCfg, setupLog, metadata)
 		if err != nil {
 			setupLog.Error(err, "failed setting up anonymous reports")
 		} else {

diff --git a/modules/manager/webhook.go b/modules/manager/webhook.go
@@ -160,7 +160,7 @@ func (m *webhookManager) Start(ctx context.Context) error {
 	}
 
 	for _, c := range controllers {
-		if err := c.MaybeSetupWithManager(m.mgr); err != nil {
+		if err := c.MaybeSetupWithManager(ctx, m.mgr); err != nil {
 			return fmt.Errorf("unable to create controller %q: %w", c.Name(), err)
 		}
 	}