/
reconciler.go
301 lines (252 loc) · 11.6 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
// Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 extension
import (
"context"
"fmt"
"time"
"github.com/go-logr/logr"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/runtime/inject"
"sigs.k8s.io/controller-runtime/pkg/source"
extensionscontroller "github.com/gardener/gardener/extensions/pkg/controller"
extensionshandler "github.com/gardener/gardener/extensions/pkg/handler"
extensionspredicate "github.com/gardener/gardener/extensions/pkg/predicate"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
gardencorev1beta1helper "github.com/gardener/gardener/pkg/apis/core/v1beta1/helper"
extensionsv1alpha1 "github.com/gardener/gardener/pkg/apis/extensions/v1alpha1"
"github.com/gardener/gardener/pkg/controllerutils"
)
const (
// FinalizerPrefix is the prefix name of the finalizer written by this controller.
FinalizerPrefix = "extensions.gardener.cloud"
)
// AddArgs are arguments for adding an Extension resources controller to a manager.
type AddArgs struct {
// Actuator is an Extension resource actuator.
Actuator Actuator
// Name is the name of the controller.
Name string
// FinalizerSuffix is the suffix for the finalizer name.
FinalizerSuffix string
// ControllerOptions are the controller options used for creating a controller.
// The options.Reconciler is always overridden with a reconciler created from the
// given actuator.
ControllerOptions controller.Options
// Predicates are the predicates to use.
Predicates []predicate.Predicate
// Resync determines the requeue interval.
Resync time.Duration
// Type is the type of the resource considered for reconciliation.
Type string
// IgnoreOperationAnnotation specifies whether to ignore the operation annotation or not.
// If the annotation is not ignored, the extension controller will only reconcile
// with a present operation annotation typically set during a reconcile (e.g in the maintenance time) by the Gardenlet
IgnoreOperationAnnotation bool
}
// Add adds an Extension controller to the given manager using the given AddArgs.
func Add(mgr manager.Manager, args AddArgs) error {
args.ControllerOptions.Reconciler = NewReconciler(args)
return add(mgr, args)
}
// DefaultPredicates returns the default predicates for an extension reconciler.
func DefaultPredicates(ignoreOperationAnnotation bool) []predicate.Predicate {
if ignoreOperationAnnotation {
return []predicate.Predicate{
predicate.GenerationChangedPredicate{},
}
}
return []predicate.Predicate{
predicate.Or(
extensionspredicate.HasOperationAnnotation(),
extensionspredicate.LastOperationNotSuccessful(),
extensionspredicate.IsDeleting(),
),
extensionspredicate.ShootNotFailed(),
}
}
func add(mgr manager.Manager, args AddArgs) error {
ctrl, err := controller.New(args.Name, mgr, args.ControllerOptions)
if err != nil {
return err
}
predicates := extensionspredicate.AddTypePredicate(args.Predicates, args.Type)
if args.IgnoreOperationAnnotation {
if err := ctrl.Watch(
&source.Kind{Type: &extensionsv1alpha1.Cluster{}},
extensionshandler.EnqueueRequestsFromMapper(ClusterToExtensionMapper(predicates...), extensionshandler.UpdateWithNew),
); err != nil {
return err
}
}
return ctrl.Watch(&source.Kind{Type: &extensionsv1alpha1.Extension{}}, &handler.EnqueueRequestForObject{}, predicates...)
}
// reconciler reconciles Extension resources of Gardener's
// `extensions.gardener.cloud` API group.
type reconciler struct {
logger logr.Logger
actuator Actuator
client client.Client
reader client.Reader
statusUpdater extensionscontroller.StatusUpdater
resync time.Duration
finalizerName string
}
// NewReconciler creates a new reconcile.Reconciler that reconciles
// Extension resources of Gardener's `extensions.gardener.cloud` API group.
func NewReconciler(args AddArgs) reconcile.Reconciler {
logger := log.Log.WithName(args.Name)
return extensionscontroller.OperationAnnotationWrapper(
func() client.Object { return &extensionsv1alpha1.Extension{} },
&reconciler{
logger: logger,
actuator: args.Actuator,
statusUpdater: extensionscontroller.NewStatusUpdater(logger),
finalizerName: fmt.Sprintf("%s/%s", FinalizerPrefix, args.FinalizerSuffix),
resync: args.Resync,
},
)
}
// InjectFunc enables dependency injection into the actuator.
func (r *reconciler) InjectFunc(f inject.Func) error {
return f(r.actuator)
}
// InjectClient injects the controller runtime client into the reconciler.
func (r *reconciler) InjectClient(client client.Client) error {
r.client = client
r.statusUpdater.InjectClient(client)
return nil
}
func (r *reconciler) InjectAPIReader(reader client.Reader) error {
r.reader = reader
return nil
}
// Reconcile is the reconciler function that gets executed in case there are new events for `Extension` resources.
func (r *reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {
ex := &extensionsv1alpha1.Extension{}
if err := r.client.Get(ctx, request.NamespacedName, ex); err != nil {
if apierrors.IsNotFound(err) {
return reconcile.Result{}, nil
}
return reconcile.Result{}, fmt.Errorf("could not fetch Extension resource: %+v", err)
}
var result reconcile.Result
shoot, err := extensionscontroller.GetShoot(ctx, r.client, request.Namespace)
if err != nil {
return reconcile.Result{}, err
}
if extensionscontroller.IsShootFailed(shoot) {
r.logger.Info("Stop reconciling Extension of failed Shoot.", "namespace", request.Namespace, "name", ex.Name)
return reconcile.Result{}, nil
}
operationType := gardencorev1beta1helper.ComputeOperationType(ex.ObjectMeta, ex.Status.LastOperation)
switch {
case extensionscontroller.IsMigrated(ex):
return reconcile.Result{}, nil
case operationType == gardencorev1beta1.LastOperationTypeMigrate:
return r.migrate(ctx, ex)
case ex.DeletionTimestamp != nil:
return r.delete(ctx, ex)
case ex.Annotations[v1beta1constants.GardenerOperation] == v1beta1constants.GardenerOperationRestore:
return r.restore(ctx, ex, operationType)
default:
if result, err = r.reconcile(ctx, ex, operationType); err != nil {
return result, err
}
return reconcile.Result{Requeue: r.resync != 0, RequeueAfter: r.resync}, nil
}
}
func (r *reconciler) reconcile(ctx context.Context, ex *extensionsv1alpha1.Extension, operationType gardencorev1beta1.LastOperationType) (reconcile.Result, error) {
if err := controllerutils.EnsureFinalizer(ctx, r.reader, r.client, ex, r.finalizerName); err != nil {
return reconcile.Result{}, err
}
if err := r.statusUpdater.Processing(ctx, ex, operationType, "Reconciling Extension resource"); err != nil {
return reconcile.Result{}, err
}
if err := r.actuator.Reconcile(ctx, ex); err != nil {
_ = r.statusUpdater.Error(ctx, ex, extensionscontroller.ReconcileErrCauseOrErr(err), operationType, "Unable to reconcile Extension resource")
return extensionscontroller.ReconcileErr(err)
}
if err := r.statusUpdater.Success(ctx, ex, operationType, "Successfully reconciled Extension resource"); err != nil {
return reconcile.Result{}, err
}
return reconcile.Result{}, nil
}
func (r *reconciler) delete(ctx context.Context, ex *extensionsv1alpha1.Extension) (reconcile.Result, error) {
if !controllerutil.ContainsFinalizer(ex, r.finalizerName) {
r.logger.Info("Reconciling Extension resource causes a no-op as there is no finalizer.", "extension", ex.Name, "namespace", ex.Namespace)
return reconcile.Result{}, nil
}
if err := r.statusUpdater.Processing(ctx, ex, gardencorev1beta1.LastOperationTypeDelete, "Deleting Extension resource."); err != nil {
return reconcile.Result{}, err
}
if err := r.actuator.Delete(ctx, ex); err != nil {
_ = r.statusUpdater.Error(ctx, ex, extensionscontroller.ReconcileErrCauseOrErr(err), gardencorev1beta1.LastOperationTypeDelete, "Error deleting Extension resource")
return extensionscontroller.ReconcileErr(err)
}
if err := r.statusUpdater.Success(ctx, ex, gardencorev1beta1.LastOperationTypeDelete, "Successfully deleted Extension resource"); err != nil {
return reconcile.Result{}, err
}
if err := controllerutils.RemoveFinalizer(ctx, r.reader, r.client, ex, r.finalizerName); err != nil {
return reconcile.Result{}, fmt.Errorf("error removing finalizer from Extension resource: %+v", err)
}
return reconcile.Result{}, nil
}
func (r *reconciler) restore(ctx context.Context, ex *extensionsv1alpha1.Extension, operationType gardencorev1beta1.LastOperationType) (reconcile.Result, error) {
if err := controllerutils.EnsureFinalizer(ctx, r.reader, r.client, ex, r.finalizerName); err != nil {
return reconcile.Result{}, err
}
if err := r.statusUpdater.Processing(ctx, ex, operationType, "Restoring Extension resource"); err != nil {
return reconcile.Result{}, err
}
if err := r.actuator.Restore(ctx, ex); err != nil {
_ = r.statusUpdater.Error(ctx, ex, extensionscontroller.ReconcileErrCauseOrErr(err), operationType, "Unable to restore Extension resource")
return extensionscontroller.ReconcileErr(err)
}
if err := r.statusUpdater.Success(ctx, ex, operationType, "Successfully restored Extension resource"); err != nil {
return reconcile.Result{}, err
}
if err := extensionscontroller.RemoveAnnotation(ctx, r.client, ex, v1beta1constants.GardenerOperation); err != nil {
return reconcile.Result{}, fmt.Errorf("error removing annotation from Extension resource: %+v", err)
}
return reconcile.Result{}, nil
}
func (r *reconciler) migrate(ctx context.Context, ex *extensionsv1alpha1.Extension) (reconcile.Result, error) {
if err := r.statusUpdater.Processing(ctx, ex, gardencorev1beta1.LastOperationTypeMigrate, "Migrate Extension resource."); err != nil {
return reconcile.Result{}, err
}
if err := r.actuator.Migrate(ctx, ex); err != nil {
_ = r.statusUpdater.Error(ctx, ex, extensionscontroller.ReconcileErrCauseOrErr(err), gardencorev1beta1.LastOperationTypeMigrate, "Error migrating Extension resource")
return extensionscontroller.ReconcileErr(err)
}
if err := r.statusUpdater.Success(ctx, ex, gardencorev1beta1.LastOperationTypeMigrate, "Successfully migrated Extension resource"); err != nil {
return reconcile.Result{}, err
}
if err := extensionscontroller.DeleteAllFinalizers(ctx, r.client, ex); err != nil {
return reconcile.Result{}, fmt.Errorf("error removing all finalizers from Extension resource: %+v", err)
}
if err := extensionscontroller.RemoveAnnotation(ctx, r.client, ex, v1beta1constants.GardenerOperation); err != nil {
return reconcile.Result{}, fmt.Errorf("error removing annotation from Extension resource: %+v", err)
}
return reconcile.Result{}, nil
}