Add ClusterFilter to ClusterCache Options

This allows filtering the Clusters that are handled by the cache.
It can be used for example by providers that only want to cache Clusters
of the relevant type to them.

Signed-off-by: Lennart Jern <lennart.jern@est.tech>

Author: lentzi90

controllers/clustercache/cluster_accessor.go

@@ -90,6 +90,11 @@ type clusterAccessorConfig struct {
 
 	// HealthProbe is the configuration for the health probe.
 	HealthProbe *clusterAccessorHealthProbeConfig
+
+	// ClusterFilter is a function that can be used to filter which clusters should be handled
+	// by the ClusterCache. If nil, all clusters will be handled. If set, only clusters for which
+	// the filter returns true will be handled.
+	ClusterFilter ClusterFilter
 }
 
 // clusterAccessorCacheConfig is the config used for the cache that the clusterAccessor creates.

controllers/clustercache/cluster_cache.go

@@ -60,13 +60,22 @@ type Options struct {
 	// will never be created.
 	WatchFilterValue string
 
+	// ClusterFilter is a function that can be used to filter which clusters should be handled
+	// by the ClusterCache. If nil, all clusters will be handled. If set, only clusters for which
+	// the filter returns true will be handled.
+	ClusterFilter ClusterFilter
+
 	// Cache are the cache options for the caches that are created per cluster.
 	Cache CacheOptions
 
 	// Client are the client options for the clients that are created per cluster.
 	Client ClientOptions
 }
 
+// ClusterFilter is a function that filters which clusters should be handled by the ClusterCache.
+// It returns true if the cluster should be handled, false otherwise.
+type ClusterFilter func(cluster *clusterv1.Cluster) bool
+
 // CacheOptions are the cache options for the caches that are created per cluster.
 type CacheOptions struct {
 	// SyncPeriod is the sync period of the cache.
@@ -451,6 +460,15 @@ func (cc *clusterCache) Reconcile(ctx context.Context, req reconcile.Request) (r
 		return ctrl.Result{RequeueAfter: defaultRequeueAfter}, nil
 	}
 
+	// Apply cluster filter if set
+	if cc.clusterAccessorConfig.ClusterFilter != nil && !cc.clusterAccessorConfig.ClusterFilter(cluster) {
+		log.V(6).Info("Cluster filtered out by ClusterFilter, not connecting")
+		accessor.Disconnect(ctx)
+		cc.deleteClusterAccessor(clusterKey)
+		cc.cleanupClusterSourcesForCluster(clusterKey)
+		return ctrl.Result{}, nil
+	}
+
 	// Return if infrastructure is not ready yet to avoid trying to open a connection when it cannot succeed.
 	// Requeue is not needed as there will be a new reconcile.Request when Cluster.status.initialization.infrastructureProvisioned is set.
 	if !ptr.Deref(cluster.Status.Initialization.InfrastructureProvisioned, false) {
@@ -735,5 +753,6 @@ func buildClusterAccessorConfig(scheme *runtime.Scheme, options Options, control
 			Interval:         10 * time.Second,
 			FailureThreshold: 5,
 		},
+		ClusterFilter: options.ClusterFilter,
 	}
 }