Add ManagedClusterAddOn filter functionality to addon framework

This commit introduces a new filtering mechanism for ManagedClusterAddOn objects
to enable selective processing of addons based on custom criteria.

Key changes:
1. Created pkg/utils/addon.go with filter functions:
   - ManagedClusterAddOnFilterFunc type for custom filtering
   - AllowAllAddOns function that accepts all addons
   - FilterTemplateBasedAddOns function that filters template-based addons

2. Updated all addon controllers to accept and use the filter function:
   - addonconfig controller
   - agentdeploy controller
   - certificate controllers (CSR approve/sign)
   - registration controller

3. Added comprehensive test coverage in pkg/utils/addon_test.go

4. Updated BaseAddonManager interface to include mcaFilterFunc parameter

This enables selective processing of addons, particularly useful for
filtering template-based addons vs regular addons based on their
status.configReferences.

🤖 Generated with Claude Code

Co-Authored-By: Claude <[email protected]>
Signed-off-by: zhujian <[email protected]>

Author: zhujian7

pkg/addonmanager/base_manager.go

@@ -77,7 +77,12 @@ func (a *BaseAddonManagerImpl) StartWithInformers(ctx context.Context,
 	kubeInformers kubeinformers.SharedInformerFactory,
 	addonInformers addoninformers.SharedInformerFactory,
 	clusterInformers clusterv1informers.SharedInformerFactory,
-	dynamicInformers dynamicinformer.DynamicSharedInformerFactory) error {
+	dynamicInformers dynamicinformer.DynamicSharedInformerFactory,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
+) error {
+	if mcaFilterFunc == nil {
+		mcaFilterFunc = utils.AllowAllAddOns
+	}
 
 	kubeClient, err := kubernetes.NewForConfig(a.config)
 	if err != nil {
@@ -107,13 +112,15 @@ func (a *BaseAddonManagerImpl) StartWithInformers(ctx context.Context,
 		addonInformers.Addon().V1alpha1().ManagedClusterAddOns(),
 		workInformers,
 		a.addonAgents,
+		mcaFilterFunc,
 	)
 
 	registrationController := registration.NewAddonRegistrationController(
 		addonClient,
 		clusterInformers.Cluster().V1().ManagedClusters(),
 		addonInformers.Addon().V1alpha1().ManagedClusterAddOns(),
 		a.addonAgents,
+		mcaFilterFunc,
 	)
 
 	// This controller is used during migrating addons to be managed by addon-manager.
@@ -135,6 +142,7 @@ func (a *BaseAddonManagerImpl) StartWithInformers(ctx context.Context,
 			dynamicInformers,
 			a.addonConfigs,
 			utils.FilterByAddonName(a.addonAgents),
+			mcaFilterFunc,
 		)
 		managementAddonConfigController = cmaconfig.NewCMAConfigController(
 			addonClient,
@@ -159,13 +167,15 @@ func (a *BaseAddonManagerImpl) StartWithInformers(ctx context.Context,
 			nil,
 			addonInformers.Addon().V1alpha1().ManagedClusterAddOns(),
 			a.addonAgents,
+			mcaFilterFunc,
 		)
 		csrSignController = certificate.NewCSRSignController(
 			kubeClient,
 			clusterInformers.Cluster().V1().ManagedClusters(),
 			kubeInformers.Certificates().V1().CertificateSigningRequests(),
 			addonInformers.Addon().V1alpha1().ManagedClusterAddOns(),
 			a.addonAgents,
+			mcaFilterFunc,
 		)
 	} else if v1beta1Supported {
 		csrApproveController = certificate.NewCSRApprovingController(
@@ -175,6 +185,7 @@ func (a *BaseAddonManagerImpl) StartWithInformers(ctx context.Context,
 			kubeInformers.Certificates().V1beta1().CertificateSigningRequests(),
 			addonInformers.Addon().V1alpha1().ManagedClusterAddOns(),
 			a.addonAgents,
+			mcaFilterFunc,
 		)
 	}
 

pkg/addonmanager/cloudevents/manager.go

@@ -21,6 +21,7 @@ import (
 
 	"open-cluster-management.io/addon-framework/pkg/addonmanager"
 	"open-cluster-management.io/addon-framework/pkg/index"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 	workclientset "open-cluster-management.io/api/client/work/clientset/versioned"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/options"
 	cloudeventswork "open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work"
@@ -176,7 +177,8 @@ func (a *cloudeventsAddonManager) Start(ctx context.Context) error {
 		return err
 	}
 
-	err = a.StartWithInformers(ctx, workClient, workInformers, kubeInformers, addonInformers, clusterInformers, dynamicInformers)
+	err = a.StartWithInformers(ctx, workClient, workInformers, kubeInformers, addonInformers, clusterInformers,
+		dynamicInformers, utils.AllowAllAddOns)
 	if err != nil {
 		return err
 	}

pkg/addonmanager/controllers/addonconfig/controller.go

@@ -37,6 +37,7 @@ type addonConfigController struct {
 	configListers                map[schema.GroupResource]dynamiclister.Lister
 	queue                        workqueue.TypedRateLimitingInterface[string]
 	cmaFilterFunc                factory.EventFilterFunc
+	mcaFilterFunc                utils.ManagedClusterAddOnFilterFunc
 	configGVRs                   map[schema.GroupVersionResource]bool
 	clusterManagementAddonLister addonlisterv1alpha1.ClusterManagementAddOnLister
 }
@@ -48,6 +49,7 @@ func NewAddonConfigController(
 	configInformerFactory dynamicinformer.DynamicSharedInformerFactory,
 	configGVRs map[schema.GroupVersionResource]bool,
 	cmaFilterFunc factory.EventFilterFunc,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
 ) factory.Controller {
 	syncCtx := factory.NewSyncContext(controllerName)
 
@@ -58,6 +60,7 @@ func NewAddonConfigController(
 		configListers:                map[schema.GroupResource]dynamiclister.Lister{},
 		queue:                        syncCtx.Queue(),
 		cmaFilterFunc:                cmaFilterFunc,
+		mcaFilterFunc:                mcaFilterFunc,
 		configGVRs:                   configGVRs,
 		clusterManagementAddonLister: clusterManagementAddonInformers.Lister(),
 	}
@@ -144,6 +147,10 @@ func (c *addonConfigController) sync(ctx context.Context, syncCtx factory.SyncCo
 		return err
 	}
 
+	if c.mcaFilterFunc != nil && !c.mcaFilterFunc(addon) {
+		return nil
+	}
+
 	cma, err := c.clusterManagementAddonLister.Get(addonName)
 	if errors.IsNotFound(err) {
 		// cluster management addon could be deleted, ignore
@@ -153,7 +160,7 @@ func (c *addonConfigController) sync(ctx context.Context, syncCtx factory.SyncCo
 		return err
 	}
 
-	if !c.cmaFilterFunc(cma) {
+	if c.cmaFilterFunc != nil && !c.cmaFilterFunc(cma) {
 		return nil
 	}
 

pkg/addonmanager/controllers/agentdeploy/controller.go

@@ -32,6 +32,7 @@ import (
 	"open-cluster-management.io/addon-framework/pkg/addonmanager/constants"
 	"open-cluster-management.io/addon-framework/pkg/agent"
 	"open-cluster-management.io/addon-framework/pkg/index"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 	"open-cluster-management.io/sdk-go/pkg/basecontroller/factory"
 )
 
@@ -50,6 +51,7 @@ type addonDeployController struct {
 	workIndexer                cache.Indexer
 	agentAddons                map[string]agent.AgentAddon
 	queue                      workqueue.TypedRateLimitingInterface[string]
+	mcaFilterFunc              utils.ManagedClusterAddOnFilterFunc
 }
 
 func NewAddonDeployController(
@@ -59,6 +61,7 @@ func NewAddonDeployController(
 	addonInformers addoninformerv1alpha1.ManagedClusterAddOnInformer,
 	workInformers workinformers.ManifestWorkInformer,
 	agentAddons map[string]agent.AgentAddon,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
 ) factory.Controller {
 	syncCtx := factory.NewSyncContext(controllerName)
 
@@ -74,6 +77,7 @@ func NewAddonDeployController(
 		managedClusterAddonIndexer: addonInformers.Informer().GetIndexer(),
 		workIndexer:                workInformers.Informer().GetIndexer(),
 		agentAddons:                agentAddons,
+		mcaFilterFunc:              mcaFilterFunc,
 	}
 
 	c.setClusterInformerHandler(clusterInformers)
@@ -235,6 +239,10 @@ func (c *addonDeployController) sync(ctx context.Context, syncCtx factory.SyncCo
 		return err
 	}
 
+	if c.mcaFilterFunc != nil && !c.mcaFilterFunc(addon) {
+		return nil
+	}
+
 	// to deploy agents if there is RegistrationApplied condition.
 	if meta.FindStatusCondition(addon.Status.Conditions, addonapiv1alpha1.ManagedClusterAddOnRegistrationApplied) == nil {
 		return nil
@@ -307,7 +315,7 @@ func (c *addonDeployController) sync(ctx context.Context, syncCtx factory.SyncCo
 	}
 
 	if err = c.updateAddon(ctx, addon, oldAddon); err != nil {
-		return err
+		return fmt.Errorf("failed to update addon %s/%s: %w", addon.Namespace, addon.Name, err)
 	}
 	return errorsutil.NewAggregate(errs)
 }
@@ -317,7 +325,10 @@ func (c *addonDeployController) sync(ctx context.Context, syncCtx factory.SyncCo
 func (c *addonDeployController) updateAddon(ctx context.Context, new, old *addonapiv1alpha1.ManagedClusterAddOn) error {
 	if !equality.Semantic.DeepEqual(new.GetFinalizers(), old.GetFinalizers()) {
 		_, err := c.addonClient.AddonV1alpha1().ManagedClusterAddOns(new.Namespace).Update(ctx, new, metav1.UpdateOptions{})
-		return err
+		if err != nil {
+			return fmt.Errorf("failed to update addon finalizers: %w", err)
+		}
+		return nil
 	}
 
 	addonPatcher := patcher.NewPatcher[
@@ -326,7 +337,10 @@ func (c *addonDeployController) updateAddon(ctx context.Context, new, old *addon
 		addonapiv1alpha1.ManagedClusterAddOnStatus](c.addonClient.AddonV1alpha1().ManagedClusterAddOns(new.Namespace))
 
 	_, err := addonPatcher.PatchStatus(ctx, new, new.Status, old.Status)
-	return err
+	if err != nil {
+		return fmt.Errorf("failed to update addon status: %w", err)
+	}
+	return nil
 }
 
 func (c *addonDeployController) applyWork(ctx context.Context, appliedType string,

pkg/addonmanager/controllers/certificate/csrapprove.go

@@ -27,6 +27,7 @@ import (
 	clusterv1 "open-cluster-management.io/api/cluster/v1"
 
 	"open-cluster-management.io/addon-framework/pkg/agent"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 	"open-cluster-management.io/sdk-go/pkg/basecontroller/factory"
 )
 
@@ -58,6 +59,7 @@ type csrApprovingController struct {
 	managedClusterAddonLister addonlisterv1alpha1.ManagedClusterAddOnLister
 	csrLister                 certificateslisters.CertificateSigningRequestLister
 	csrListerBeta             v1beta1certificateslisters.CertificateSigningRequestLister
+	mcaFilterFunc             utils.ManagedClusterAddOnFilterFunc
 }
 
 // NewCSRApprovingController creates a new csr approving controller
@@ -68,6 +70,7 @@ func NewCSRApprovingController(
 	csrBetaInformer v1beta1certificatesinformers.CertificateSigningRequestInformer,
 	addonInformers addoninformerv1alpha1.ManagedClusterAddOnInformer,
 	agentAddons map[string]agent.AgentAddon,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
 ) factory.Controller {
 	if (csrV1Informer != nil) == (csrBetaInformer != nil) {
 		klog.Fatalf("V1 and V1beta1 CSR informer cannot be present or absent at the same time")
@@ -77,6 +80,7 @@ func NewCSRApprovingController(
 		agentAddons:               agentAddons,
 		managedClusterLister:      clusterInformers.Lister(),
 		managedClusterAddonLister: addonInformers.Lister(),
+		mcaFilterFunc:             mcaFilterFunc,
 	}
 	var csrInformer cache.SharedIndexInformer
 	if csrV1Informer != nil {
@@ -162,6 +166,9 @@ func (c *csrApprovingController) sync(ctx context.Context, syncCtx factory.SyncC
 	if err != nil {
 		return err
 	}
+	if c.mcaFilterFunc != nil && !c.mcaFilterFunc(managedClusterAddon) {
+		return nil
+	}
 
 	if registrationOption.CSRApproveCheck == nil {
 		klog.V(4).Infof("addon csr %q cannont be auto approved due to approve check not defined", csr.GetName())

pkg/addonmanager/controllers/certificate/csrsign.go

@@ -22,6 +22,7 @@ import (
 	clusterv1 "open-cluster-management.io/api/cluster/v1"
 
 	"open-cluster-management.io/addon-framework/pkg/agent"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 	"open-cluster-management.io/sdk-go/pkg/basecontroller/factory"
 )
 
@@ -32,6 +33,7 @@ type csrSignController struct {
 	managedClusterLister      clusterlister.ManagedClusterLister
 	managedClusterAddonLister addonlisterv1alpha1.ManagedClusterAddOnLister
 	csrLister                 certificateslisters.CertificateSigningRequestLister
+	mcaFilterFunc             utils.ManagedClusterAddOnFilterFunc
 }
 
 // NewCSRApprovingController creates a new csr approving controller
@@ -41,13 +43,15 @@ func NewCSRSignController(
 	csrInformer certificatesinformers.CertificateSigningRequestInformer,
 	addonInformers addoninformerv1alpha1.ManagedClusterAddOnInformer,
 	agentAddons map[string]agent.AgentAddon,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
 ) factory.Controller {
 	c := &csrSignController{
 		kubeClient:                kubeClient,
 		agentAddons:               agentAddons,
 		managedClusterLister:      clusterInformers.Lister(),
 		managedClusterAddonLister: addonInformers.Lister(),
 		csrLister:                 csrInformer.Lister(),
+		mcaFilterFunc:             mcaFilterFunc,
 	}
 	return factory.New().
 		WithFilteredEventsInformersQueueKeysFunc(
@@ -131,6 +135,9 @@ func (c *csrSignController) sync(ctx context.Context, syncCtx factory.SyncContex
 	if err != nil {
 		return err
 	}
+	if c.mcaFilterFunc != nil && !c.mcaFilterFunc(addon) {
+		return nil
+	}
 
 	if registrationOption.CSRSign == nil {
 		return nil

pkg/addonmanager/controllers/cmaconfig/controller.go

@@ -145,7 +145,7 @@ func (c *cmaConfigController) sync(ctx context.Context, syncCtx factory.SyncCont
 		return err
 	}
 
-	if !c.cmaFilterFunc(cma) {
+	if c.cmaFilterFunc != nil && !c.cmaFilterFunc(cma) {
 		return nil
 	}
 

pkg/addonmanager/controllers/registration/controller.go

@@ -29,19 +29,22 @@ type addonRegistrationController struct {
 	managedClusterLister      clusterlister.ManagedClusterLister
 	managedClusterAddonLister addonlisterv1alpha1.ManagedClusterAddOnLister
 	agentAddons               map[string]agent.AgentAddon
+	mcaFilterFunc             utils.ManagedClusterAddOnFilterFunc
 }
 
 func NewAddonRegistrationController(
 	addonClient addonv1alpha1client.Interface,
 	clusterInformers clusterinformers.ManagedClusterInformer,
 	addonInformers addoninformerv1alpha1.ManagedClusterAddOnInformer,
 	agentAddons map[string]agent.AgentAddon,
+	mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
 ) factory.Controller {
 	c := &addonRegistrationController{
 		addonClient:               addonClient,
 		managedClusterLister:      clusterInformers.Lister(),
 		managedClusterAddonLister: addonInformers.Lister(),
 		agentAddons:               agentAddons,
+		mcaFilterFunc:             mcaFilterFunc,
 	}
 
 	return factory.New().WithFilteredEventsInformersQueueKeysFunc(
@@ -94,6 +97,10 @@ func (c *addonRegistrationController) sync(ctx context.Context, syncCtx factory.
 		return err
 	}
 
+	if c.mcaFilterFunc != nil && !c.mcaFilterFunc(managedClusterAddon) {
+		return nil
+	}
+
 	managedClusterAddonCopy := managedClusterAddon.DeepCopy()
 
 	// wait until the mca's ownerref is set.

pkg/addonmanager/interface.go

@@ -6,6 +6,7 @@ import (
 	"k8s.io/client-go/dynamic/dynamicinformer"
 	kubeinformers "k8s.io/client-go/informers"
 	"open-cluster-management.io/addon-framework/pkg/agent"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 	addoninformers "open-cluster-management.io/api/client/addon/informers/externalversions"
 	clusterv1informers "open-cluster-management.io/api/client/cluster/informers/externalversions"
 	workclientset "open-cluster-management.io/api/client/work/clientset/versioned"
@@ -23,13 +24,19 @@ type BaseAddonManager interface {
 	Trigger(clusterName, addonName string)
 
 	// StartWithInformers starts all registered addon agent with the given informers.
+	// mcaFilterFunc is a filter function that controls which ManagedClusterAddOn objects should be processed.
+	// It can be used to filter addons or wait until addons meet specific criteria before processing.
+	// For example:
+	// - Wait for addon.status.configReferences to contain templates before processing: utils.FilterTemplateBasedAddOns
 	StartWithInformers(ctx context.Context,
 		workClient workclientset.Interface,
 		workInformers workv1informers.ManifestWorkInformer,
 		kubeInformers kubeinformers.SharedInformerFactory,
 		addonInformers addoninformers.SharedInformerFactory,
 		clusterInformers clusterv1informers.SharedInformerFactory,
-		dynamicInformers dynamicinformer.DynamicSharedInformerFactory) error
+		dynamicInformers dynamicinformer.DynamicSharedInformerFactory,
+		mcaFilterFunc utils.ManagedClusterAddOnFilterFunc,
+	) error
 }
 
 // AddonManager is the interface based on BaseAddonManager to initialize a manager on hub

pkg/addonmanager/manager.go

@@ -20,6 +20,7 @@ import (
 	workv1informers "open-cluster-management.io/api/client/work/informers/externalversions"
 
 	"open-cluster-management.io/addon-framework/pkg/index"
+	"open-cluster-management.io/addon-framework/pkg/utils"
 )
 
 // addonManager is the implementation of AddonManager with the base implementation.
@@ -122,7 +123,8 @@ func (a *addonManager) Start(ctx context.Context) error {
 		return err
 	}
 
-	err = a.StartWithInformers(ctx, workClient, workInformers.Work().V1().ManifestWorks(), kubeInformers, addonInformers, clusterInformers, dynamicInformers)
+	err = a.StartWithInformers(ctx, workClient, workInformers.Work().V1().ManifestWorks(), kubeInformers,
+		addonInformers, clusterInformers, dynamicInformers, utils.AllowAllAddOns)
 	if err != nil {
 		return err
 	}