-
Notifications
You must be signed in to change notification settings - Fork 540
/
adoption_controller.go
542 lines (463 loc) · 16.1 KB
/
adoption_controller.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
package operators
import (
"context"
"fmt"
"sync"
"github.com/go-logr/logr"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
operatorsv1 "github.com/operator-framework/api/pkg/operators/v1"
operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/decorators"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
)
// AdoptionReconciler automagically associates Operator components with their respective operator resource.
type AdoptionReconciler struct {
client.Client
log logr.Logger
factory decorators.OperatorFactory
}
// +kubebuilder:rbac:groups=operators.coreos.com,resources=operators,verbs=create;update;patch;delete
// +kubebuilder:rbac:groups=operators.coreos.com,resources=operators/status,verbs=update;patch
// +kubebuilder:rbac:groups=*,resources=*,verbs=get;list;watch
// SetupWithManager adds the operator reconciler to the given controller manager.
func (r *AdoptionReconciler) SetupWithManager(mgr ctrl.Manager) error {
// Trigger operator events from the events of their compoenents.
enqueueSub := handler.EnqueueRequestsFromMapFunc(r.mapToSubscriptions)
// Create multiple controllers for resource types that require automatic adoption
err := ctrl.NewControllerManagedBy(mgr).
For(&operatorsv1alpha1.Subscription{}).
Watches(&operatorsv1alpha1.ClusterServiceVersion{}, enqueueSub).
Watches(&operatorsv1alpha1.InstallPlan{}, enqueueSub).
Complete(reconcile.Func(r.ReconcileSubscription))
if err != nil {
return err
}
var (
enqueueCSV = handler.EnqueueRequestsFromMapFunc(r.mapToClusterServiceVersions)
enqueueProviders = handler.EnqueueRequestsFromMapFunc(r.mapToProviders)
)
err = ctrl.NewControllerManagedBy(mgr).
For(&operatorsv1alpha1.ClusterServiceVersion{}).
Watches(&appsv1.Deployment{}, enqueueCSV).
Watches(&corev1.Namespace{}, enqueueCSV).
Watches(&corev1.Service{}, enqueueCSV).
Watches(&apiextensionsv1.CustomResourceDefinition{}, enqueueProviders).
Watches(&apiregistrationv1.APIService{}, enqueueCSV).
Watches(&operatorsv1alpha1.Subscription{}, enqueueCSV).
Watches(&operatorsv2.OperatorCondition{}, enqueueCSV).
Watches(&corev1.Secret{}, enqueueCSV, builder.OnlyMetadata).
Watches(&corev1.ConfigMap{}, enqueueCSV, builder.OnlyMetadata).
Watches(&corev1.ServiceAccount{}, enqueueCSV, builder.OnlyMetadata).
Watches(&rbacv1.Role{}, enqueueCSV, builder.OnlyMetadata).
Watches(&rbacv1.RoleBinding{}, enqueueCSV, builder.OnlyMetadata).
Watches(&rbacv1.ClusterRole{}, enqueueCSV, builder.OnlyMetadata).
Watches(&rbacv1.ClusterRoleBinding{}, enqueueCSV, builder.OnlyMetadata).
Complete(reconcile.Func(r.ReconcileClusterServiceVersion))
if err != nil {
return err
}
return nil
}
// NewAdoptionReconciler constructs and returns an AdoptionReconciler.
// As a side effect, the given scheme has operator discovery types added to it.
func NewAdoptionReconciler(cli client.Client, log logr.Logger, scheme *runtime.Scheme) (*AdoptionReconciler, error) {
// Add watched types to scheme.
if err := AddToScheme(scheme); err != nil {
return nil, err
}
factory, err := decorators.NewSchemedOperatorFactory(scheme)
if err != nil {
return nil, err
}
return &AdoptionReconciler{
Client: cli,
log: log,
factory: factory,
}, nil
}
// ReconcileSubscription labels the CSVs installed by a Subscription as components of an operator named after the subscribed package and install namespace.
func (r *AdoptionReconciler) ReconcileSubscription(ctx context.Context, req ctrl.Request) (reconcile.Result, error) {
// Set up a convenient log object so we don't have to type request over and over again
log := r.log.WithValues("request", req)
log.V(1).Info("reconciling subscription")
metrics.EmitAdoptionSubscriptionReconcile(req.Namespace, req.Name)
// Fetch the Subscription from the cache
in := &operatorsv1alpha1.Subscription{}
if err := r.Get(ctx, req.NamespacedName, in); err != nil {
if apierrors.IsNotFound(err) {
log.Info("Could not find Subscription")
} else {
log.Error(err, "Error finding Subscription")
}
return reconcile.Result{}, nil
}
// OLM generated Operators are named after their packages and further qualified by the install namespace
if in.Spec == nil || in.Spec.Package == "" {
log.Info("subscription spec missing package, ignoring")
return reconcile.Result{}, nil
}
// Wrap with convenience decorator
operator, err := r.factory.NewPackageOperator(in.Spec.Package, in.GetNamespace())
if err != nil {
log.Error(err, "Could not wrap Operator with convenience decorator")
return reconcile.Result{}, nil
}
// Adopt the Subscription
var errs []error
if err := r.adopt(ctx, operator, in); err != nil {
log.Error(err, "Error adopting Subscription")
errs = append(errs, err)
}
// Adopt the Subscription's installed CSV
if name := in.Status.InstalledCSV; name != "" {
csv := &operatorsv1alpha1.ClusterServiceVersion{}
csv.SetNamespace(in.GetNamespace())
csv.SetName(name)
if err := r.adopt(ctx, operator, csv); err != nil {
log.Error(err, "Error adopting installed CSV")
errs = append(errs, err)
}
}
// Adopt the Subscription's latest InstallPlan and Disown all others in the same namespace
if ref := in.Status.InstallPlanRef; ref != nil {
ip := &operatorsv1alpha1.InstallPlan{}
ip.SetNamespace(ref.Namespace)
ip.SetName(ref.Name)
if err := r.adoptInstallPlan(ctx, operator, ip); err != nil {
errs = append(errs, err)
}
}
return reconcile.Result{}, utilerrors.NewAggregate(errs)
}
// ReconcileClusterServiceVersion projects the component labels of a given CSV onto all resources owned by it.
func (r *AdoptionReconciler) ReconcileClusterServiceVersion(ctx context.Context, req ctrl.Request) (reconcile.Result, error) {
// Set up a convenient log object so we don't have to type request over and over again
log := r.log.WithValues("request", req)
log.V(1).Info("reconciling csv")
metrics.EmitAdoptionCSVReconcile(req.Namespace, req.Name)
// Fetch the CSV from the cache
in := &operatorsv1alpha1.ClusterServiceVersion{}
if err := r.Get(ctx, req.NamespacedName, in); err != nil {
if apierrors.IsNotFound(err) {
err = nil
} else {
log.Error(err, "Error finding ClusterServiceVersion")
}
return reconcile.Result{}, err
}
// disown copied csvs - a previous release inadvertently adopted them, this cleans any up if they are adopted
if in.IsCopied() {
err := r.disownFromAll(ctx, in)
return reconcile.Result{}, err
}
// Adopt all resources owned by the CSV if necessary
return reconcile.Result{}, r.adoptComponents(ctx, in)
}
func (r *AdoptionReconciler) adoptComponents(ctx context.Context, csv *operatorsv1alpha1.ClusterServiceVersion) error {
if csv.IsCopied() {
// For now, skip copied CSVs
return nil
}
var operators []decorators.Operator
for _, name := range decorators.OperatorNames(csv.GetLabels()) {
o := &operatorsv1.Operator{}
o.SetName(name.Name)
operator, err := r.factory.NewOperator(o)
if err != nil {
return err
}
operators = append(operators, *operator)
}
if len(operators) < 1 {
// No operators to adopt for
return nil
}
// Label (adopt) prospective components
var (
errs []error
mu sync.Mutex
wg sync.WaitGroup
)
for _, operator := range operators {
components, err := r.adoptees(ctx, operator, csv)
if err != nil {
func() {
mu.Lock()
defer mu.Unlock()
errs = append(errs, err)
}()
}
for _, component := range components {
var (
// Copy variables into iteration scope
operator = operator
component = component
)
wg.Add(1)
go func() {
defer wg.Done()
if err := r.adopt(ctx, &operator, component); err != nil {
mu.Lock()
defer mu.Unlock()
errs = append(errs, err)
}
}()
}
}
wg.Wait()
return utilerrors.NewAggregate(errs)
}
func (r *AdoptionReconciler) adopt(ctx context.Context, operator *decorators.Operator, component runtime.Object) error {
m, err := meta.Accessor(component)
if err != nil {
return nil
}
cObj, ok := component.(client.Object)
if !ok {
return fmt.Errorf("unable to typecast runtime.Object to client.Object")
}
if err := r.Get(ctx, types.NamespacedName{Namespace: m.GetNamespace(), Name: m.GetName()}, cObj); err != nil {
if apierrors.IsNotFound(err) {
r.log.V(1).Info("not found", "component", cObj)
err = nil
}
return err
}
candidate := cObj.DeepCopyObject()
adopted, err := operator.AdoptComponent(candidate)
if err != nil {
return err
}
if adopted {
// Only update if freshly adopted
pCObj, ok := candidate.(client.Object)
if !ok {
return fmt.Errorf("unable to typecast runtime.Object to client.Object")
}
return r.Patch(ctx, pCObj, client.MergeFrom(cObj))
}
return nil
}
func (r *AdoptionReconciler) disown(ctx context.Context, operator *decorators.Operator, component runtime.Object) error {
cObj, ok := component.(client.Object)
if !ok {
return fmt.Errorf("unable to typecast runtime.Object to client.Object")
}
candidate := component.DeepCopyObject()
disowned, err := operator.DisownComponent(candidate)
if err != nil {
return err
}
if !disowned {
// Wasn't a component
return nil
}
// Only update if freshly disowned
r.log.V(1).Info("component disowned", "component", candidate)
uCObj, ok := candidate.(client.Object)
if !ok {
return fmt.Errorf("unable to typecast runtime.Object to client.Object")
}
return r.Patch(ctx, uCObj, client.MergeFrom(cObj))
}
func (r *AdoptionReconciler) disownFromAll(ctx context.Context, component runtime.Object) error {
cObj, ok := component.(client.Object)
if !ok {
return fmt.Errorf("unable to typecast runtime.Object to client.Object")
}
var operators []decorators.Operator
for _, name := range decorators.OperatorNames(cObj.GetLabels()) {
o := &operatorsv1.Operator{}
o.SetName(name.Name)
operator, err := r.factory.NewOperator(o)
if err != nil {
return err
}
operators = append(operators, *operator)
}
errs := make([]error, 0)
for _, operator := range operators {
if err := r.disown(ctx, &operator, component); err != nil {
errs = append(errs, err)
}
}
return utilerrors.NewAggregate(errs)
}
func (r *AdoptionReconciler) adoptees(ctx context.Context, operator decorators.Operator, csv *operatorsv1alpha1.ClusterServiceVersion) ([]runtime.Object, error) {
// Note: We need to figure out how to dynamically add new list types here (or some equivalent) in
// order to support operators composed of custom resources.
componentLists := componentLists()
// Only resources that aren't already labelled are adoption candidates
selector, err := operator.NonComponentSelector()
if err != nil {
return nil, err
}
opt := client.MatchingLabelsSelector{Selector: selector}
for _, list := range componentLists {
cList, ok := list.(client.ObjectList)
if !ok {
return nil, fmt.Errorf("unable to typecast runtime.Object to client.ObjectList")
}
if err := r.List(ctx, cList, opt); err != nil {
return nil, err
}
}
var (
components []runtime.Object
errs []error
)
for _, candidate := range flatten(componentLists) {
m, err := meta.Accessor(candidate)
if err != nil {
errs = append(errs, err)
continue
}
if ownerutil.IsOwnedBy(m, csv) || ownerutil.IsOwnedByLabel(m, csv) {
components = append(components, candidate)
}
}
// Pick up owned CRDs
for _, provided := range csv.Spec.CustomResourceDefinitions.Owned {
crd := &metav1.PartialObjectMetadata{}
crd.SetGroupVersionKind(apiextensionsv1.SchemeGroupVersion.WithKind("CustomResourceDefinition"))
if err := r.Get(ctx, types.NamespacedName{Name: provided.Name}, crd); err != nil {
if !apierrors.IsNotFound(err) {
// Inform requeue on transient error
errs = append(errs, err)
}
// Skip on transient error or missing CRD
continue
}
if crd == nil || !selector.Matches(labels.Set(crd.GetLabels())) {
// Skip empty and labelled CRDs
continue
}
components = append(components, crd)
}
return components, utilerrors.NewAggregate(errs)
}
func (r *AdoptionReconciler) adoptInstallPlan(ctx context.Context, operator *decorators.Operator, latest *operatorsv1alpha1.InstallPlan) error {
// Adopt the latest InstallPlan
if err := r.adopt(ctx, operator, latest); err != nil {
return err
}
// Disown older InstallPlans
selector, err := operator.ComponentSelector()
if err != nil {
return err
}
var (
ips = &operatorsv1alpha1.InstallPlanList{}
opt = client.MatchingLabelsSelector{Selector: selector}
)
if err := r.List(ctx, ips, opt, client.InNamespace(latest.GetNamespace())); err != nil {
return err
}
var errs []error
for _, ip := range ips.Items {
if ip.GetName() == latest.GetName() {
// Don't disown latest
continue
}
if err := r.disown(ctx, operator, &ip); err != nil {
errs = append(errs, err)
}
}
return utilerrors.NewAggregate(errs)
}
func (r *AdoptionReconciler) mapToSubscriptions(ctx context.Context, obj client.Object) (requests []reconcile.Request) {
if obj == nil {
return
}
// Requeue all Subscriptions in the resource namespace
// The Subscription reconciler will sort out the important changes
subs := &operatorsv1alpha1.SubscriptionList{}
if err := r.List(ctx, subs, client.InNamespace(obj.GetNamespace())); err != nil {
r.log.Error(err, "error listing subscriptions")
}
visited := map[types.NamespacedName]struct{}{}
for _, sub := range subs.Items {
nsn := types.NamespacedName{Namespace: sub.GetNamespace(), Name: sub.GetName()}
if _, ok := visited[nsn]; ok {
// Already requested
continue
}
requests = append(requests, reconcile.Request{NamespacedName: nsn})
visited[nsn] = struct{}{}
}
return
}
func (r *AdoptionReconciler) mapToClusterServiceVersions(_ context.Context, obj client.Object) (requests []reconcile.Request) {
if obj == nil {
return
}
// Get all owner CSV from owner labels if cluster scoped
namespace := obj.GetNamespace()
if namespace == metav1.NamespaceAll {
name, ns, ok := ownerutil.GetOwnerByKindLabel(obj, operatorsv1alpha1.ClusterServiceVersionKind)
if ok {
nsn := types.NamespacedName{Namespace: ns, Name: name}
requests = append(requests, reconcile.Request{NamespacedName: nsn})
}
return
}
// Get all owner CSVs from OwnerReferences
owners := ownerutil.GetOwnersByKind(obj, operatorsv1alpha1.ClusterServiceVersionKind)
for _, owner := range owners {
nsn := types.NamespacedName{Namespace: namespace, Name: owner.Name}
requests = append(requests, reconcile.Request{NamespacedName: nsn})
}
return
}
func (r *AdoptionReconciler) mapToProviders(ctx context.Context, obj client.Object) (requests []reconcile.Request) {
if obj == nil {
return nil
}
var (
csvs = &operatorsv1alpha1.ClusterServiceVersionList{}
)
if err := r.List(ctx, csvs); err != nil {
r.log.Error(err, "error listing csvs")
return
}
for _, csv := range csvs.Items {
request := reconcile.Request{
NamespacedName: types.NamespacedName{Namespace: csv.GetNamespace(), Name: csv.GetName()},
}
for _, provided := range csv.Spec.CustomResourceDefinitions.Owned {
if provided.Name == obj.GetName() {
requests = append(requests, request)
break
}
}
}
return
}
func flatten(objs []runtime.Object) (flattened []runtime.Object) {
for _, obj := range objs {
if nested, err := meta.ExtractList(obj); err == nil {
flattened = append(flattened, flatten(nested)...)
continue
}
flattened = append(flattened, obj)
}
return
}