Add managed label to configmap to reduce cache size

Using managed label to filter relevant configmaps in the cluster
to reduce the configmap cache size.

For catalogsource configmaps, they are created by users and there are
no prexisting labels, there are extra API calls initially to add
the label to migrate those configmaps to the catalog cache.

Signed-off-by: Vu Dinh <[email protected]>

Author: dinhxuanvu

pkg/controller/bundle/bundle_unpacker.go

@@ -26,6 +26,7 @@ import (
 	"github.com/operator-framework/api/pkg/operators/reference"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	listersoperatorsv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/projection"
 )
 
@@ -560,10 +561,25 @@ func (c *ConfigMapUnpacker) ensureConfigmap(csRef *corev1.ObjectReference, name
 	fresh.SetNamespace(csRef.Namespace)
 	fresh.SetName(name)
 	fresh.SetOwnerReferences([]metav1.OwnerReference{ownerRef(csRef)})
+	fresh.SetLabels(map[string]string{install.OLMManagedLabelKey: install.OLMManagedLabelValue})
 
 	cm, err = c.cmLister.ConfigMaps(fresh.GetNamespace()).Get(fresh.GetName())
 	if apierrors.IsNotFound(err) {
 		cm, err = c.client.CoreV1().ConfigMaps(fresh.GetNamespace()).Create(context.TODO(), fresh, metav1.CreateOptions{})
+		// CM already exists in cluster but not in cache, then add the label
+		if err != nil && apierrors.IsAlreadyExists(err) {
+			cm, err = c.client.CoreV1().ConfigMaps(fresh.GetNamespace()).Get(context.TODO(), fresh.GetName(), metav1.GetOptions{})
+			if err != nil {
+				return nil, fmt.Errorf("Failed to retrieve configmap %s: %v", fresh.GetName(), err)
+			}
+			cm.SetLabels(map[string]string{
+				install.OLMManagedLabelKey: install.OLMManagedLabelValue,
+			})
+			cm, err = c.client.CoreV1().ConfigMaps(cm.GetNamespace()).Update(context.TODO(), cm, metav1.UpdateOptions{})
+			if err != nil {
+				return nil, fmt.Errorf("Failed to update configmap %s: %v", cm.GetName(), err)
+			}
+		}
 	}
 
 	return

pkg/controller/bundle/bundle_unpacker_test.go

@@ -19,6 +19,7 @@ import (
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	crfake "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned/fake"
 	crinformers "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/informers/externalversions"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 	"github.com/operator-framework/operator-registry/pkg/api"
 	"github.com/operator-framework/operator-registry/pkg/configmap"
 )
@@ -180,6 +181,7 @@ func TestConfigMapUnpacker(t *testing.T) {
 						ObjectMeta: metav1.ObjectMeta{
 							Name:      pathHash,
 							Namespace: "ns-a",
+							Labels:    map[string]string{install.OLMManagedLabelKey: install.OLMManagedLabelValue},
 							OwnerReferences: []metav1.OwnerReference{
 								{
 									APIVersion:         "operators.coreos.com/v1alpha1",
@@ -570,6 +572,7 @@ func TestConfigMapUnpacker(t *testing.T) {
 						ObjectMeta: metav1.ObjectMeta{
 							Name:      pathHash,
 							Namespace: "ns-a",
+							Labels:    map[string]string{install.OLMManagedLabelKey: install.OLMManagedLabelValue},
 							OwnerReferences: []metav1.OwnerReference{
 								{
 									APIVersion:         "operators.coreos.com/v1alpha1",
@@ -1305,7 +1308,10 @@ func TestConfigMapUnpacker(t *testing.T) {
 
 			period := 5 * time.Minute
 			factory := informers.NewSharedInformerFactory(client, period)
-			cmLister := factory.Core().V1().ConfigMaps().Lister()
+			configMapInformer := informers.NewSharedInformerFactoryWithOptions(client, period, informers.WithTweakListOptions(func(options *metav1.ListOptions) {
+				options.LabelSelector = install.OLMManagedLabelKey
+			})).Core().V1().ConfigMaps()
+			cmLister := configMapInformer.Lister()
 			jobLister := factory.Batch().V1().Jobs().Lister()
 			podLister := factory.Core().V1().Pods().Lister()
 			roleLister := factory.Rbac().V1().Roles().Lister()

pkg/controller/operators/catalog/operator.go

@@ -11,8 +11,6 @@ import (
 	"sync"
 	"time"
 
-	k8serrors "k8s.io/apimachinery/pkg/api/errors"
-
 	errorwrap "github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc/connectivity"
@@ -23,6 +21,7 @@ import (
 	apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	"k8s.io/apiextensions-apiserver/pkg/apiserver/validation"
 	extinf "k8s.io/apiextensions-apiserver/pkg/client/informers/externalversions"
+	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/labels"
@@ -48,6 +47,7 @@ import (
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/informers/externalversions"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/bundle"
 	olmerrors "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/errors"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/subscription"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/grpc"
@@ -341,7 +341,9 @@ func NewOperator(ctx context.Context, kubeconfigPath string, clock utilclock.Clo
 	sharedIndexInformers = append(sharedIndexInformers, buPodInformer.Informer())
 
 	// Wire ConfigMaps
-	configMapInformer := k8sInformerFactory.Core().V1().ConfigMaps()
+	configMapInformer := informers.NewSharedInformerFactoryWithOptions(op.opClient.KubernetesInterface(), resyncPeriod(), informers.WithTweakListOptions(func(options *metav1.ListOptions) {
+		options.LabelSelector = install.OLMManagedLabelKey
+	})).Core().V1().ConfigMaps()
 	op.lister.CoreV1().RegisterConfigMapLister(metav1.NamespaceAll, configMapInformer.Lister())
 	sharedIndexInformers = append(sharedIndexInformers, configMapInformer.Informer())
 
@@ -595,15 +597,31 @@ func (o *Operator) syncConfigMap(logger *logrus.Entry, in *v1alpha1.CatalogSourc
 
 	logger.Debug("checking catsrc configmap state")
 
+	var updateLabel bool
 	// Get the catalog source's config map
 	configMap, err := o.lister.CoreV1().ConfigMapLister().ConfigMaps(in.GetNamespace()).Get(in.Spec.ConfigMap)
+	// Attempt to look up the CM via api call if there is a cache miss
+	if k8serrors.IsNotFound(err) {
+		configMap, err = o.opClient.KubernetesInterface().CoreV1().ConfigMaps(in.GetNamespace()).Get(context.TODO(), in.Spec.ConfigMap, metav1.GetOptions{})
+		// Found cm in the cluster, add managed label to configmap
+		if err == nil {
+			labels := configMap.GetLabels()
+			if labels == nil {
+				labels = make(map[string]string)
+			}
+
+			labels[install.OLMManagedLabelKey] = "false"
+			configMap.SetLabels(labels)
+			updateLabel = true
+		}
+	}
 	if err != nil {
 		syncError = fmt.Errorf("failed to get catalog config map %s: %s", in.Spec.ConfigMap, err)
 		out.SetError(v1alpha1.CatalogSourceConfigMapError, syncError)
 		return
 	}
 
-	if wasOwned := ownerutil.EnsureOwner(configMap, in); !wasOwned {
+	if wasOwned := ownerutil.EnsureOwner(configMap, in); !wasOwned || updateLabel {
 		configMap, err = o.opClient.KubernetesInterface().CoreV1().ConfigMaps(configMap.GetNamespace()).Update(context.TODO(), configMap, metav1.UpdateOptions{})
 		if err != nil {
 			syncError = fmt.Errorf("unable to write owner onto catalog source configmap - %v", err)

pkg/controller/operators/catalog/operator_test.go

@@ -902,7 +902,7 @@ func TestSyncCatalogSources(t *testing.T) {
 				&corev1.ConfigMap{},
 			},
 			expectedStatus: nil,
-			expectedError:  errors.New("failed to get catalog config map cool-configmap: configmap \"cool-configmap\" not found"),
+			expectedError:  errors.New("failed to get catalog config map cool-configmap: configmaps \"cool-configmap\" not found"),
 		},
 		{
 			testName:      "CatalogSourceWithGrpcImage",