Skip to content

Commit af91f27

Browse files
awgreeneawgreene
committed
Introduce protectedCopiedCSVNamespaces flag
Problem: Users rely on Copied CSVs in order to understand which operators are available in a given namespace. When installing All Namespace operators, a Copied CSV is created in every namespace which can place a huge performance strain on clusters with many namespaces. OLM introduced the ability to disable Copied CSVs for All Namespace mode operators in an effort to resolve the performance issues on large clusters, unfortunately removing the ability for users to identify which operators are available in a given namespace. Solution: The protectedCopiedCSVNamespaces runtime flag can be used to prevent Copied CSVs from being deleted even when Copied CSVs are disabled. An admin can then provide users with the proper RBAC to view which operators are running in All Namespace mode. Signed-off-by: Alexander Greene <[email protected]>
1 parent 83e3ebf commit af91f27

File tree

4 files changed

+178
-87
lines changed

4 files changed

+178
-87
lines changed

Diff for: ‎cmd/olm/main.go

+4
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ var (
6060
tlsKeyPath = pflag.String(
6161
"tls-key", "", "Path to use for private key (requires tls-cert)")
6262

63+
protectedCopiedCSVNamespaces = pflag.String("protectedCopiedCSVNamespaces",
64+
"", "A comma-delimited set of namespaces where global Copied CSVs will always appear, even if Copied CSVs are disabled")
65+
6366
tlsCertPath = pflag.String(
6467
"tls-cert", "", "Path to use for certificate key (requires tls-key)")
6568

@@ -162,6 +165,7 @@ func main() {
162165
olm.WithOperatorClient(opClient),
163166
olm.WithRestConfig(config),
164167
olm.WithConfigClient(versionedConfigClient),
168+
olm.WithProtectedCopiedCSVNamespaces(*protectedCopiedCSVNamespaces),
165169
)
166170
if err != nil {
167171
logger.WithError(err).Fatal("error configuring operator")

Diff for: ‎pkg/controller/operators/olm/config.go

+31-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package olm
22

33
import (
4+
"strings"
45
"time"
56

67
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/queueinformer"
@@ -21,18 +22,19 @@ import (
2122
type OperatorOption func(*operatorConfig)
2223

2324
type operatorConfig struct {
24-
resyncPeriod func() time.Duration
25-
operatorNamespace string
26-
watchedNamespaces []string
27-
clock utilclock.Clock
28-
logger *logrus.Logger
29-
operatorClient operatorclient.ClientInterface
30-
externalClient versioned.Interface
31-
strategyResolver install.StrategyResolverInterface
32-
apiReconciler APIIntersectionReconciler
33-
apiLabeler labeler.Labeler
34-
restConfig *rest.Config
35-
configClient configv1client.Interface
25+
protectedCopiedCSVNamespaces map[string]struct{}
26+
resyncPeriod func() time.Duration
27+
operatorNamespace string
28+
watchedNamespaces []string
29+
clock utilclock.Clock
30+
logger *logrus.Logger
31+
operatorClient operatorclient.ClientInterface
32+
externalClient versioned.Interface
33+
strategyResolver install.StrategyResolverInterface
34+
apiReconciler APIIntersectionReconciler
35+
apiLabeler labeler.Labeler
36+
restConfig *rest.Config
37+
configClient configv1client.Interface
3638
}
3739

3840
func (o *operatorConfig) apply(options []OperatorOption) {
@@ -77,14 +79,15 @@ func (o *operatorConfig) validate() (err error) {
7779

7880
func defaultOperatorConfig() *operatorConfig {
7981
return &operatorConfig{
80-
resyncPeriod: queueinformer.ResyncWithJitter(30*time.Second, 0.2),
81-
operatorNamespace: "default",
82-
watchedNamespaces: []string{metav1.NamespaceAll},
83-
clock: utilclock.RealClock{},
84-
logger: logrus.New(),
85-
strategyResolver: &install.StrategyResolver{},
86-
apiReconciler: APIIntersectionReconcileFunc(ReconcileAPIIntersection),
87-
apiLabeler: labeler.Func(LabelSetsFor),
82+
resyncPeriod: queueinformer.ResyncWithJitter(30*time.Second, 0.2),
83+
operatorNamespace: "default",
84+
watchedNamespaces: []string{metav1.NamespaceAll},
85+
clock: utilclock.RealClock{},
86+
logger: logrus.New(),
87+
strategyResolver: &install.StrategyResolver{},
88+
apiReconciler: APIIntersectionReconcileFunc(ReconcileAPIIntersection),
89+
apiLabeler: labeler.Func(LabelSetsFor),
90+
protectedCopiedCSVNamespaces: map[string]struct{}{},
8891
}
8992
}
9093

@@ -112,6 +115,14 @@ func WithLogger(logger *logrus.Logger) OperatorOption {
112115
}
113116
}
114117

118+
func WithProtectedCopiedCSVNamespaces(namespaces string) OperatorOption {
119+
return func(config *operatorConfig) {
120+
for _, ns := range strings.Split(namespaces, ",") {
121+
config.protectedCopiedCSVNamespaces[ns] = struct{}{}
122+
}
123+
}
124+
}
125+
115126
func WithClock(clock utilclock.Clock) OperatorOption {
116127
return func(config *operatorConfig) {
117128
config.clock = clock

Diff for: ‎pkg/controller/operators/olm/operator.go

+98-62
Original file line numberDiff line numberDiff line change
@@ -63,32 +63,33 @@ var (
6363
type Operator struct {
6464
queueinformer.Operator
6565

66-
clock utilclock.Clock
67-
logger *logrus.Logger
68-
opClient operatorclient.ClientInterface
69-
client versioned.Interface
70-
lister operatorlister.OperatorLister
71-
copiedCSVLister operatorsv1alpha1listers.ClusterServiceVersionLister
72-
ogQueueSet *queueinformer.ResourceQueueSet
73-
csvQueueSet *queueinformer.ResourceQueueSet
74-
olmConfigQueue workqueue.RateLimitingInterface
75-
csvCopyQueueSet *queueinformer.ResourceQueueSet
76-
copiedCSVGCQueueSet *queueinformer.ResourceQueueSet
77-
objGCQueueSet *queueinformer.ResourceQueueSet
78-
nsQueueSet workqueue.RateLimitingInterface
79-
apiServiceQueue workqueue.RateLimitingInterface
80-
csvIndexers map[string]cache.Indexer
81-
recorder record.EventRecorder
82-
resolver install.StrategyResolverInterface
83-
apiReconciler APIIntersectionReconciler
84-
apiLabeler labeler.Labeler
85-
csvSetGenerator csvutility.SetGenerator
86-
csvReplaceFinder csvutility.ReplaceFinder
87-
csvNotification csvutility.WatchNotification
88-
serviceAccountSyncer *scoped.UserDefinedServiceAccountSyncer
89-
clientAttenuator *scoped.ClientAttenuator
90-
serviceAccountQuerier *scoped.UserDefinedServiceAccountQuerier
91-
clientFactory clients.Factory
66+
clock utilclock.Clock
67+
logger *logrus.Logger
68+
opClient operatorclient.ClientInterface
69+
client versioned.Interface
70+
lister operatorlister.OperatorLister
71+
protectedCopiedCSVNamespaces map[string]struct{}
72+
copiedCSVLister operatorsv1alpha1listers.ClusterServiceVersionLister
73+
ogQueueSet *queueinformer.ResourceQueueSet
74+
csvQueueSet *queueinformer.ResourceQueueSet
75+
olmConfigQueue workqueue.RateLimitingInterface
76+
csvCopyQueueSet *queueinformer.ResourceQueueSet
77+
copiedCSVGCQueueSet *queueinformer.ResourceQueueSet
78+
objGCQueueSet *queueinformer.ResourceQueueSet
79+
nsQueueSet workqueue.RateLimitingInterface
80+
apiServiceQueue workqueue.RateLimitingInterface
81+
csvIndexers map[string]cache.Indexer
82+
recorder record.EventRecorder
83+
resolver install.StrategyResolverInterface
84+
apiReconciler APIIntersectionReconciler
85+
apiLabeler labeler.Labeler
86+
csvSetGenerator csvutility.SetGenerator
87+
csvReplaceFinder csvutility.ReplaceFinder
88+
csvNotification csvutility.WatchNotification
89+
serviceAccountSyncer *scoped.UserDefinedServiceAccountSyncer
90+
clientAttenuator *scoped.ClientAttenuator
91+
serviceAccountQuerier *scoped.UserDefinedServiceAccountQuerier
92+
clientFactory clients.Factory
9293
}
9394

9495
func NewOperator(ctx context.Context, options ...OperatorOption) (*Operator, error) {
@@ -121,30 +122,31 @@ func newOperatorWithConfig(ctx context.Context, config *operatorConfig) (*Operat
121122
}
122123

123124
op := &Operator{
124-
Operator: queueOperator,
125-
clock: config.clock,
126-
logger: config.logger,
127-
opClient: config.operatorClient,
128-
client: config.externalClient,
129-
ogQueueSet: queueinformer.NewEmptyResourceQueueSet(),
130-
csvQueueSet: queueinformer.NewEmptyResourceQueueSet(),
131-
olmConfigQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "olmConfig"),
132-
csvCopyQueueSet: queueinformer.NewEmptyResourceQueueSet(),
133-
copiedCSVGCQueueSet: queueinformer.NewEmptyResourceQueueSet(),
134-
objGCQueueSet: queueinformer.NewEmptyResourceQueueSet(),
135-
apiServiceQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "apiservice"),
136-
resolver: config.strategyResolver,
137-
apiReconciler: config.apiReconciler,
138-
lister: lister,
139-
recorder: eventRecorder,
140-
apiLabeler: config.apiLabeler,
141-
csvIndexers: map[string]cache.Indexer{},
142-
csvSetGenerator: csvutility.NewSetGenerator(config.logger, lister),
143-
csvReplaceFinder: csvutility.NewReplaceFinder(config.logger, config.externalClient),
144-
serviceAccountSyncer: scoped.NewUserDefinedServiceAccountSyncer(config.logger, scheme, config.operatorClient, config.externalClient),
145-
clientAttenuator: scoped.NewClientAttenuator(config.logger, config.restConfig, config.operatorClient),
146-
serviceAccountQuerier: scoped.NewUserDefinedServiceAccountQuerier(config.logger, config.externalClient),
147-
clientFactory: clients.NewFactory(config.restConfig),
125+
Operator: queueOperator,
126+
clock: config.clock,
127+
logger: config.logger,
128+
opClient: config.operatorClient,
129+
client: config.externalClient,
130+
ogQueueSet: queueinformer.NewEmptyResourceQueueSet(),
131+
csvQueueSet: queueinformer.NewEmptyResourceQueueSet(),
132+
olmConfigQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "olmConfig"),
133+
csvCopyQueueSet: queueinformer.NewEmptyResourceQueueSet(),
134+
copiedCSVGCQueueSet: queueinformer.NewEmptyResourceQueueSet(),
135+
objGCQueueSet: queueinformer.NewEmptyResourceQueueSet(),
136+
apiServiceQueue: workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "apiservice"),
137+
resolver: config.strategyResolver,
138+
apiReconciler: config.apiReconciler,
139+
lister: lister,
140+
recorder: eventRecorder,
141+
apiLabeler: config.apiLabeler,
142+
csvIndexers: map[string]cache.Indexer{},
143+
csvSetGenerator: csvutility.NewSetGenerator(config.logger, lister),
144+
csvReplaceFinder: csvutility.NewReplaceFinder(config.logger, config.externalClient),
145+
serviceAccountSyncer: scoped.NewUserDefinedServiceAccountSyncer(config.logger, scheme, config.operatorClient, config.externalClient),
146+
clientAttenuator: scoped.NewClientAttenuator(config.logger, config.restConfig, config.operatorClient),
147+
serviceAccountQuerier: scoped.NewUserDefinedServiceAccountQuerier(config.logger, config.externalClient),
148+
clientFactory: clients.NewFactory(config.restConfig),
149+
protectedCopiedCSVNamespaces: config.protectedCopiedCSVNamespaces,
148150
}
149151

150152
// Set up syncing for namespace-scoped resources
@@ -1299,20 +1301,37 @@ func (a *Operator) syncOLMConfig(obj interface{}) (syncError error) {
12991301
return err
13001302
}
13011303

1302-
// Filter to unique copies
1303-
uniqueCopiedCSVs := map[string]struct{}{}
1304+
copiedCSVCount := map[string]int{}
13041305
for _, copiedCSV := range copiedCSVs {
1305-
uniqueCopiedCSVs[copiedCSV.GetName()] = struct{}{}
1306+
copiedCSVCount[copiedCSV.GetName()] = copiedCSVCount[copiedCSV.GetName()] + 1
13061307
}
13071308

13081309
csvs, err := a.lister.OperatorsV1alpha1().ClusterServiceVersionLister().ClusterServiceVersions(og.GetNamespace()).List(labels.NewSelector().Add(*nonCopiedCSVRequirement))
13091310
if err != nil {
13101311
return err
13111312
}
13121313

1314+
namespaces, err := a.lister.CoreV1().NamespaceLister().List(labels.Everything())
1315+
if err != nil {
1316+
return err
1317+
}
1318+
1319+
expectedCopiedCSVCount := 0
1320+
if olmConfig.CopiedCSVsAreEnabled() {
1321+
for _, ns := range namespaces {
1322+
// If the namespace isn't being deleted and doesn't contain the original CSV
1323+
if ns.Status.Phase == corev1.NamespaceActive && og.GetNamespace() != ns.GetName() {
1324+
expectedCopiedCSVCount++
1325+
}
1326+
}
1327+
} else {
1328+
expectedCopiedCSVCount = len(a.protectedCopiedCSVNamespaces)
1329+
}
1330+
13131331
for _, csv := range csvs {
1314-
// If the correct number of copied CSVs were found, continue
1315-
if _, ok := uniqueCopiedCSVs[csv.GetName()]; ok == olmConfig.CopiedCSVsAreEnabled() {
1332+
numberOfCopiedCSVs := copiedCSVCount[csv.GetName()]
1333+
// Ignore NS where actual CSV is installed
1334+
if numberOfCopiedCSVs == expectedCopiedCSVCount {
13161335
continue
13171336
}
13181337

@@ -1324,7 +1343,7 @@ func (a *Operator) syncOLMConfig(obj interface{}) (syncError error) {
13241343
}
13251344

13261345
// Update the olmConfig status if it has changed.
1327-
condition := getCopiedCSVsCondition(!olmConfig.CopiedCSVsAreEnabled(), csvIsRequeued)
1346+
condition := getCopiedCSVsCondition(olmConfig.CopiedCSVsAreEnabled(), csvIsRequeued)
13281347
if !isStatusConditionPresentAndAreTypeReasonMessageStatusEqual(olmConfig.Status.Conditions, condition) {
13291348
meta.SetStatusCondition(&olmConfig.Status.Conditions, condition)
13301349
if _, err := a.client.OperatorsV1().OLMConfigs().UpdateStatus(context.TODO(), olmConfig, metav1.UpdateOptions{}); err != nil {
@@ -1346,13 +1365,13 @@ func isStatusConditionPresentAndAreTypeReasonMessageStatusEqual(conditions []met
13461365
foundCondition.Status == condition.Status
13471366
}
13481367

1349-
func getCopiedCSVsCondition(isDisabled, csvIsRequeued bool) metav1.Condition {
1368+
func getCopiedCSVsCondition(enabled, csvIsRequeued bool) metav1.Condition {
13501369
condition := metav1.Condition{
13511370
Type: operatorsv1.DisabledCopiedCSVsConditionType,
13521371
LastTransitionTime: metav1.Now(),
13531372
Status: metav1.ConditionFalse,
13541373
}
1355-
if !isDisabled {
1374+
if enabled {
13561375
condition.Reason = "CopiedCSVsEnabled"
13571376
condition.Message = "Copied CSVs are enabled and present across the cluster"
13581377
if csvIsRequeued {
@@ -1361,15 +1380,14 @@ func getCopiedCSVsCondition(isDisabled, csvIsRequeued bool) metav1.Condition {
13611380
return condition
13621381
}
13631382

1383+
condition.Reason = "CopiedCSVsDisabled"
13641384
if csvIsRequeued {
1365-
condition.Reason = "CopiedCSVsFound"
1366-
condition.Message = "Copied CSVs are disabled and at least one copied CSV was found for an operator installed in AllNamespace mode"
1385+
condition.Message = "Copied CSVs are disabled and at least one unexpected copied CSV was found for an operator installed in AllNamespace mode"
13671386
return condition
13681387
}
13691388

13701389
condition.Status = metav1.ConditionTrue
1371-
condition.Reason = "NoCopiedCSVsFound"
1372-
condition.Message = "Copied CSVs are disabled and none were found for operators installed in AllNamespace mode"
1390+
condition.Message = "Copied CSVs are disabled and no unexpected copied CSVs were found for operators installed in AllNamespace mode"
13731391

13741392
return condition
13751393
}
@@ -1444,7 +1462,25 @@ func (a *Operator) syncCopyCSV(obj interface{}) (syncError error) {
14441462
return err
14451463
}
14461464

1465+
// Ensure that the Copied CSVs exist in the protected namespaces.
1466+
protectedNamespaces := []string{}
1467+
for ns := range a.protectedCopiedCSVNamespaces {
1468+
if ns == clusterServiceVersion.GetNamespace() {
1469+
continue
1470+
}
1471+
protectedNamespaces = append(protectedNamespaces, ns)
1472+
}
1473+
1474+
if err := a.ensureCSVsInNamespaces(clusterServiceVersion, operatorGroup, NewNamespaceSet(protectedNamespaces)); err != nil {
1475+
logger.WithError(err).Info("couldn't copy CSV to protected Copied CSV namespaces")
1476+
syncError = err
1477+
}
1478+
1479+
// Delete Copied CSVs in namespaces that are not protected.
14471480
for _, copiedCSV := range copiedCSVs {
1481+
if _, ok := a.protectedCopiedCSVNamespaces[copiedCSV.Namespace]; ok {
1482+
continue
1483+
}
14481484
err := a.client.OperatorsV1alpha1().ClusterServiceVersions(copiedCSV.Namespace).Delete(context.TODO(), copiedCSV.Name, metav1.DeleteOptions{})
14491485
if err != nil && !apierrors.IsNotFound(err) {
14501486
return err

0 commit comments

Comments
 (0)