forked from operator-framework/operator-lifecycle-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoperator.go
2544 lines (2215 loc) · 89.9 KB
/
operator.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package catalog
import (
"context"
"encoding/json"
"errors"
"fmt"
"reflect"
"sort"
"strings"
"sync"
"time"
errorwrap "github.com/pkg/errors"
"github.com/sirupsen/logrus"
"google.golang.org/grpc/connectivity"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
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"
apierrors "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"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/selection"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/apimachinery/pkg/util/yaml"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/informers"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
"k8s.io/client-go/util/workqueue"
utilclock "k8s.io/utils/clock"
"github.com/operator-framework/api/pkg/operators/reference"
operatorsv1 "github.com/operator-framework/api/pkg/operators/v1"
"github.com/operator-framework/api/pkg/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/informers/externalversions"
operatorsv1alpha1listers "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
"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/operators/internal/pruning"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/grpc"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/reconciler"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver"
resolvercache "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/solver"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/catalogsource"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/clients"
controllerclient "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/controller-runtime/client"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/event"
index "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/index"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorlister"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/queueinformer"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/scoped"
sharedtime "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/time"
"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
)
const (
crdKind = "CustomResourceDefinition"
secretKind = "Secret"
clusterRoleKind = "ClusterRole"
clusterRoleBindingKind = "ClusterRoleBinding"
configMapKind = "ConfigMap"
csvKind = "ClusterServiceVersion"
serviceAccountKind = "ServiceAccount"
serviceKind = "Service"
roleKind = "Role"
roleBindingKind = "RoleBinding"
generatedByKey = "olm.generated-by"
maxInstallPlanCount = 5
maxDeletesPerSweep = 5
RegistryFieldManager = "olm.registry"
)
// Operator represents a Kubernetes operator that executes InstallPlans by
// resolving dependencies in a catalog.
type Operator struct {
queueinformer.Operator
logger *logrus.Logger
clock utilclock.Clock
opClient operatorclient.ClientInterface
client versioned.Interface
dynamicClient dynamic.Interface
lister operatorlister.OperatorLister
catsrcQueueSet *queueinformer.ResourceQueueSet
subQueueSet *queueinformer.ResourceQueueSet
ipQueueSet *queueinformer.ResourceQueueSet
ogQueueSet *queueinformer.ResourceQueueSet
nsResolveQueue workqueue.RateLimitingInterface
namespace string
recorder record.EventRecorder
sources *grpc.SourceStore
sourcesLastUpdate sharedtime.SharedTime
resolver resolver.StepResolver
reconciler reconciler.RegistryReconcilerFactory
catalogSubscriberIndexer map[string]cache.Indexer
clientAttenuator *scoped.ClientAttenuator
serviceAccountQuerier *scoped.UserDefinedServiceAccountQuerier
bundleUnpacker bundle.Unpacker
installPlanTimeout time.Duration
bundleUnpackTimeout time.Duration
clientFactory clients.Factory
muInstallPlan sync.Mutex
sourceInvalidator *resolver.RegistrySourceProvider
}
type CatalogSourceSyncFunc func(logger *logrus.Entry, in *v1alpha1.CatalogSource) (out *v1alpha1.CatalogSource, continueSync bool, syncError error)
// NewOperator creates a new Catalog Operator.
func NewOperator(ctx context.Context, kubeconfigPath string, clock utilclock.Clock, logger *logrus.Logger, resync time.Duration, configmapRegistryImage, opmImage, utilImage string, operatorNamespace string, scheme *runtime.Scheme, installPlanTimeout time.Duration, bundleUnpackTimeout time.Duration, workloadUserID int64) (*Operator, error) {
resyncPeriod := queueinformer.ResyncWithJitter(resync, 0.2)
config, err := clientcmd.BuildConfigFromFlags("", kubeconfigPath)
if err != nil {
return nil, err
}
// Create a new client for OLM types (CRs)
crClient, err := versioned.NewForConfig(config)
if err != nil {
return nil, err
}
// Create a new client for dynamic types (CRs)
dynamicClient, err := dynamic.NewForConfig(config)
if err != nil {
return nil, err
}
// Create a new queueinformer-based operator.
opClient, err := operatorclient.NewClientFromRestConfig(config)
if err != nil {
return nil, err
}
queueOperator, err := queueinformer.NewOperator(opClient.KubernetesInterface().Discovery(), queueinformer.WithOperatorLogger(logger))
if err != nil {
return nil, err
}
// Create an OperatorLister
lister := operatorlister.NewLister()
// eventRecorder can emit events
eventRecorder, err := event.NewRecorder(opClient.KubernetesInterface().CoreV1().Events(metav1.NamespaceAll))
if err != nil {
return nil, err
}
ssaClient, err := controllerclient.NewForConfig(config, scheme, RegistryFieldManager)
if err != nil {
return nil, err
}
// Allocate the new instance of an Operator.
op := &Operator{
Operator: queueOperator,
logger: logger,
clock: clock,
opClient: opClient,
dynamicClient: dynamicClient,
client: crClient,
lister: lister,
namespace: operatorNamespace,
recorder: eventRecorder,
catsrcQueueSet: queueinformer.NewEmptyResourceQueueSet(),
subQueueSet: queueinformer.NewEmptyResourceQueueSet(),
ipQueueSet: queueinformer.NewEmptyResourceQueueSet(),
ogQueueSet: queueinformer.NewEmptyResourceQueueSet(),
catalogSubscriberIndexer: map[string]cache.Indexer{},
serviceAccountQuerier: scoped.NewUserDefinedServiceAccountQuerier(logger, crClient),
clientAttenuator: scoped.NewClientAttenuator(logger, config, opClient),
installPlanTimeout: installPlanTimeout,
bundleUnpackTimeout: bundleUnpackTimeout,
clientFactory: clients.NewFactory(config),
}
op.sources = grpc.NewSourceStore(logger, 10*time.Second, 10*time.Minute, op.syncSourceState)
op.sourceInvalidator = resolver.SourceProviderFromRegistryClientProvider(op.sources, logger)
resolverSourceProvider := NewOperatorGroupToggleSourceProvider(op.sourceInvalidator, logger, op.lister.OperatorsV1().OperatorGroupLister())
op.reconciler = reconciler.NewRegistryReconcilerFactory(lister, opClient, configmapRegistryImage, op.now, ssaClient, workloadUserID)
res := resolver.NewOperatorStepResolver(lister, crClient, operatorNamespace, resolverSourceProvider, logger)
op.resolver = resolver.NewInstrumentedResolver(res, metrics.RegisterDependencyResolutionSuccess, metrics.RegisterDependencyResolutionFailure)
// Wire OLM CR sharedIndexInformers
crInformerFactory := externalversions.NewSharedInformerFactoryWithOptions(op.client, resyncPeriod())
// Fields are pruned from local copies of the objects managed
// by this informer in order to reduce cached size.
prunedCSVInformer := cache.NewSharedIndexInformer(
pruning.NewListerWatcher(op.client, metav1.NamespaceAll,
func(options *metav1.ListOptions) {
options.LabelSelector = fmt.Sprintf("!%s", v1alpha1.CopiedLabelKey)
},
pruning.PrunerFunc(func(csv *v1alpha1.ClusterServiceVersion) {
*csv = v1alpha1.ClusterServiceVersion{
TypeMeta: csv.TypeMeta,
ObjectMeta: metav1.ObjectMeta{
Name: csv.Name,
Namespace: csv.Namespace,
Labels: csv.Labels,
Annotations: csv.Annotations,
},
Spec: v1alpha1.ClusterServiceVersionSpec{
CustomResourceDefinitions: csv.Spec.CustomResourceDefinitions,
APIServiceDefinitions: csv.Spec.APIServiceDefinitions,
Replaces: csv.Spec.Replaces,
Version: csv.Spec.Version,
},
Status: v1alpha1.ClusterServiceVersionStatus{
Phase: csv.Status.Phase,
Reason: csv.Status.Reason,
},
}
})),
&v1alpha1.ClusterServiceVersion{},
resyncPeriod(),
cache.Indexers{
cache.NamespaceIndex: cache.MetaNamespaceIndexFunc,
},
)
csvLister := operatorsv1alpha1listers.NewClusterServiceVersionLister(prunedCSVInformer.GetIndexer())
op.lister.OperatorsV1alpha1().RegisterClusterServiceVersionLister(metav1.NamespaceAll, csvLister)
if err := op.RegisterInformer(prunedCSVInformer); err != nil {
return nil, err
}
// TODO: Add namespace resolve sync
// Wire InstallPlans
ipInformer := crInformerFactory.Operators().V1alpha1().InstallPlans()
op.lister.OperatorsV1alpha1().RegisterInstallPlanLister(metav1.NamespaceAll, ipInformer.Lister())
ipQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "ips")
op.ipQueueSet.Set(metav1.NamespaceAll, ipQueue)
ipQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithMetricsProvider(metrics.NewMetricsInstallPlan(op.lister.OperatorsV1alpha1().InstallPlanLister())),
queueinformer.WithLogger(op.logger),
queueinformer.WithQueue(ipQueue),
queueinformer.WithInformer(ipInformer.Informer()),
queueinformer.WithSyncer(queueinformer.LegacySyncHandler(op.syncInstallPlans).ToSyncer()),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(ipQueueInformer); err != nil {
return nil, err
}
operatorGroupInformer := crInformerFactory.Operators().V1().OperatorGroups()
op.lister.OperatorsV1().RegisterOperatorGroupLister(metav1.NamespaceAll, operatorGroupInformer.Lister())
ogQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "ogs")
op.ogQueueSet.Set(metav1.NamespaceAll, ogQueue)
operatorGroupQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithLogger(op.logger),
queueinformer.WithQueue(ogQueue),
queueinformer.WithInformer(operatorGroupInformer.Informer()),
queueinformer.WithSyncer(queueinformer.LegacySyncHandler(op.syncOperatorGroups).ToSyncer()),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(operatorGroupQueueInformer); err != nil {
return nil, err
}
// Wire CatalogSources
catsrcInformer := crInformerFactory.Operators().V1alpha1().CatalogSources()
op.lister.OperatorsV1alpha1().RegisterCatalogSourceLister(metav1.NamespaceAll, catsrcInformer.Lister())
catsrcQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "catsrcs")
op.catsrcQueueSet.Set(metav1.NamespaceAll, catsrcQueue)
catsrcQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithMetricsProvider(metrics.NewMetricsCatalogSource(op.lister.OperatorsV1alpha1().CatalogSourceLister())),
queueinformer.WithLogger(op.logger),
queueinformer.WithQueue(catsrcQueue),
queueinformer.WithInformer(catsrcInformer.Informer()),
queueinformer.WithSyncer(queueinformer.LegacySyncHandler(op.syncCatalogSources).ToSyncerWithDelete(op.handleCatSrcDeletion)),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(catsrcQueueInformer); err != nil {
return nil, err
}
// Wire Subscriptions
subInformer := crInformerFactory.Operators().V1alpha1().Subscriptions()
op.lister.OperatorsV1alpha1().RegisterSubscriptionLister(metav1.NamespaceAll, subInformer.Lister())
if err := subInformer.Informer().AddIndexers(cache.Indexers{index.PresentCatalogIndexFuncKey: index.PresentCatalogIndexFunc}); err != nil {
return nil, err
}
subIndexer := subInformer.Informer().GetIndexer()
op.catalogSubscriberIndexer[metav1.NamespaceAll] = subIndexer
subQueue := workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "subs")
op.subQueueSet.Set(metav1.NamespaceAll, subQueue)
subSyncer, err := subscription.NewSyncer(
ctx,
subscription.WithLogger(op.logger),
subscription.WithClient(op.client),
subscription.WithOperatorLister(op.lister),
subscription.WithSubscriptionInformer(subInformer.Informer()),
subscription.WithCatalogInformer(catsrcInformer.Informer()),
subscription.WithInstallPlanInformer(ipInformer.Informer()),
subscription.WithSubscriptionQueue(subQueue),
subscription.WithAppendedReconcilers(subscription.ReconcilerFromLegacySyncHandler(op.syncSubscriptions, nil)),
subscription.WithRegistryReconcilerFactory(op.reconciler),
subscription.WithGlobalCatalogNamespace(op.namespace),
)
if err != nil {
return nil, err
}
subQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithMetricsProvider(metrics.NewMetricsSubscription(op.lister.OperatorsV1alpha1().SubscriptionLister())),
queueinformer.WithLogger(op.logger),
queueinformer.WithQueue(subQueue),
queueinformer.WithInformer(subInformer.Informer()),
queueinformer.WithSyncer(subSyncer),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(subQueueInformer); err != nil {
return nil, err
}
// Wire k8s sharedIndexInformers
k8sInformerFactory := informers.NewSharedInformerFactoryWithOptions(op.opClient.KubernetesInterface(), resyncPeriod())
sharedIndexInformers := []cache.SharedIndexInformer{}
// Wire Roles
roleInformer := k8sInformerFactory.Rbac().V1().Roles()
op.lister.RbacV1().RegisterRoleLister(metav1.NamespaceAll, roleInformer.Lister())
sharedIndexInformers = append(sharedIndexInformers, roleInformer.Informer())
// Wire RoleBindings
roleBindingInformer := k8sInformerFactory.Rbac().V1().RoleBindings()
op.lister.RbacV1().RegisterRoleBindingLister(metav1.NamespaceAll, roleBindingInformer.Lister())
sharedIndexInformers = append(sharedIndexInformers, roleBindingInformer.Informer())
// Wire ServiceAccounts
serviceAccountInformer := k8sInformerFactory.Core().V1().ServiceAccounts()
op.lister.CoreV1().RegisterServiceAccountLister(metav1.NamespaceAll, serviceAccountInformer.Lister())
sharedIndexInformers = append(sharedIndexInformers, serviceAccountInformer.Informer())
// Wire Services
serviceInformer := k8sInformerFactory.Core().V1().Services()
op.lister.CoreV1().RegisterServiceLister(metav1.NamespaceAll, serviceInformer.Lister())
sharedIndexInformers = append(sharedIndexInformers, serviceInformer.Informer())
// Wire Pods for CatalogSource
catsrcReq, err := labels.NewRequirement(reconciler.CatalogSourceLabelKey, selection.Exists, nil)
if err != nil {
return nil, err
}
csPodLabels := labels.NewSelector()
csPodLabels = csPodLabels.Add(*catsrcReq)
csPodInformer := informers.NewSharedInformerFactoryWithOptions(op.opClient.KubernetesInterface(), resyncPeriod(), informers.WithTweakListOptions(func(options *metav1.ListOptions) {
options.LabelSelector = csPodLabels.String()
})).Core().V1().Pods()
op.lister.CoreV1().RegisterPodLister(metav1.NamespaceAll, csPodInformer.Lister())
sharedIndexInformers = append(sharedIndexInformers, csPodInformer.Informer())
// Wire Pods for BundleUnpack job
buReq, err := labels.NewRequirement(bundle.BundleUnpackPodLabel, selection.Exists, nil)
if err != nil {
return nil, err
}
buPodLabels := labels.NewSelector()
buPodLabels = buPodLabels.Add(*buReq)
buPodInformer := informers.NewSharedInformerFactoryWithOptions(op.opClient.KubernetesInterface(), resyncPeriod(), informers.WithTweakListOptions(func(options *metav1.ListOptions) {
options.LabelSelector = buPodLabels.String()
})).Core().V1().Pods()
sharedIndexInformers = append(sharedIndexInformers, buPodInformer.Informer())
// Wire 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())
// Wire Jobs
jobInformer := k8sInformerFactory.Batch().V1().Jobs()
sharedIndexInformers = append(sharedIndexInformers, jobInformer.Informer())
// Generate and register QueueInformers for k8s resources
k8sSyncer := queueinformer.LegacySyncHandler(op.syncObject).ToSyncerWithDelete(op.handleDeletion)
for _, informer := range sharedIndexInformers {
queueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithLogger(op.logger),
queueinformer.WithInformer(informer),
queueinformer.WithSyncer(k8sSyncer),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(queueInformer); err != nil {
return nil, err
}
}
// Setup the BundleUnpacker
op.bundleUnpacker, err = bundle.NewConfigmapUnpacker(
bundle.WithLogger(op.logger),
bundle.WithClient(op.opClient.KubernetesInterface()),
bundle.WithCatalogSourceLister(catsrcInformer.Lister()),
bundle.WithConfigMapLister(configMapInformer.Lister()),
bundle.WithJobLister(jobInformer.Lister()),
bundle.WithPodLister(buPodInformer.Lister()),
bundle.WithRoleLister(roleInformer.Lister()),
bundle.WithRoleBindingLister(roleBindingInformer.Lister()),
bundle.WithOPMImage(opmImage),
bundle.WithUtilImage(utilImage),
bundle.WithNow(op.now),
bundle.WithUnpackTimeout(op.bundleUnpackTimeout),
bundle.WithUserID(workloadUserID),
)
if err != nil {
return nil, err
}
// Register CustomResourceDefinition QueueInformer
crdInformer := extinf.NewSharedInformerFactory(op.opClient.ApiextensionsInterface(), resyncPeriod()).Apiextensions().V1().CustomResourceDefinitions()
op.lister.APIExtensionsV1().RegisterCustomResourceDefinitionLister(crdInformer.Lister())
crdQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithLogger(op.logger),
queueinformer.WithInformer(crdInformer.Informer()),
queueinformer.WithSyncer(queueinformer.LegacySyncHandler(op.syncObject).ToSyncerWithDelete(op.handleDeletion)),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(crdQueueInformer); err != nil {
return nil, err
}
// Namespace sync for resolving subscriptions
namespaceInformer := informers.NewSharedInformerFactory(op.opClient.KubernetesInterface(), resyncPeriod()).Core().V1().Namespaces()
op.lister.CoreV1().RegisterNamespaceLister(namespaceInformer.Lister())
op.nsResolveQueue = workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "resolver")
namespaceQueueInformer, err := queueinformer.NewQueueInformer(
ctx,
queueinformer.WithLogger(op.logger),
queueinformer.WithQueue(op.nsResolveQueue),
queueinformer.WithInformer(namespaceInformer.Informer()),
queueinformer.WithSyncer(queueinformer.LegacySyncHandler(op.syncResolvingNamespace).ToSyncer()),
)
if err != nil {
return nil, err
}
if err := op.RegisterQueueInformer(namespaceQueueInformer); err != nil {
return nil, err
}
op.sources.Start(context.Background())
return op, nil
}
func (o *Operator) now() metav1.Time {
return metav1.NewTime(o.clock.Now().UTC())
}
func (o *Operator) syncSourceState(state grpc.SourceState) {
o.sourcesLastUpdate.Set(o.now().Time)
o.logger.Debugf("state.Key.Namespace=%s state.Key.Name=%s state.State=%s", state.Key.Namespace, state.Key.Name, state.State.String())
metrics.RegisterCatalogSourceState(state.Key.Name, state.Key.Namespace, state.State)
switch state.State {
case connectivity.Ready:
o.sourceInvalidator.Invalidate(resolvercache.SourceKey(state.Key))
if o.namespace == state.Key.Namespace {
namespaces, err := index.CatalogSubscriberNamespaces(o.catalogSubscriberIndexer,
state.Key.Name, state.Key.Namespace)
if err == nil {
for ns := range namespaces {
o.nsResolveQueue.Add(ns)
}
}
}
o.nsResolveQueue.Add(state.Key.Namespace)
}
if err := o.catsrcQueueSet.Requeue(state.Key.Namespace, state.Key.Name); err != nil {
o.logger.WithError(err).Info("couldn't requeue catalogsource from catalog status change")
}
}
func (o *Operator) requeueOwners(obj metav1.Object) {
namespace := obj.GetNamespace()
logger := o.logger.WithFields(logrus.Fields{
"name": obj.GetName(),
"namespace": namespace,
})
for _, owner := range obj.GetOwnerReferences() {
var queueSet *queueinformer.ResourceQueueSet
switch kind := owner.Kind; kind {
case v1alpha1.CatalogSourceKind:
if err := o.catsrcQueueSet.Requeue(namespace, owner.Name); err != nil {
logger.Warn(err.Error())
}
queueSet = o.catsrcQueueSet
case v1alpha1.SubscriptionKind:
if err := o.catsrcQueueSet.Requeue(namespace, owner.Name); err != nil {
logger.Warn(err.Error())
}
queueSet = o.subQueueSet
default:
logger.WithField("kind", kind).Trace("untracked owner kind")
}
if queueSet != nil {
logger.WithField("ref", owner).Trace("requeuing owner")
if err := queueSet.Requeue(namespace, owner.Name); err != nil {
logger.Warn(err.Error())
}
}
}
}
func (o *Operator) syncObject(obj interface{}) (syncError error) {
// Assert as metav1.Object
metaObj, ok := obj.(metav1.Object)
if !ok {
syncError = errors.New("casting to metav1 object failed")
o.logger.Warn(syncError.Error())
return
}
o.requeueOwners(metaObj)
return o.triggerInstallPlanRetry(obj)
}
func (o *Operator) handleDeletion(obj interface{}) {
metaObj, ok := obj.(metav1.Object)
if !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
utilruntime.HandleError(fmt.Errorf("couldn't get object from tombstone %#v", obj))
return
}
metaObj, ok = tombstone.Obj.(metav1.Object)
if !ok {
utilruntime.HandleError(fmt.Errorf("tombstone contained object that is not a metav1 object %#v", obj))
return
}
}
o.logger.WithFields(logrus.Fields{
"name": metaObj.GetName(),
"namespace": metaObj.GetNamespace(),
}).Debug("handling object deletion")
o.requeueOwners(metaObj)
}
func (o *Operator) handleCatSrcDeletion(obj interface{}) {
catsrc, ok := obj.(metav1.Object)
if !ok {
if !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
utilruntime.HandleError(fmt.Errorf("couldn't get object from tombstone %#v", obj))
return
}
catsrc, ok = tombstone.Obj.(metav1.Object)
if !ok {
utilruntime.HandleError(fmt.Errorf("tombstone contained object that is not a Namespace %#v", obj))
return
}
}
}
sourceKey := registry.CatalogKey{Name: catsrc.GetName(), Namespace: catsrc.GetNamespace()}
if err := o.sources.Remove(sourceKey); err != nil {
o.logger.WithError(err).Warn("error closing client")
}
o.logger.WithField("source", sourceKey).Info("removed client for deleted catalogsource")
metrics.DeleteCatalogSourceStateMetric(catsrc.GetName(), catsrc.GetNamespace())
}
func validateSourceType(logger *logrus.Entry, in *v1alpha1.CatalogSource) (out *v1alpha1.CatalogSource, continueSync bool, _ error) {
out = in
var err error
switch sourceType := out.Spec.SourceType; sourceType {
case v1alpha1.SourceTypeInternal, v1alpha1.SourceTypeConfigmap:
if out.Spec.ConfigMap == "" {
err = fmt.Errorf("configmap name unset: must be set for sourcetype: %s", sourceType)
}
case v1alpha1.SourceTypeGrpc:
if out.Spec.Image == "" && out.Spec.Address == "" {
err = fmt.Errorf("image and address unset: at least one must be set for sourcetype: %s", sourceType)
}
default:
err = fmt.Errorf("unknown sourcetype: %s", sourceType)
}
if err != nil {
out.SetError(v1alpha1.CatalogSourceSpecInvalidError, err)
return
}
// The sourceType is valid, clear all status (other than status conditions array) if there's existing invalid spec reason
if out.Status.Reason == v1alpha1.CatalogSourceSpecInvalidError {
out.Status = v1alpha1.CatalogSourceStatus{
Conditions: out.Status.Conditions,
}
}
continueSync = true
return
}
func (o *Operator) syncConfigMap(logger *logrus.Entry, in *v1alpha1.CatalogSource) (out *v1alpha1.CatalogSource, continueSync bool, syncError error) {
out = in
if !(in.Spec.SourceType == v1alpha1.SourceTypeInternal || in.Spec.SourceType == v1alpha1.SourceTypeConfigmap) {
continueSync = true
return
}
out = in.DeepCopy()
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 apierrors.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 || 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)
out.SetError(v1alpha1.CatalogSourceConfigMapError, syncError)
return
}
logger.Debug("adopted configmap")
}
if in.Status.ConfigMapResource == nil || !in.Status.ConfigMapResource.IsAMatch(&configMap.ObjectMeta) {
logger.Debug("updating catsrc configmap state")
// configmap ref nonexistent or updated, write out the new configmap ref to status and exit
out.Status.ConfigMapResource = &v1alpha1.ConfigMapResourceReference{
Name: configMap.GetName(),
Namespace: configMap.GetNamespace(),
UID: configMap.GetUID(),
ResourceVersion: configMap.GetResourceVersion(),
LastUpdateTime: o.now(),
}
return
}
continueSync = true
return
}
func (o *Operator) syncRegistryServer(logger *logrus.Entry, in *v1alpha1.CatalogSource) (out *v1alpha1.CatalogSource, continueSync bool, syncError error) {
out = in.DeepCopy()
sourceKey := registry.CatalogKey{Name: in.GetName(), Namespace: in.GetNamespace()}
srcReconciler := o.reconciler.ReconcilerForSource(in)
if srcReconciler == nil {
// TODO: Add failure status on catalogsource and remove from sources
syncError = fmt.Errorf("no reconciler for source type %s", in.Spec.SourceType)
out.SetError(v1alpha1.CatalogSourceRegistryServerError, syncError)
return
}
healthy, err := srcReconciler.CheckRegistryServer(in)
if err != nil {
syncError = err
out.SetError(v1alpha1.CatalogSourceRegistryServerError, syncError)
return
}
logger.Debugf("check registry server healthy: %t", healthy)
if healthy && in.Status.RegistryServiceStatus != nil {
logger.Debug("registry state good")
continueSync = true
// return here if catalog does not have polling enabled
if !out.Poll() {
return
}
}
// Registry pod hasn't been created or hasn't been updated since the last configmap update, recreate it
logger.Debug("ensuring registry server")
err = srcReconciler.EnsureRegistryServer(out)
if err != nil {
if _, ok := err.(reconciler.UpdateNotReadyErr); ok {
logger.Debug("requeueing registry server for catalog update check: update pod not yet ready")
o.catsrcQueueSet.RequeueAfter(out.GetNamespace(), out.GetName(), reconciler.CatalogPollingRequeuePeriod)
return
}
syncError = fmt.Errorf("couldn't ensure registry server - %v", err)
out.SetError(v1alpha1.CatalogSourceRegistryServerError, syncError)
return
}
logger.Debug("ensured registry server")
// requeue the catalog sync based on the polling interval, for accurate syncs of catalogs with polling enabled
if out.Spec.UpdateStrategy != nil && out.Spec.UpdateStrategy.RegistryPoll != nil {
if out.Spec.UpdateStrategy.Interval == nil {
syncError = fmt.Errorf("empty polling interval; cannot requeue registry server sync without a provided polling interval")
out.SetError(v1alpha1.CatalogSourceIntervalInvalidError, syncError)
return
}
if out.Spec.UpdateStrategy.RegistryPoll.ParsingError != "" && out.Status.Reason != v1alpha1.CatalogSourceIntervalInvalidError {
out.SetError(v1alpha1.CatalogSourceIntervalInvalidError, fmt.Errorf(out.Spec.UpdateStrategy.RegistryPoll.ParsingError))
}
logger.Debugf("requeuing registry server sync based on polling interval %s", out.Spec.UpdateStrategy.Interval.Duration.String())
resyncPeriod := reconciler.SyncRegistryUpdateInterval(out, time.Now())
o.catsrcQueueSet.RequeueAfter(out.GetNamespace(), out.GetName(), queueinformer.ResyncWithJitter(resyncPeriod, 0.1)())
return
}
if err := o.sources.Remove(sourceKey); err != nil {
o.logger.WithError(err).Debug("error closing client connection")
}
return
}
func (o *Operator) syncConnection(logger *logrus.Entry, in *v1alpha1.CatalogSource) (out *v1alpha1.CatalogSource, continueSync bool, syncError error) {
out = in.DeepCopy()
sourceKey := registry.CatalogKey{Name: in.GetName(), Namespace: in.GetNamespace()}
// update operator's view of sources
now := o.now()
address := in.Address()
connectFunc := func() (source *grpc.SourceMeta, connErr error) {
newSource, err := o.sources.Add(sourceKey, address)
if err != nil {
connErr = fmt.Errorf("couldn't connect to registry - %v", err)
return
}
if newSource == nil {
connErr = errors.New("couldn't connect to registry")
return
}
source = &newSource.SourceMeta
return
}
updateConnectionStateFunc := func(out *v1alpha1.CatalogSource, source *grpc.SourceMeta) {
out.Status.GRPCConnectionState = &v1alpha1.GRPCConnectionState{
Address: source.Address,
LastObservedState: source.ConnectionState.String(),
LastConnectTime: source.LastConnect,
}
}
source := o.sources.GetMeta(sourceKey)
if source == nil {
source, syncError = connectFunc()
if syncError != nil {
out.SetError(v1alpha1.CatalogSourceRegistryServerError, syncError)
return
}
// Set connection status and return.
updateConnectionStateFunc(out, source)
return
}
if source.Address != address {
source, syncError = connectFunc()
if syncError != nil {
out.SetError(v1alpha1.CatalogSourceRegistryServerError, syncError)
return
}
// Set connection status and return.
updateConnectionStateFunc(out, source)
}
// GRPCConnectionState update must fail before
if out.Status.GRPCConnectionState == nil {
updateConnectionStateFunc(out, source)
}
// connection is already good, but we need to update the sync time
if o.sourcesLastUpdate.After(out.Status.GRPCConnectionState.LastConnectTime.Time) {
// Set connection status and return.
out.Status.GRPCConnectionState.LastConnectTime = now
out.Status.GRPCConnectionState.LastObservedState = source.ConnectionState.String()
out.Status.GRPCConnectionState.Address = source.Address
}
return
}
func (o *Operator) syncCatalogSources(obj interface{}) (syncError error) {
catsrc, ok := obj.(*v1alpha1.CatalogSource)
if !ok {
o.logger.Debugf("wrong type: %#v", obj)
syncError = nil
return
}
logger := o.logger.WithFields(logrus.Fields{
"source": catsrc.GetName(),
"id": queueinformer.NewLoopID(),
})
logger.Debug("syncing catsrc")
syncFunc := func(in *v1alpha1.CatalogSource, chain []CatalogSourceSyncFunc) (out *v1alpha1.CatalogSource, syncErr error) {
out = in
for _, syncFunc := range chain {
cont := false
out, cont, syncErr = syncFunc(logger, in)
if syncErr != nil {
return
}
if !cont {
return
}
in = out
}
return
}
equalFunc := func(a, b *v1alpha1.CatalogSourceStatus) bool {
return reflect.DeepEqual(a, b)
}
chain := []CatalogSourceSyncFunc{
validateSourceType,
o.syncConfigMap,
o.syncRegistryServer,
o.syncConnection,
}
in := catsrc.DeepCopy()
in.SetError("", nil)
out, syncError := syncFunc(in, chain)
if out == nil {
return
}
if equalFunc(&catsrc.Status, &out.Status) {
return
}
updateErr := catalogsource.UpdateStatus(logger, o.client, out)
if syncError == nil && updateErr != nil {
syncError = updateErr
}
return
}
func (o *Operator) syncResolvingNamespace(obj interface{}) error {
ns, ok := obj.(*corev1.Namespace)
if !ok {
o.logger.Debugf("wrong type: %#v", obj)
return fmt.Errorf("casting Namespace failed")
}
namespace := ns.GetName()
logger := o.logger.WithFields(logrus.Fields{
"namespace": namespace,
"id": queueinformer.NewLoopID(),
})
o.gcInstallPlans(logger, namespace)
// get the set of sources that should be used for resolution and best-effort get their connections working
logger.Debug("resolving sources")
logger.Debug("checking if subscriptions need update")
subs, err := o.listSubscriptions(namespace)
if err != nil {
logger.WithError(err).Debug("couldn't list subscriptions")
return err
}
ogLister := o.lister.OperatorsV1().OperatorGroupLister().OperatorGroups(namespace)
failForwardEnabled, err := resolver.IsFailForwardEnabled(ogLister)
if err != nil {
return err
}
unpackTimeout, err := bundle.OperatorGroupBundleUnpackTimeout(ogLister)
if err != nil {
return err
}
// TODO: parallel
maxGeneration := 0
subscriptionUpdated := false
for i, sub := range subs {
logger := logger.WithFields(logrus.Fields{
"sub": sub.GetName(),
"source": sub.Spec.CatalogSource,
"pkg": sub.Spec.Package,
"channel": sub.Spec.Channel,
})
if sub.Status.InstallPlanGeneration > maxGeneration {
maxGeneration = sub.Status.InstallPlanGeneration
}
// ensure the installplan reference is correct
sub, changedIP, err := o.ensureSubscriptionInstallPlanState(logger, sub, failForwardEnabled)
if err != nil {
logger.Debugf("error ensuring installplan state: %v", err)
return err
}
subscriptionUpdated = subscriptionUpdated || changedIP
// record the current state of the desired corresponding CSV in the status. no-op if we don't know the csv yet.
sub, changedCSV, err := o.ensureSubscriptionCSVState(logger, sub, failForwardEnabled)
if err != nil {
logger.Debugf("error recording current state of CSV in status: %v", err)
return err
}
subscriptionUpdated = subscriptionUpdated || changedCSV
subs[i] = sub
}
if subscriptionUpdated {
logger.Debug("subscriptions were updated, wait for a new resolution")
return nil
}
shouldUpdate := false
for _, sub := range subs {
shouldUpdate = shouldUpdate || !o.nothingToUpdate(logger, sub)
}
if !shouldUpdate {
logger.Debug("all subscriptions up to date")
return nil
}
logger.Debug("resolving subscriptions in namespace")