Use GetLocalManager() in multi-cluster manager instead of creating a new local manager

Signed-off-by: Shingo Omura <[email protected]>

Author: everpeace

examples/cluster-inventory-api/main.go

@@ -58,14 +58,9 @@ func main() {
 		entryLog.Error(err, "unable to get kubeconfig")
 		os.Exit(1)
 	}
-	localMgr, err := manager.New(cfg, manager.Options{})
-	if err != nil {
-		entryLog.Error(err, "unable to set up overall controller manager")
-		os.Exit(1)
-	}
 
 	// Create the provider against the local manager.
-	provider, err := clusterinventoryapi.New(localMgr, clusterinventoryapi.Options{
+	provider := clusterinventoryapi.New(clusterinventoryapi.Options{
 		ConsumerName: "cluster-inventory-api-consumer",
 	})
 	if err != nil {
@@ -86,6 +81,12 @@ func main() {
 		os.Exit(1)
 	}
 
+	// Setting up the provider with multi-cluster manager.
+	if err := provider.SetupWithManager(mcMgr); err != nil {
+		entryLog.Error(err, "unable to set up provider with manager")
+		os.Exit(1)
+	}
+
 	// Create a configmap controller in the multi-cluster manager.
 	if err := mcbuilder.ControllerManagedBy(mcMgr).
 		Named("multicluster-configmaps").
@@ -119,12 +120,6 @@ func main() {
 
 	// Starting everything.
 	g, ctx := errgroup.WithContext(ctx)
-	g.Go(func() error {
-		return ignoreCanceled(localMgr.Start(ctx))
-	})
-	g.Go(func() error {
-		return ignoreCanceled(provider.Run(ctx, mcMgr))
-	})
 	g.Go(func() error {
 		return ignoreCanceled(mcMgr.Start(ctx))
 	})

providers/cluster-inventory-api/provider.go

@@ -41,7 +41,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
@@ -193,17 +192,32 @@ func setDefaults(opts *Options, cli client.Client) {
 }
 
 // New creates a new Cluster Inventory API cluster Provider.
-func New(localMgr manager.Manager, opts Options) (*Provider, error) {
+// You must call SetupWithManager to set up the provider with the manager.
+func New(opts Options) *Provider {
 	p := &Provider{
 		opts:       opts,
 		log:        log.Log.WithName("cluster-inventory-api-cluster-provider"),
-		client:     localMgr.GetClient(),
 		clusters:   map[string]cluster.Cluster{},
 		cancelFns:  map[string]context.CancelFunc{},
 		kubeconfig: map[string]*rest.Config{},
 	}
-
 	setDefaults(&p.opts, p.client)
+	return p
+}
+
+// SetupWithManager sets up the provider with the manager.
+func (p *Provider) SetupWithManager(mgr mcmanager.Manager) error {
+	if mgr == nil {
+		return fmt.Errorf("manager is nil")
+	}
+	p.mcMgr = mgr
+
+	// Get the local manager from the multi-cluster manager.
+	localMgr := mgr.GetLocalManager()
+	if localMgr == nil {
+		return fmt.Errorf("local manager is nil")
+	}
+	p.client = localMgr.GetClient()
 
 	// Create a controller builder
 	controllerBuilder := builder.ControllerManagedBy(localMgr).
@@ -221,10 +235,10 @@ func New(localMgr manager.Manager, opts Options) (*Provider, error) {
 
 	// Complete the controller setup
 	if err := controllerBuilder.Complete(p); err != nil {
-		return nil, fmt.Errorf("failed to create controller: %w", err)
+		return fmt.Errorf("failed to create controller: %w", err)
 	}
 
-	return p, nil
+	return nil
 }
 
 // Get returns the cluster with the given name, if it is known.
@@ -238,19 +252,7 @@ func (p *Provider) Get(_ context.Context, clusterName string) (cluster.Cluster,
 	return nil, multicluster.ErrClusterNotFound
 }
 
-// Run starts the provider and blocks.
-func (p *Provider) Run(ctx context.Context, mgr mcmanager.Manager) error {
-	p.log.Info("Starting Cluster Inventory API cluster provider")
-
-	p.lock.Lock()
-	p.mcMgr = mgr
-	p.lock.Unlock()
-
-	<-ctx.Done()
-
-	return ctx.Err()
-}
-
+// Reconcile is the reconcile loop for the Cluster Inventory API cluster Provider.
 func (p *Provider) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
 	key := req.NamespacedName.String()
 

providers/cluster-inventory-api/provider_test.go

@@ -58,7 +58,6 @@ var _ = Describe("Provider Cluster Inventory API", Ordered, func() {
 	g, ctx := errgroup.WithContext(ctx)
 
 	const consumerName = "hub"
-	var localMgr manager.Manager
 	var provider *Provider
 	var mgr mcmanager.Manager
 
@@ -77,17 +76,10 @@ var _ = Describe("Provider Cluster Inventory API", Ordered, func() {
 		cliMember, err = client.New(cfgMember, client.Options{})
 		Expect(err).NotTo(HaveOccurred())
 
-		By("Setting up the Local manager", func() {
-			localMgr, err = manager.New(cfgHub, manager.Options{})
-			Expect(err).NotTo(HaveOccurred())
-		})
-
 		By("Setting up the Provider", func() {
-			var err error
-			provider, err = New(localMgr, Options{
+			provider = New(Options{
 				ConsumerName: consumerName,
 			})
-			Expect(err).NotTo(HaveOccurred())
 			Expect(provider).NotTo(BeNil())
 		})
 
@@ -97,6 +89,11 @@ var _ = Describe("Provider Cluster Inventory API", Ordered, func() {
 			Expect(err).NotTo(HaveOccurred())
 		})
 
+		By("Setting up the provider controller", func() {
+			err := provider.SetupWithManager(mgr)
+			Expect(err).NotTo(HaveOccurred())
+		})
+
 		By("Setting up the controller feeding the animals", func() {
 			err := mcbuilder.ControllerManagedBy(mgr).
 				Named("fleet-configmap-controller").
@@ -142,14 +139,7 @@ var _ = Describe("Provider Cluster Inventory API", Ordered, func() {
 		})
 
 		By("Starting the provider, cluster, manager, and controller", func() {
-			g.Go(func() error {
-				err := localMgr.Start(ctx)
-				return ignoreCanceled(err)
-			})
-			g.Go(func() error {
-				err := provider.Run(ctx, mgr)
-				return ignoreCanceled(err)
-			})
+
 			g.Go(func() error {
 				err := mgr.Start(ctx)
 				return ignoreCanceled(err)