Add catalog priority for dependency resolution

Signed-off-by: Harish <[email protected]>

Author: harishsurf

deploy/chart/crds/0000_50_olm_00-catalogsources.crd.yaml

@@ -90,6 +90,17 @@ spec:
                   a registry-server with. Only used when SourceType = SourceTypeGrpc.
                   If present, the address field is ignored.
                 type: string
+              priority:
+                description: 'Priority field assigns a weight to the catalog source
+                  to prioritize them so that it can be consumed by the dependency
+                  resolver. Usage: Higher weight indicates that this catalog source
+                  is preferred over lower weighted catalog sources during dependency
+                  resolution. The range of the priority value can go from positive
+                  to negative in the range of int32. The default value to a catalog
+                  source with unassigned priority would be 0. The catalog source with
+                  the same priority values will be ranked lexicographically based
+                  on its name.'
+                type: integer
               publisher:
                 type: string
               secrets:

deploy/chart/crds/0000_50_olm_00-clusterserviceversions.crd.yaml

@@ -662,13 +662,19 @@ spec:
                       deployments:
                         type: array
                         items:
-                          description: StrategyDeploymentSpec contains the name and
-                            spec for the deployment ALM should create
+                          description: StrategyDeploymentSpec contains the name, spec
+                            and labels for the deployment ALM should create
                           type: object
                           required:
                           - name
                           - spec
                           properties:
+                            label:
+                              description: Set is a map of label:value. It implements
+                                Labels.
+                              type: object
+                              additionalProperties:
+                                type: string
                             name:
                               type: string
                             spec:
@@ -8698,6 +8704,10 @@ spec:
                     containerPort:
                       type: integer
                       format: int32
+                    conversionCRDs:
+                      type: array
+                      items:
+                        type: string
                     deploymentName:
                       type: string
                     failurePolicy:

go.mod

@@ -22,7 +22,7 @@ require (
 	github.com/onsi/gomega v1.9.0
 	github.com/openshift/api v0.0.0-20200331152225-585af27e34fd
 	github.com/openshift/client-go v0.0.0-20200326155132-2a6cd50aedd0
-	github.com/operator-framework/api v0.3.7
+	github.com/operator-framework/api v0.3.9
 	github.com/operator-framework/operator-registry v1.13.3
 	github.com/otiai10/copy v1.2.0
 	github.com/pkg/errors v0.9.1

go.sum

@@ -409,6 +409,8 @@ github.com/grpc-ecosystem/grpc-gateway v1.9.5/go.mod h1:vNeuVxBJEsws4ogUvrchl83t
 github.com/grpc-ecosystem/grpc-health-probe v0.3.2 h1:daShAySXI1DnGc8U9B1E4Qm6o7qzmFR4aRIJ4vY/TUo=
 github.com/grpc-ecosystem/grpc-health-probe v0.3.2/go.mod h1:izVOQ4RWbjUR6lm4nn+VLJyQ+FyaiGmprEYgI04Gs7U=
 github.com/hailocab/go-hostpool v0.0.0-20160125115350-e80d13ce29ed/go.mod h1:tMWxXQ9wFIaZeTI9F+hmhFiGpFmhOHzyShyFUhRm0H4=
+github.com/harishsurf/api v0.3.8-0.20200727161005-2f00961f221d h1:Q9Z/l6BmNar+eqGPRwWFRxnC0F0lFyb/n3x14JTKryM=
+github.com/harishsurf/api v0.3.8-0.20200727161005-2f00961f221d/go.mod h1:Xbje9x0SHmh0nihE21kpesB38vk3cyxnE6JdDS8Jo1Q=
 github.com/hashicorp/errwrap v0.0.0-20141028054710-7554cd9344ce/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/go-multierror v0.0.0-20161216184304-ed905158d874/go.mod h1:JMRHfdO9jKNzS/+BTlxCjKNQHg/jZAft8U7LloJvN7I=
@@ -585,8 +587,8 @@ github.com/openshift/client-go v0.0.0-20200326155132-2a6cd50aedd0 h1:kMiuiZXH1Gd
 github.com/openshift/client-go v0.0.0-20200326155132-2a6cd50aedd0/go.mod h1:uUQ4LClRO+fg5MF/P6QxjMCb1C9f7Oh4RKepftDnEJE=
 github.com/openzipkin/zipkin-go v0.1.6/go.mod h1:QgAqvLzwWbR/WpD4A3cGpPtJrZXNIiJc5AZX7/PBEpw=
 github.com/operator-framework/api v0.3.7-0.20200602203552-431198de9fc2/go.mod h1:Xbje9x0SHmh0nihE21kpesB38vk3cyxnE6JdDS8Jo1Q=
-github.com/operator-framework/api v0.3.7 h1:gTER+WQdjRAegxKdcoylNqHVGGnBRAAgC2zS3CZL78g=
-github.com/operator-framework/api v0.3.7/go.mod h1:Xbje9x0SHmh0nihE21kpesB38vk3cyxnE6JdDS8Jo1Q=
+github.com/operator-framework/api v0.3.9 h1:ggRW5C/7MLmA4cOJ2mjEZ5RqDMsIeMknd6vx15S7Xo4=
+github.com/operator-framework/api v0.3.9/go.mod h1:Xbje9x0SHmh0nihE21kpesB38vk3cyxnE6JdDS8Jo1Q=
 github.com/operator-framework/operator-registry v1.13.3 h1:SaZ1IKLKGizVgTtT8AlDgaMXFYOiIPxRf8KLve0/DXM=
 github.com/operator-framework/operator-registry v1.13.3/go.mod h1:YhnIzOVjRU2ZwZtzt+fjcjW8ujJaSFynBEu7QVKaSdU=
 github.com/otiai10/copy v1.2.0 h1:HvG945u96iNadPoG2/Ja2+AUJeW5YuFQMixq9yirC+k=

pkg/controller/registry/resolver/cache.go

@@ -4,17 +4,18 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sort"
 	"sync"
 	"time"
 
 	"github.com/blang/semver"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 	"github.com/operator-framework/operator-registry/pkg/api"
 	"github.com/operator-framework/operator-registry/pkg/client"
 	opregistry "github.com/operator-framework/operator-registry/pkg/registry"
 	"github.com/sirupsen/logrus"
-
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 )
 
 type RegistryClientProvider interface {
@@ -45,6 +46,7 @@ type OperatorCacheProvider interface {
 type OperatorCache struct {
 	logger    logrus.FieldLogger
 	rcp       RegistryClientProvider
+	crClient  versioned.Interface
 	snapshots map[registry.CatalogKey]*CatalogSnapshot
 	ttl       time.Duration
 	sem       chan struct{}
@@ -53,14 +55,15 @@ type OperatorCache struct {
 
 var _ OperatorCacheProvider = &OperatorCache{}
 
-func NewOperatorCache(rcp RegistryClientProvider, log logrus.FieldLogger) *OperatorCache {
+func NewOperatorCache(rcp RegistryClientProvider, log logrus.FieldLogger, client versioned.Interface) *OperatorCache {
 	const (
 		MaxConcurrentSnapshotUpdates = 4
 	)
 
 	return &OperatorCache{
 		logger:    log,
 		rcp:       rcp,
+		crClient:  client,
 		snapshots: make(map[registry.CatalogKey]*CatalogSnapshot),
 		ttl:       5 * time.Minute,
 		sem:       make(chan struct{}, MaxConcurrentSnapshotUpdates),
@@ -151,11 +154,20 @@ func (c *OperatorCache) Namespaced(namespaces ...string) MultiCatalogOperatorFin
 
 	for _, miss := range misses {
 		ctx, cancel := context.WithTimeout(context.Background(), CachePopulateTimeout)
+
+		catsrcPriority := 0
+		// Ignoring error and treating catalog source priority as 0 if not found
+		catsrc, err := c.crClient.OperatorsV1alpha1().CatalogSources(miss.Namespace).Get(ctx, miss.Name, v1.GetOptions{})
+		if err == nil {
+			catsrcPriority = catsrc.Spec.Priority
+		}
+
 		s := CatalogSnapshot{
-			logger: c.logger.WithField("catalog", miss),
-			key:    miss,
-			expiry: now.Add(c.ttl),
-			pop:    cancel,
+			logger:   c.logger.WithField("catalog", miss),
+			key:      miss,
+			expiry:   now.Add(c.ttl),
+			pop:      cancel,
+			priority: setCatalogPriority(miss, catsrcPriority),
 		}
 		s.m.Lock()
 		c.snapshots[miss] = &s
@@ -277,6 +289,7 @@ type CatalogSnapshot struct {
 	operators []*Operator
 	m         sync.RWMutex
 	pop       context.CancelFunc
+	priority  Priority
 }
 
 func (s *CatalogSnapshot) Cancel() {
@@ -354,6 +367,9 @@ func (s SortableSnapshots) Less(i, j int) bool {
 		return false
 	}
 
+	if s.snapshots[i].priority != s.snapshots[j].priority {
+		return s.snapshots[i].priority.catsrcPriority > s.snapshots[j].priority.catsrcPriority
+	}
 	// the rest are sorted first in namespace preference order, then by name
 	if s.snapshots[i].key.Namespace != s.snapshots[j].key.Namespace {
 		return s.namespaces[s.snapshots[i].key.Namespace] < s.namespaces[s.snapshots[j].key.Namespace]

pkg/controller/registry/resolver/cache_test.go

@@ -13,11 +13,11 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 	"github.com/operator-framework/operator-registry/pkg/api"
 	"github.com/operator-framework/operator-registry/pkg/client"
 	opregistry "github.com/operator-framework/operator-registry/pkg/registry"
-
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
 )
 
 type BundleStreamStub struct {
@@ -85,6 +85,7 @@ func TestOperatorCacheConcurrency(t *testing.T) {
 	)
 
 	rcp := RegistryClientProviderStub{}
+	var crClient versioned.Interface
 	var keys []registry.CatalogKey
 	for i := 0; i < 128; i++ {
 		for j := 0; j < 8; j++ {
@@ -106,7 +107,7 @@ func TestOperatorCacheConcurrency(t *testing.T) {
 		}
 	}
 
-	c := NewOperatorCache(rcp, logrus.New())
+	c := NewOperatorCache(rcp, logrus.New(), crClient)
 
 	errs := make(chan error)
 	for w := 0; w < NWorkers; w++ {
@@ -140,6 +141,7 @@ func TestOperatorCacheConcurrency(t *testing.T) {
 
 func TestOperatorCacheExpiration(t *testing.T) {
 	rcp := RegistryClientProviderStub{}
+	var crClient versioned.Interface
 	key := registry.CatalogKey{Namespace: "dummynamespace", Name: "dummyname"}
 	rcp[key] = &RegistryClientStub{
 		BundleIterator: client.NewBundleIterator(&BundleStreamStub{
@@ -155,14 +157,15 @@ func TestOperatorCacheExpiration(t *testing.T) {
 		}),
 	}
 
-	c := NewOperatorCache(rcp, logrus.New())
+	c := NewOperatorCache(rcp, logrus.New(), crClient)
 	c.ttl = 0 // instantly stale
 
 	require.Len(t, c.Namespaced("dummynamespace").Catalog(key).Find(WithCSVName("csvname")), 1)
 }
 
 func TestOperatorCacheReuse(t *testing.T) {
 	rcp := RegistryClientProviderStub{}
+	var crClient versioned.Interface
 	key := registry.CatalogKey{Namespace: "dummynamespace", Name: "dummyname"}
 	rcp[key] = &RegistryClientStub{
 		BundleIterator: client.NewBundleIterator(&BundleStreamStub{
@@ -178,7 +181,7 @@ func TestOperatorCacheReuse(t *testing.T) {
 		}),
 	}
 
-	c := NewOperatorCache(rcp, logrus.New())
+	c := NewOperatorCache(rcp, logrus.New(), crClient)
 
 	require.Len(t, c.Namespaced("dummynamespace").Catalog(key).Find(WithCSVName("csvname")), 1)
 }
@@ -290,6 +293,7 @@ func TestCatalogSnapshotFind(t *testing.T) {
 
 func TestStripPluralRequiredAndProvidedAPIKeys(t *testing.T) {
 	rcp := RegistryClientProviderStub{}
+	var crClient versioned.Interface
 	key := registry.CatalogKey{Namespace: "testnamespace", Name: "testname"}
 	rcp[key] = &RegistryClientStub{
 		BundleIterator: client.NewBundleIterator(&BundleStreamStub{
@@ -327,7 +331,7 @@ func TestStripPluralRequiredAndProvidedAPIKeys(t *testing.T) {
 		}),
 	}
 
-	c := NewOperatorCache(rcp, logrus.New())
+	c := NewOperatorCache(rcp, logrus.New(), crClient)
 
 	nc := c.Namespaced("testnamespace")
 	result, err := AtLeast(1, nc.Find(ProvidingAPI(opregistry.APIKey{Group: "g", Version: "v1", Kind: "K"})))

pkg/controller/registry/resolver/priority_resolver.go

@@ -0,0 +1,40 @@
+package resolver
+
+import "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
+
+type Priority struct {
+	catsrcPriority int
+}
+
+const (
+	defaultRHCatalogSourceName            = "redhat-operators"
+	defaultCertifiedCatalogSourceName     = "certified-operators"
+	defaultCommunityCatalogSourceName     = "community-operators"
+	defaultRHCatalogSourcePriority        = -100
+	defaultCertifiedCatalogSourcePriority = -200
+	defaultCommunityCatalogSourcePriority = -300
+)
+
+func setCatalogPriority(key registry.CatalogKey, catsrc int) Priority {
+	if catsrc == 0 {
+		return assignDefaultCatalogPriority(key, catsrc)
+	}
+	return Priority{catsrcPriority: catsrc}
+}
+
+func assignDefaultCatalogPriority(key registry.CatalogKey, catsrc int) Priority {
+
+	if key.Name == defaultRHCatalogSourceName {
+		return Priority{catsrcPriority: defaultRHCatalogSourcePriority}
+	}
+
+	if key.Name == defaultCertifiedCatalogSourceName {
+		return Priority{catsrcPriority: defaultCertifiedCatalogSourcePriority}
+	}
+
+	if key.Name == defaultCommunityCatalogSourceName {
+		return Priority{catsrcPriority: defaultCommunityCatalogSourcePriority}
+	}
+
+	return Priority{catsrcPriority: 0}
+}

pkg/controller/registry/resolver/resolver.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
 	"sort"
 
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -24,9 +25,9 @@ type SatResolver struct {
 	log   logrus.FieldLogger
 }
 
-func NewDefaultSatResolver(rcp RegistryClientProvider, log logrus.FieldLogger) *SatResolver {
+func NewDefaultSatResolver(rcp RegistryClientProvider, log logrus.FieldLogger, client versioned.Interface) *SatResolver {
 	return &SatResolver{
-		cache: NewOperatorCache(rcp, log),
+		cache: NewOperatorCache(rcp, log, client),
 		log:   log,
 	}
 }