pkg/{cluster,manager}: enable configurable caching of unstructured objects

Author: joelanford

pkg/cluster/client_builder.go

@@ -29,6 +29,10 @@ type ClientBuilder interface {
 	// for this client. This function can be called multiple times, it should append to an internal slice.
 	WithUncached(objs ...client.Object) ClientBuilder
 
+	// CacheUnstructured tells the client whether or not to cache unstructured objects and lists. By default,
+	// unstructured objects and list are not cached.
+	CacheUnstructured(v bool) ClientBuilder
+
 	// Build returns a new client.
 	Build(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error)
 }
@@ -39,14 +43,20 @@ func NewClientBuilder() ClientBuilder {
 }
 
 type newClientBuilder struct {
-	uncached []client.Object
+	uncached          []client.Object
+	cacheUnstructured bool
 }
 
 func (n *newClientBuilder) WithUncached(objs ...client.Object) ClientBuilder {
 	n.uncached = append(n.uncached, objs...)
 	return n
 }
 
+func (n *newClientBuilder) CacheUnstructured(v bool) ClientBuilder {
+	n.cacheUnstructured = v
+	return n
+}
+
 func (n *newClientBuilder) Build(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
 	// Create the Client for Write operations.
 	c, err := client.New(config, options)
@@ -55,8 +65,9 @@ func (n *newClientBuilder) Build(cache cache.Cache, config *rest.Config, options
 	}
 
 	return client.NewDelegatingClient(client.NewDelegatingClientInput{
-		CacheReader:     cache,
-		Client:          c,
-		UncachedObjects: n.uncached,
+		CacheReader:       cache,
+		Client:            c,
+		UncachedObjects:   n.uncached,
+		CacheUnstructured: n.cacheUnstructured,
 	})
 }

pkg/cluster/cluster.go

@@ -117,6 +117,10 @@ type Options struct {
 	// for the given objects.
 	ClientDisableCacheFor []client.Object
 
+	// ClientCacheUnstructured tells the client that, if any cache is used, to use it
+	// for unstructured and unstructured list objects.
+	ClientCacheUnstructured bool
+
 	// DryRunClient specifies whether the client should be configured to enforce
 	// dryRun mode.
 	DryRunClient bool
@@ -175,6 +179,7 @@ func New(config *rest.Config, opts ...Option) (Cluster, error) {
 
 	writeObj, err := options.ClientBuilder.
 		WithUncached(options.ClientDisableCacheFor...).
+		CacheUnstructured(options.ClientCacheUnstructured).
 		Build(cache, config, clientOptions)
 	if err != nil {
 		return nil, err

pkg/cluster/cluster_test.go

@@ -43,6 +43,10 @@ func (e *fakeClientBuilder) WithUncached(objs ...client.Object) ClientBuilder {
 	return e
 }
 
+func (e *fakeClientBuilder) CacheUnstructured(_ bool) ClientBuilder {
+	return e
+}
+
 func (e *fakeClientBuilder) Build(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
 	return nil, e.err
 }

pkg/manager/manager.go

@@ -213,6 +213,10 @@ type Options struct {
 	// for the given objects.
 	ClientDisableCacheFor []client.Object
 
+	// ClientCacheUnstructured tells the client that, if any cache is used, to use it
+	// for unstructured and unstructured list objects.
+	ClientCacheUnstructured bool
+
 	// DryRunClient specifies whether the client should be configured to enforce
 	// dryRun mode.
 	DryRunClient bool
@@ -284,6 +288,7 @@ func New(config *rest.Config, options Options) (Manager, error) {
 		clusterOptions.NewCache = options.NewCache
 		clusterOptions.ClientBuilder = options.ClientBuilder
 		clusterOptions.ClientDisableCacheFor = options.ClientDisableCacheFor
+		clusterOptions.ClientCacheUnstructured = options.ClientCacheUnstructured
 		clusterOptions.DryRunClient = options.DryRunClient
 		clusterOptions.EventBroadcaster = options.EventBroadcaster
 	})

pkg/manager/manager_test.go

@@ -62,6 +62,10 @@ func (e *fakeClientBuilder) WithUncached(objs ...client.Object) ClientBuilder {
 	return e
 }
 
+func (e *fakeClientBuilder) CacheUnstructured(_ bool) ClientBuilder {
+	return e
+}
+
 func (e *fakeClientBuilder) Build(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
 	return nil, e.err
 }