generated from kyma-project/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 15
/
reconciler.go
381 lines (329 loc) · 14.1 KB
/
reconciler.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
package jetstream
import (
"context"
"errors"
"reflect"
"time"
"github.com/nats-io/nats.go"
pkgerrors "github.com/pkg/errors"
"go.uber.org/zap"
ktypes "k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
kctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
eventingv1alpha2 "github.com/kyma-project/eventing-manager/api/eventing/v1alpha2"
"github.com/kyma-project/eventing-manager/internal/controller/eventing/subscription/validator"
"github.com/kyma-project/eventing-manager/internal/controller/events"
"github.com/kyma-project/eventing-manager/pkg/backend/cleaner"
"github.com/kyma-project/eventing-manager/pkg/backend/jetstream"
"github.com/kyma-project/eventing-manager/pkg/backend/metrics"
backendutils "github.com/kyma-project/eventing-manager/pkg/backend/utils"
emerrors "github.com/kyma-project/eventing-manager/pkg/errors"
"github.com/kyma-project/eventing-manager/pkg/logger"
"github.com/kyma-project/eventing-manager/pkg/object"
"github.com/kyma-project/eventing-manager/pkg/utils"
)
const (
reconcilerName = "jetstream-subscription-reconciler"
requeueDuration = 10 * time.Second
backendType = "NATS_Jetstream"
)
type Reconciler struct {
client.Client
Backend jetstream.Backend
recorder record.EventRecorder
logger *logger.Logger
cleaner cleaner.Cleaner
subscriptionValidator validator.SubscriptionValidator
customEventsChannel chan event.GenericEvent
collector *metrics.Collector
}
func NewReconciler(client client.Client, jsBackend jetstream.Backend,
logger *logger.Logger, recorder record.EventRecorder, cleaner cleaner.Cleaner,
subscriptionValidator validator.SubscriptionValidator, collector *metrics.Collector,
) *Reconciler {
reconciler := &Reconciler{
Client: client,
Backend: jsBackend,
recorder: recorder,
logger: logger,
cleaner: cleaner,
subscriptionValidator: subscriptionValidator,
customEventsChannel: make(chan event.GenericEvent),
collector: collector,
}
return reconciler
}
// SetupUnmanaged creates a controller under the client control.
func (r *Reconciler) SetupUnmanaged(ctx context.Context, mgr kctrl.Manager) error {
ctru, err := controller.NewUnmanaged(reconcilerName, mgr, controller.Options{Reconciler: r})
if err != nil {
r.namedLogger().Errorw("Failed to create unmanaged controller", "error", err)
return err
}
if err := ctru.Watch(source.Kind(mgr.GetCache(), &eventingv1alpha2.Subscription{}),
&handler.EnqueueRequestForObject{}); err != nil {
r.namedLogger().Errorw("Failed to setup watch for subscriptions", "error", err)
return err
}
if err := ctru.Watch(&source.Channel{Source: r.customEventsChannel},
&handler.EnqueueRequestForObject{}); err != nil {
r.namedLogger().Errorw("Failed to setup watch for custom channel", "error", err)
return err
}
go func(r *Reconciler, c controller.Controller) {
if err := c.Start(ctx); err != nil {
r.namedLogger().Fatalw("Failed to start controller", "error", err)
}
}(r, ctru)
return nil
}
//nolint:lll
// +kubebuilder:rbac:groups=eventing.kyma-project.io,resources=subscriptions,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=eventing.kyma-project.io,resources=subscriptions/status,verbs=get;update;patch
// Generate required RBAC to emit kubernetes events in the controller.
// +kubebuilder:rbac:groups="",resources=events,verbs=create;patch
func (r *Reconciler) Reconcile(ctx context.Context, req kctrl.Request) (kctrl.Result, error) {
r.namedLogger().Debugw("Received subscription v1alpha2 reconciliation request",
"namespace", req.Namespace, "name", req.Name)
// fetch current subscription object and ensure the object was not deleted in the meantime
currentSubscription := &eventingv1alpha2.Subscription{}
if err := r.Client.Get(ctx, req.NamespacedName, currentSubscription); err != nil {
return kctrl.Result{}, client.IgnoreNotFound(err)
}
// copy the subscription object, so we don't modify the source object
desiredSubscription := currentSubscription.DeepCopy()
// Bind fields to logger
log := backendutils.LoggerWithSubscription(r.namedLogger(), desiredSubscription)
if isInDeletion(desiredSubscription) {
// The object is being deleted
return r.handleSubscriptionDeletion(ctx, desiredSubscription, log)
}
defer r.updateSubscriptionMetrics(currentSubscription, desiredSubscription)
// The object is not being deleted, so if it does not have our finalizer,
// then lets add the finalizer and update the object.
if !containsFinalizer(desiredSubscription) {
return r.addFinalizer(ctx, desiredSubscription)
}
// Validate subscription.
if validationErr := r.validateSubscription(ctx, desiredSubscription); validationErr != nil {
if errors.Is(validationErr, validator.ErrSinkValidationFailed) {
if deleteErr := r.Backend.DeleteSubscriptionsOnly(desiredSubscription); deleteErr != nil {
log.Errorw("Failed to delete JetStream subscriptions", "error", deleteErr)
return kctrl.Result{}, deleteErr
}
}
if updateErr := r.updateSubscriptionStatus(ctx, desiredSubscription, log); updateErr != nil {
return kctrl.Result{}, errors.Join(validationErr, updateErr)
}
return kctrl.Result{}, reconcile.TerminalError(validationErr)
}
// update the cleanEventTypes and config values in the subscription status, if changed
if err := r.syncEventTypes(desiredSubscription); err != nil {
if syncErr := r.syncSubscriptionStatus(ctx, desiredSubscription, err, log); syncErr != nil {
return kctrl.Result{}, err
}
return kctrl.Result{}, err
}
// Synchronize Kyma subscription to JetStream backend
if syncSubErr := r.Backend.SyncSubscription(desiredSubscription); syncSubErr != nil {
result := kctrl.Result{}
if syncErr := r.syncSubscriptionStatus(ctx, desiredSubscription, syncSubErr, log); syncErr != nil {
return result, syncErr
}
// Requeue the Request to reconcile it again if there are no NATS Subscriptions synced
if pkgerrors.Is(syncSubErr, jetstream.ErrMissingSubscription) {
result = kctrl.Result{RequeueAfter: requeueDuration}
syncSubErr = nil
}
return result, syncSubErr
}
// Update Subscription status
return kctrl.Result{}, r.syncSubscriptionStatus(ctx, desiredSubscription, nil, log)
}
func (r *Reconciler) validateSubscription(ctx context.Context, subscription *eventingv1alpha2.Subscription) error {
var err error
if err = r.subscriptionValidator.Validate(ctx, *subscription); err != nil {
subscription.Status.SetNotReady()
subscription.Status.ClearTypes()
subscription.Status.ClearBackend()
subscription.Status.ClearConditions()
}
subscription.Status.SetSubscriptionSpecValidCondition(err)
return err
}
func (r *Reconciler) updateSubscriptionMetrics(current, desired *eventingv1alpha2.Subscription) {
for _, currentType := range current.Status.Backend.Types {
found := false
for _, dc := range desired.Status.Backend.Types {
if currentType.ConsumerName == dc.ConsumerName {
found = true
}
}
if !found {
r.collector.RemoveSubscriptionStatus(
current.Name,
current.Namespace,
backendType,
currentType.ConsumerName,
r.Backend.GetConfig().JSStreamName)
}
}
for _, desiredType := range desired.Status.Backend.Types {
r.collector.RecordSubscriptionStatus(desired.Status.Ready,
desired.Name,
desired.Namespace,
backendType,
desiredType.ConsumerName,
r.Backend.GetConfig().JSStreamName,
)
}
}
// HandleNatsConnClose is called by NATS when the connection to the NATS server is closed. When it
// is called, the reconnect-attempts have exceeded the defined value.
// It forces reconciling the subscription to make sure the subscription is marked as not ready, until
// it is possible to connect to the NATS server again.
func (r *Reconciler) HandleNatsConnClose(_ *nats.Conn) {
r.namedLogger().Info("JetStream connection is closed and reconnect attempts are exceeded!")
var subs eventingv1alpha2.SubscriptionList
if err := r.Client.List(context.Background(), &subs); err != nil {
// NATS reconnect attempts are exceeded, and we cannot reconcile subscriptions! If we ignore this,
// there will be no future chance to retry connecting to NATS!
panic(err)
}
r.enqueueReconciliationForSubscriptions(subs.Items)
}
// enqueueReconciliationForSubscriptions adds the subscriptions to the customEventsChannel
// which is being watched by the controller.
func (r *Reconciler) enqueueReconciliationForSubscriptions(subs []eventingv1alpha2.Subscription) {
r.namedLogger().Debug("Enqueuing reconciliation request for all subscriptions")
for i := range subs {
r.customEventsChannel <- event.GenericEvent{Object: &subs[i]}
}
}
// handleSubscriptionDeletion deletes the JetStream subscription and removes its finalizer if it is set.
func (r *Reconciler) handleSubscriptionDeletion(ctx context.Context,
subscription *eventingv1alpha2.Subscription, log *zap.SugaredLogger,
) (kctrl.Result, error) {
// delete the JetStream subscription/consumer
if !utils.ContainsString(subscription.ObjectMeta.Finalizers, eventingv1alpha2.Finalizer) {
return kctrl.Result{}, nil
}
if err := r.Backend.DeleteSubscription(subscription); err != nil {
deleteSubErr := emerrors.MakeError(errFailedToDeleteSub, err)
// if failed to delete the external dependency here, return with error
// so that it can be retried
if syncErr := r.syncSubscriptionStatus(ctx, subscription, deleteSubErr, log); syncErr != nil {
return kctrl.Result{}, syncErr
}
return kctrl.Result{}, deleteSubErr
}
types := subscription.Status.Backend.Types
// remove the eventing finalizer from the list and update the subscription.
subscription.ObjectMeta.Finalizers = utils.RemoveString(subscription.ObjectMeta.Finalizers,
eventingv1alpha2.Finalizer)
// update the subscription's finalizers in k8s
if err := r.Update(ctx, subscription); err != nil {
return kctrl.Result{}, emerrors.MakeError(errFailedToUpdateFinalizers, err)
}
for _, t := range types {
r.collector.RemoveSubscriptionStatus(
subscription.Name,
subscription.Namespace,
backendType,
t.ConsumerName,
r.Backend.GetConfig().JSStreamName,
)
}
return kctrl.Result{}, nil
}
// syncSubscriptionStatus syncs Subscription status and updates the k8s subscription.
func (r *Reconciler) syncSubscriptionStatus(ctx context.Context,
desiredSubscription *eventingv1alpha2.Subscription, err error, log *zap.SugaredLogger,
) error {
// set ready state
desiredSubscription.Status.Ready = err == nil
// set the desired conditions
eventingv1alpha2.SetSubscriptionActiveCondition(&desiredSubscription.Status, err)
// Update the subscription
return r.updateSubscriptionStatus(ctx, desiredSubscription, log)
}
// updateSubscriptionStatus updates the subscription's status changes to k8s.
func (r *Reconciler) updateSubscriptionStatus(ctx context.Context,
sub *eventingv1alpha2.Subscription, logger *zap.SugaredLogger,
) error {
namespacedName := &ktypes.NamespacedName{
Name: sub.Name,
Namespace: sub.Namespace,
}
// fetch the latest subscription object, to avoid k8s conflict errors
actualSubscription := &eventingv1alpha2.Subscription{}
if err := r.Client.Get(ctx, *namespacedName, actualSubscription); err != nil {
return err
}
// copy new changes to the latest object
desiredSubscription := actualSubscription.DeepCopy()
desiredSubscription.Status = sub.Status
// sync subscription status with k8s
if err := r.updateStatus(ctx, actualSubscription, desiredSubscription, logger); err != nil {
return emerrors.MakeError(errFailedToUpdateStatus, err)
}
return nil
}
// updateStatus updates the status to k8s if modified.
func (r *Reconciler) updateStatus(ctx context.Context, oldSubscription,
newSubscription *eventingv1alpha2.Subscription, logger *zap.SugaredLogger,
) error {
// compare the status taking into consideration lastTransitionTime in conditions
if object.IsSubscriptionStatusEqual(oldSubscription.Status, newSubscription.Status) {
return nil
}
// update the status for subscription in k8s
if err := r.Status().Update(ctx, newSubscription); err != nil {
events.Warn(r.recorder, newSubscription, events.ReasonUpdateFailed,
"Update Subscription status failed %s", newSubscription.Name)
return emerrors.MakeError(errFailedToUpdateStatus, err)
}
events.Normal(r.recorder, newSubscription, events.ReasonUpdate,
"Update Subscription status succeeded %s", newSubscription.Name)
logger.Debugw("Updated subscription status",
"oldStatus", oldSubscription.Status, "newStatus", newSubscription.Status)
return nil
}
// addFinalizer appends the eventing finalizer to the subscription and updates it in k8s.
func (r *Reconciler) addFinalizer(ctx context.Context, sub *eventingv1alpha2.Subscription) (kctrl.Result, error) {
sub.ObjectMeta.Finalizers = append(sub.ObjectMeta.Finalizers, eventingv1alpha2.Finalizer)
// update the subscription's finalizers in k8s
if err := r.Update(ctx, sub); err != nil {
return kctrl.Result{}, emerrors.MakeError(errFailedToUpdateFinalizers, err)
}
return kctrl.Result{}, nil
}
// syncEventTypes sets the latest cleaned types and jetStreamTypes to the subscription status.
func (r *Reconciler) syncEventTypes(desiredSubscription *eventingv1alpha2.Subscription) error {
// clean types
cleanedTypes := jetstream.GetCleanEventTypes(desiredSubscription, r.cleaner)
if !reflect.DeepEqual(desiredSubscription.Status.Types, cleanedTypes) {
desiredSubscription.Status.Types = cleanedTypes
}
// jetStreamTypes
jsSubjects := r.Backend.GetJetStreamSubjects(desiredSubscription.Spec.Source,
jetstream.GetCleanEventTypesFromEventTypes(cleanedTypes),
desiredSubscription.Spec.TypeMatching)
jsTypes, err := jetstream.GetBackendJetStreamTypes(desiredSubscription, jsSubjects)
if err != nil {
return err
}
if !reflect.DeepEqual(desiredSubscription.Status.Backend.Types, jsTypes) {
desiredSubscription.Status.Backend.Types = jsTypes
}
return nil
}
func (r *Reconciler) namedLogger() *zap.SugaredLogger {
return r.logger.WithContext().Named(reconcilerName)
}