-
Notifications
You must be signed in to change notification settings - Fork 14
/
reconcile.go
553 lines (439 loc) · 19.2 KB
/
reconcile.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
/*
Copyright (c) 2020-2021 TriggerMesh Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package common
import (
"context"
"fmt"
"reflect"
"strings"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime/schema"
"knative.dev/pkg/apis"
"knative.dev/pkg/controller"
"knative.dev/pkg/kmeta"
"knative.dev/pkg/reconciler"
"knative.dev/serving/pkg/apis/serving"
servingv1 "knative.dev/serving/pkg/apis/serving/v1"
"github.com/triggermesh/aws-event-sources/pkg/apis/sources/v1alpha1"
"github.com/triggermesh/aws-event-sources/pkg/reconciler/common/event"
"github.com/triggermesh/aws-event-sources/pkg/reconciler/common/semantic"
"github.com/triggermesh/aws-event-sources/pkg/routing"
)
// List of annotations set on Knative Serving objects by the Knative Serving
// admission webhook.
var knativeServingAnnotations = []string{
serving.CreatorAnnotation,
serving.UpdaterAnnotation,
}
// RBACOwnersLister returns a list of OwnerRefable to be set as a the
// OwnerReferences metadata attribute of a ServiceAccount.
type RBACOwnersLister interface {
RBACOwners(namespace string) ([]kmeta.OwnerRefable, error)
}
// AdapterDeploymentBuilder provides all the necessary information for building
// objects related to a source's adapter backed by a Deployment.
type AdapterDeploymentBuilder interface {
RBACOwnersLister
BuildAdapter(src v1alpha1.EventSource, sinkURI *apis.URL) *appsv1.Deployment
}
// AdapterServiceBuilder provides all the necessary information for building
// objects related to a source's adapter backed by a Knative Service.
type AdapterServiceBuilder interface {
RBACOwnersLister
BuildAdapter(src v1alpha1.EventSource, sinkURI *apis.URL) *servingv1.Service
}
// ReconcileSource reconciles an event source type.
func (r *GenericDeploymentReconciler) ReconcileSource(ctx context.Context, ab AdapterDeploymentBuilder) reconciler.Event {
src := v1alpha1.SourceFromContext(ctx)
src.GetStatusManager().CloudEventAttributes = CreateCloudEventAttributes(
src.AsEventSource(), src.GetEventTypes())
sinkURI, err := r.resolveSinkURL(ctx)
if err != nil {
src.GetStatusManager().MarkNoSink()
return controller.NewPermanentError(reconciler.NewEvent(corev1.EventTypeWarning,
ReasonBadSinkURI, "Could not resolve sink URI: %s", err))
}
src.GetStatusManager().MarkSink(sinkURI)
desiredAdapter := ab.BuildAdapter(src, sinkURI)
saOwners, err := ab.RBACOwners(src.GetNamespace())
if err != nil {
return fmt.Errorf("listing ServiceAccount owners: %w", err)
}
if err := r.reconcileAdapter(ctx, desiredAdapter, saOwners); err != nil {
return fmt.Errorf("failed to reconcile adapter: %w", err)
}
return nil
}
// resolveSinkURL resolves the URL of a sink reference.
func (r *GenericDeploymentReconciler) resolveSinkURL(ctx context.Context) (*apis.URL, error) {
src := v1alpha1.SourceFromContext(ctx)
sink := *src.GetSink()
if sinkRef := &src.GetSink().Ref; *sinkRef != nil && (*sinkRef).Namespace == "" {
(*sinkRef).Namespace = src.GetNamespace()
}
return r.SinkResolver.URIFromDestinationV1(ctx, sink, src)
}
// reconcileAdapter reconciles the state of the source's adapter.
func (r *GenericDeploymentReconciler) reconcileAdapter(ctx context.Context,
desiredAdapter *appsv1.Deployment, rbacOwners []kmeta.OwnerRefable) error {
src := v1alpha1.SourceFromContext(ctx)
sa, err := r.reconcileRBAC(ctx, rbacOwners)
if err != nil {
src.GetStatusManager().MarkRBACNotBound()
return fmt.Errorf("reconciling RBAC objects: %w", err)
}
if v1alpha1.IsMultiTenant(src) {
// delegate ownership to the ServiceAccount in order to cause a
// garbage collection once all instances of the given source
// type have been deleted from the namespace
OwnByServiceAccount(desiredAdapter, sa)
}
currentAdapter, err := r.getOrCreateAdapter(ctx, desiredAdapter)
if err != nil {
src.GetStatusManager().PropagateDeploymentAvailability(ctx, currentAdapter, r.PodClient(src.GetNamespace()))
return err
}
currentAdapter, err = r.syncAdapterDeployment(ctx, currentAdapter, desiredAdapter)
if err != nil {
return fmt.Errorf("failed to synchronize adapter Deployment: %w", err)
}
src.GetStatusManager().PropagateDeploymentAvailability(ctx, currentAdapter, r.PodClient(src.GetNamespace()))
return nil
}
// getOrCreateAdapter returns the existing adapter Deployment for a given
// source, or creates it if it is missing.
func (r *GenericDeploymentReconciler) getOrCreateAdapter(ctx context.Context, desiredAdapter *appsv1.Deployment) (*appsv1.Deployment, error) {
src := v1alpha1.SourceFromContext(ctx)
adapter, err := findAdapter(r, src, metav1.GetControllerOfNoCopy(desiredAdapter))
switch {
case apierrors.IsNotFound(err):
adapter, err = r.Client(src.GetNamespace()).Create(ctx, desiredAdapter, metav1.CreateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedAdapterCreate,
"Failed to create adapter Deployment %q: %s", desiredAdapter.Name, err)
}
event.Normal(ctx, ReasonAdapterCreate, "Created adapter Deployment %q", adapter.GetName())
case err != nil:
return nil, fmt.Errorf("failed to get adapter Deployment from cache: %w", err)
}
return adapter.(*appsv1.Deployment), nil
}
// syncAdapterDeployment synchronizes the desired state of an adapter Deployment
// against its current state in the running cluster.
func (r *GenericDeploymentReconciler) syncAdapterDeployment(ctx context.Context,
currentAdapter, desiredAdapter *appsv1.Deployment) (*appsv1.Deployment, error) {
if semantic.Semantic.DeepEqual(desiredAdapter, currentAdapter) {
return currentAdapter, nil
}
// resourceVersion must be returned to the API server unmodified for
// optimistic concurrency, as per Kubernetes API conventions
desiredAdapter.ResourceVersion = currentAdapter.ResourceVersion
// (fake Clientset) preserve status to avoid resetting conditions
desiredAdapter.Status = currentAdapter.Status
adapter, err := r.Client(currentAdapter.Namespace).Update(ctx, desiredAdapter, metav1.UpdateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedAdapterUpdate,
"Failed to update adapter Deployment %q: %s", desiredAdapter.Name, err)
}
event.Normal(ctx, ReasonAdapterUpdate, "Updated adapter Deployment %q", adapter.Name)
return adapter, nil
}
// ReconcileSource reconciles an event source type.
func (r *GenericServiceReconciler) ReconcileSource(ctx context.Context, ab AdapterServiceBuilder) reconciler.Event {
src := v1alpha1.SourceFromContext(ctx)
src.GetStatusManager().CloudEventAttributes = CreateCloudEventAttributes(
src.AsEventSource(), src.GetEventTypes())
sinkURI, err := r.resolveSinkURL(ctx)
if err != nil {
src.GetStatusManager().MarkNoSink()
return controller.NewPermanentError(reconciler.NewEvent(corev1.EventTypeWarning,
ReasonBadSinkURI, "Could not resolve sink URI: %s", err))
}
src.GetStatusManager().MarkSink(sinkURI)
desiredAdapter := ab.BuildAdapter(src, sinkURI)
saOwners, err := ab.RBACOwners(src.GetNamespace())
if err != nil {
return fmt.Errorf("listing ServiceAccount owners: %w", err)
}
if err := r.reconcileAdapter(ctx, desiredAdapter, saOwners); err != nil {
return fmt.Errorf("failed to reconcile adapter: %w", err)
}
return nil
}
// resolveSinkURL resolves the URL of a sink reference.
func (r *GenericServiceReconciler) resolveSinkURL(ctx context.Context) (*apis.URL, error) {
src := v1alpha1.SourceFromContext(ctx)
sink := *src.GetSink()
if sinkRef := &src.GetSink().Ref; *sinkRef != nil && (*sinkRef).Namespace == "" {
(*sinkRef).Namespace = src.GetNamespace()
}
return r.SinkResolver.URIFromDestinationV1(ctx, sink, src)
}
// reconcileAdapter reconciles the state of the source's adapter.
func (r *GenericServiceReconciler) reconcileAdapter(ctx context.Context,
desiredAdapter *servingv1.Service, rbacOwners []kmeta.OwnerRefable) error {
src := v1alpha1.SourceFromContext(ctx)
isMultiTenant := v1alpha1.IsMultiTenant(src)
sa, err := r.reconcileRBAC(ctx, rbacOwners)
if err != nil {
src.GetStatusManager().MarkRBACNotBound()
return fmt.Errorf("reconciling RBAC objects: %w", err)
}
if isMultiTenant {
// delegate ownership to the ServiceAccount in order to cause a
// garbage collection once all instances of the given source
// type have been deleted from the namespace
OwnByServiceAccount(desiredAdapter, sa)
}
currentAdapter, err := r.getOrCreateAdapter(ctx, desiredAdapter)
if err != nil {
src.GetStatusManager().PropagateServiceAvailability(currentAdapter)
return err
}
currentAdapter, err = r.syncAdapterService(ctx, currentAdapter, desiredAdapter)
if err != nil {
return fmt.Errorf("failed to synchronize adapter Service: %w", err)
}
src.GetStatusManager().PropagateServiceAvailability(currentAdapter)
if isMultiTenant {
src.GetStatusManager().SetRoute(routing.URLPath(src))
}
return nil
}
// getOrCreateAdapter returns the existing adapter Service for a given
// source, or creates it if it is missing.
func (r *GenericServiceReconciler) getOrCreateAdapter(ctx context.Context, desiredAdapter *servingv1.Service) (*servingv1.Service, error) {
src := v1alpha1.SourceFromContext(ctx)
adapter, err := findAdapter(r, src, metav1.GetControllerOfNoCopy(desiredAdapter))
switch {
case apierrors.IsNotFound(err):
adapter, err = r.Client(src.GetNamespace()).Create(ctx, desiredAdapter, metav1.CreateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedAdapterCreate,
"Failed to create adapter Service %q: %s", desiredAdapter.Name, err)
}
event.Normal(ctx, ReasonAdapterCreate, "Created adapter Service %q", adapter.GetName())
case err != nil:
return nil, fmt.Errorf("failed to get adapter Service from cache: %w", err)
}
return adapter.(*servingv1.Service), nil
}
// syncAdapterService synchronizes the desired state of an adapter Service
// against its current state in the running cluster.
func (r *GenericServiceReconciler) syncAdapterService(ctx context.Context,
currentAdapter, desiredAdapter *servingv1.Service) (*servingv1.Service, error) {
if semantic.Semantic.DeepEqual(desiredAdapter, currentAdapter) {
return currentAdapter, nil
}
// resourceVersion must be returned to the API server unmodified for
// optimistic concurrency, as per Kubernetes API conventions
desiredAdapter.ResourceVersion = currentAdapter.ResourceVersion
// immutable Knative annotations must be preserved
for _, ann := range knativeServingAnnotations {
if val, ok := currentAdapter.Annotations[ann]; ok {
metav1.SetMetaDataAnnotation(&desiredAdapter.ObjectMeta, ann, val)
}
}
// (fake Clientset) preserve status to avoid resetting conditions
desiredAdapter.Status = currentAdapter.Status
adapter, err := r.Client(currentAdapter.Namespace).Update(ctx, desiredAdapter, metav1.UpdateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedAdapterUpdate,
"Failed to update adapter Service %q: %s", desiredAdapter.Name, err)
}
event.Normal(ctx, ReasonAdapterUpdate, "Updated adapter Service %q", adapter.Name)
return adapter, nil
}
// findAdapter returns the adapter object for a given source if it exists.
func findAdapter(genericReconciler interface{},
src v1alpha1.EventSource, owner *metav1.OwnerReference) (metav1.Object, error) {
ls := CommonObjectLabels(src)
if !v1alpha1.IsMultiTenant(src) {
// the combination of standard labels {name,instance} is unique
// and immutable for single-tenant sources
ls[appInstanceLabel] = src.GetName()
}
sel := labels.SelectorFromValidatedSet(ls)
var objs []metav1.Object
var gr schema.GroupResource
switch r := genericReconciler.(type) {
case *GenericDeploymentReconciler:
depls, err := r.Lister(src.GetNamespace()).List(sel)
if err != nil {
return nil, err
}
for _, d := range depls {
objs = append(objs, d)
}
gr = appsv1.Resource("deployment")
case *GenericServiceReconciler:
svcs, err := r.Lister(src.GetNamespace()).List(sel)
if err != nil {
return nil, err
}
for _, s := range svcs {
objs = append(objs, s)
}
gr = servingv1.Resource("service")
}
for _, obj := range objs {
objOwner := metav1.GetControllerOfNoCopy(obj)
if objOwner.UID == owner.UID {
return obj, nil
}
}
return nil, newNotFoundForSelector(gr, sel)
}
// newNotFoundForSelector returns an error which indicates that no object of
// the type matching the given GroupResource was found for the given label
// selector.
func newNotFoundForSelector(gr schema.GroupResource, sel labels.Selector) *apierrors.StatusError {
err := apierrors.NewNotFound(gr, "")
err.ErrStatus.Message = fmt.Sprint(gr, " not found for selector ", sel)
return err
}
// reconcileRBAC wraps the reconciliation logic for RBAC objects.
func (r *GenericRBACReconciler) reconcileRBAC(ctx context.Context,
owners []kmeta.OwnerRefable) (*corev1.ServiceAccount, error) {
// The ServiceAccount's ownership is shared between all instances of a
// given source type. It gets garbage collected by Kubernetes as soon
// as its last owner (source) is deleted, so we don't need to clean
// things up explicitly once the last source gets deleted.
if len(owners) == 0 {
return nil, nil
}
src := v1alpha1.SourceFromContext(ctx)
desiredSA := newServiceAccount(src, owners)
currentSA, err := r.getOrCreateAdapterServiceAccount(ctx, desiredSA)
if err != nil {
return nil, err
}
desiredRB := newRoleBinding(src, currentSA)
currentRB, err := r.getOrCreateAdapterRoleBinding(ctx, desiredRB)
if err != nil {
return nil, err
}
if currentSA, err = r.syncAdapterServiceAccount(ctx, currentSA, desiredSA); err != nil {
return nil, fmt.Errorf("synchronizing adapter ServiceAccount: %w", err)
}
if _, err = r.syncAdapterRoleBinding(ctx, currentRB, desiredRB); err != nil {
return nil, fmt.Errorf("synchronizing adapter RoleBinding: %w", err)
}
return currentSA, nil
}
// getOrCreateAdapterServiceAccount returns the existing adapter ServiceAccount
// for a given source, or creates it if it is missing.
func (r *GenericRBACReconciler) getOrCreateAdapterServiceAccount(ctx context.Context,
desiredSA *corev1.ServiceAccount) (*corev1.ServiceAccount, error) {
src := v1alpha1.SourceFromContext(ctx)
sa, err := r.SALister(src.GetNamespace()).Get(desiredSA.Name)
switch {
case apierrors.IsNotFound(err):
sa, err = r.SAClient(desiredSA.Namespace).Create(ctx, desiredSA, metav1.CreateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedRBACCreate,
"Failed to create adapter ServiceAccount %q: %s", desiredSA.Name, err)
}
controller.GetEventRecorder(ctx).Eventf(newNamespace(desiredSA.Namespace), corev1.EventTypeNormal,
ReasonRBACCreate, "Created ServiceAccount %q due to the creation of a %s object",
sa.Name, src.GetGroupVersionKind().Kind)
case err != nil:
return nil, fmt.Errorf("getting adapter ServiceAccount from cache: %w", err)
}
return sa, nil
}
// syncAdapterServiceAccount synchronizes the desired state of an adapter
// ServiceAccount against its current state in the running cluster.
func (r *GenericRBACReconciler) syncAdapterServiceAccount(ctx context.Context,
currentSA, desiredSA *corev1.ServiceAccount) (*corev1.ServiceAccount, error) {
if reflect.DeepEqual(desiredSA.OwnerReferences, currentSA.OwnerReferences) {
return currentSA, nil
}
// resourceVersion must be returned to the API server unmodified for
// optimistic concurrency, as per Kubernetes API conventions
desiredSA.ResourceVersion = currentSA.ResourceVersion
// Kubernetes generates a secret named "<object_name>-token-<rand_id>"
// upon creation of a ServiceAccount. We need to preserve the reference
// to this secret during updates, otherwise Kubernetes generates a new
// secret without garbage collecting the old one(s).
for _, secr := range currentSA.Secrets {
if strings.HasPrefix(secr.Name, desiredSA.Name+"-token-") {
desiredSA.Secrets = append(desiredSA.Secrets, secr)
}
}
sa, err := r.SAClient(desiredSA.Namespace).Update(ctx, desiredSA, metav1.UpdateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedRBACUpdate,
"Failed to update adapter ServiceAccount %q: %s", desiredSA.Name, err)
}
controller.GetEventRecorder(ctx).Eventf(newNamespace(sa.Namespace), corev1.EventTypeNormal,
ReasonRBACUpdate, "Updated ServiceAccount %q due to the creation/deletion of a %s object",
sa.Name, v1alpha1.SourceFromContext(ctx).GetGroupVersionKind().Kind)
return sa, nil
}
// getOrCreateAdapterRoleBinding returns the existing adapter RoleBinding, or
// creates it if it is missing.
func (r *GenericRBACReconciler) getOrCreateAdapterRoleBinding(ctx context.Context,
desiredRB *rbacv1.RoleBinding) (*rbacv1.RoleBinding, error) {
src := v1alpha1.SourceFromContext(ctx)
rb, err := r.RBLister(desiredRB.Namespace).Get(desiredRB.Name)
switch {
case apierrors.IsNotFound(err):
rb, err = r.RBClient(src.GetNamespace()).Create(ctx, desiredRB, metav1.CreateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedRBACCreate,
"Failed to create adapter RoleBinding %q: %s", desiredRB.Name, err)
}
controller.GetEventRecorder(ctx).Eventf(newNamespace(rb.Namespace), corev1.EventTypeNormal,
ReasonRBACCreate, "Created RoleBinding %q due to the creation of a %s object",
rb.Name, src.GetGroupVersionKind().Kind)
case err != nil:
return nil, fmt.Errorf("getting adapter RoleBinding from cache: %w", err)
}
return rb, nil
}
// syncAdapterRoleBinding synchronizes the desired state of an adapter
// RoleBinding against its current state in the running cluster.
func (r *GenericRBACReconciler) syncAdapterRoleBinding(ctx context.Context,
currentRB, desiredRB *rbacv1.RoleBinding) (*rbacv1.RoleBinding, error) {
if reflect.DeepEqual(desiredRB.OwnerReferences, currentRB.OwnerReferences) &&
reflect.DeepEqual(desiredRB.RoleRef, currentRB.RoleRef) &&
reflect.DeepEqual(desiredRB.Subjects, currentRB.Subjects) {
return currentRB, nil
}
// resourceVersion must be returned to the API server unmodified for
// optimistic concurrency, as per Kubernetes API conventions
desiredRB.ResourceVersion = currentRB.ResourceVersion
rb, err := r.RBClient(desiredRB.Namespace).Update(ctx, desiredRB, metav1.UpdateOptions{})
if err != nil {
return nil, reconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedRBACUpdate,
"Failed to update adapter RoleBinding %q: %s", desiredRB.Name, err)
}
controller.GetEventRecorder(ctx).Eventf(newNamespace(rb.Namespace), corev1.EventTypeNormal,
ReasonRBACUpdate, "Updated RoleBinding %q", rb.Name)
return rb, nil
}
// newNamespace returns a Namespace object with the given name.
// It is used as a helper to record namespace-scoped API events.
func newNamespace(name string) *corev1.Namespace {
return &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: name,
},
}
}