-
Notifications
You must be signed in to change notification settings - Fork 474
/
backup_bucket_reconciler.go
288 lines (248 loc) · 13.3 KB
/
backup_bucket_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
// 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 backupbucket
import (
"context"
"errors"
"fmt"
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"
"github.com/gardener/gardener/pkg/client/kubernetes"
"github.com/gardener/gardener/pkg/client/kubernetes/clientmap"
"github.com/gardener/gardener/pkg/client/kubernetes/clientmap/keys"
"github.com/gardener/gardener/pkg/controllerutils"
"github.com/gardener/gardener/pkg/gardenlet/apis/config"
"github.com/gardener/gardener/pkg/logger"
"github.com/gardener/gardener/pkg/operation/common"
utilerrors "github.com/gardener/gardener/pkg/utils/errors"
kutil "github.com/gardener/gardener/pkg/utils/kubernetes"
"github.com/sirupsen/logrus"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
// reconciler implements the reconcile.Reconcile interface for backupBucket reconciliation.
type reconciler struct {
clientMap clientmap.ClientMap
recorder record.EventRecorder
logger *logrus.Logger
config *config.GardenletConfiguration
}
// newReconciler returns the new backupBucker reconciler.
func newReconciler(clientMap clientmap.ClientMap, recorder record.EventRecorder, config *config.GardenletConfiguration) reconcile.Reconciler {
return &reconciler{
clientMap: clientMap,
recorder: recorder,
logger: logger.Logger,
config: config,
}
}
func (r *reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {
gardenClient, err := r.clientMap.GetClient(ctx, keys.ForGarden())
if err != nil {
return reconcile.Result{}, fmt.Errorf("failed to get garden client: %w", err)
}
bb := &gardencorev1beta1.BackupBucket{}
if err := gardenClient.Client().Get(ctx, request.NamespacedName, bb); err != nil {
if apierrors.IsNotFound(err) {
r.logger.Debugf("[BACKUPBUCKET RECONCILE] %s - skipping because BackupBucket has been deleted", request.NamespacedName)
return reconcile.Result{}, nil
}
r.logger.Infof("[BACKUPBUCKET RECONCILE] %s - unable to retrieve object from store: %v", request.NamespacedName, err)
return reconcile.Result{}, err
}
if bb.Spec.SeedName == nil {
message := "Cannot reconcile BackupBucket: Waiting for BackupBucket to get scheduled on a Seed"
r.recorder.Event(bb, corev1.EventTypeWarning, "OperationPending", message)
return reconcile.Result{}, utilerrors.WithSuppressed(fmt.Errorf("backupBucket %s has not yet been scheduled on a Seed", bb.Name), updateBackupBucketStatusPending(ctx, gardenClient.Client(), bb, message))
}
if bb.DeletionTimestamp != nil {
return r.deleteBackupBucket(ctx, gardenClient, bb)
}
// When a BackupBucket deletion timestamp is not set we need to create/reconcile the backup bucket.
return r.reconcileBackupBucket(ctx, gardenClient, bb)
}
func (r *reconciler) reconcileBackupBucket(ctx context.Context, gardenClient kubernetes.Interface, backupBucket *gardencorev1beta1.BackupBucket) (reconcile.Result, error) {
backupBucketLogger := logger.NewFieldLogger(logger.Logger, "backupbucket", backupBucket.Name)
if err := controllerutils.PatchAddFinalizers(ctx, gardenClient.Client(), backupBucket, gardencorev1beta1.GardenerName); err != nil {
backupBucketLogger.Errorf("Failed to ensure gardener finalizer on backupbucket: %+v", err)
return reconcile.Result{}, err
}
if updateErr := updateBackupBucketStatusProcessing(ctx, gardenClient.DirectClient(), backupBucket, "Reconciliation of Backup Bucket state in progress.", 2); updateErr != nil {
backupBucketLogger.Errorf("Could not update the BackupBucket status after reconciliation start: %+v", updateErr)
return reconcile.Result{}, updateErr
}
secret, err := common.GetSecretFromSecretRef(ctx, gardenClient.Client(), &backupBucket.Spec.SecretRef)
if err != nil {
msg := fmt.Sprintf("Failed to get backup secret (%s/%s): %+v", backupBucket.Spec.SecretRef.Namespace, backupBucket.Spec.SecretRef.Name, err)
backupBucketLogger.Error(msg)
r.recorder.Eventf(backupBucket, corev1.EventTypeWarning, gardencorev1beta1.EventReconcileError, "%s", msg)
return reconcile.Result{}, err
}
if err := controllerutils.PatchAddFinalizers(ctx, gardenClient.Client(), secret, gardencorev1beta1.ExternalGardenerName); err != nil {
backupBucketLogger.Errorf("Failed to ensure external gardener finalizer on referred secret: %+v", err)
return reconcile.Result{}, err
}
seedClient, err := r.clientMap.GetClient(ctx, keys.ForSeedWithName(*backupBucket.Spec.SeedName))
if err != nil {
return reconcile.Result{}, fmt.Errorf("failed to get seed client: %w", err)
}
a := newActuator(gardenClient, seedClient, backupBucket, r.logger)
if err := a.Reconcile(ctx); err != nil {
backupBucketLogger.Errorf("Failed to reconcile backup bucket: %+v", err)
reconcileErr := &gardencorev1beta1.LastError{
Codes: gardencorev1beta1helper.ExtractErrorCodes(err),
Description: err.Error(),
}
r.recorder.Eventf(backupBucket, corev1.EventTypeWarning, gardencorev1beta1.EventReconcileError, "%s", reconcileErr.Description)
if updateErr := updateBackupBucketStatusError(ctx, gardenClient.DirectClient(), backupBucket, reconcileErr.Description+" Operation will be retried.", reconcileErr); updateErr != nil {
backupBucketLogger.Errorf("Could not update the BackupBucket status after deletion error: %+v", updateErr)
return reconcile.Result{}, updateErr
}
return reconcile.Result{}, errors.New(reconcileErr.Description)
}
if updateErr := updateBackupBucketStatusSucceeded(ctx, gardenClient.DirectClient(), backupBucket, "Backup Bucket has been successfully reconciled."); updateErr != nil {
backupBucketLogger.Errorf("Could not update the Shoot status after reconciliation success: %+v", updateErr)
return reconcile.Result{}, updateErr
}
return reconcile.Result{}, nil
}
func (r *reconciler) deleteBackupBucket(ctx context.Context, gardenClient kubernetes.Interface, backupBucket *gardencorev1beta1.BackupBucket) (reconcile.Result, error) {
backupBucketLogger := logger.NewFieldLogger(r.logger, "backupbucket", backupBucket.Name)
if !sets.NewString(backupBucket.Finalizers...).Has(gardencorev1beta1.GardenerName) {
backupBucketLogger.Debug("Do not need to do anything as the BackupBucket does not have my finalizer")
return reconcile.Result{}, nil
}
if updateErr := updateBackupBucketStatusProcessing(ctx, gardenClient.DirectClient(), backupBucket, "Deletion of Backup Bucket in progress.", 2); updateErr != nil {
backupBucketLogger.Errorf("Could not update the BackupBucket status after deletion start: %+v", updateErr)
return reconcile.Result{}, updateErr
}
associatedBackupEntries := make([]string, 0)
backupEntryList := &gardencorev1beta1.BackupEntryList{}
if err := gardenClient.DirectClient().List(ctx, backupEntryList); err != nil {
backupBucketLogger.Errorf("Could not list the backup entries associated with backupbucket: %s", err)
return reconcile.Result{}, err
}
for _, entry := range backupEntryList.Items {
if entry.Spec.BucketName == backupBucket.Name {
associatedBackupEntries = append(associatedBackupEntries, fmt.Sprintf("%s/%s", entry.Namespace, entry.Name))
}
}
if len(associatedBackupEntries) != 0 {
message := fmt.Sprintf("Can't delete BackupBucket, because the following BackupEntries are still referencing it: %+v", associatedBackupEntries)
backupBucketLogger.Info(message)
r.recorder.Event(backupBucket, corev1.EventTypeNormal, v1beta1constants.EventResourceReferenced, message)
return reconcile.Result{}, fmt.Errorf("BackupBucket %s still has references", backupBucket.Name)
}
backupBucketLogger.Infof("No BackupEntries are referencing the BackupBucket. Deletion accepted.")
seedClient, err := r.clientMap.GetClient(ctx, keys.ForSeedWithName(*backupBucket.Spec.SeedName))
if err != nil {
return reconcile.Result{}, fmt.Errorf("failed to get seed client: %w", err)
}
a := newActuator(gardenClient, seedClient, backupBucket, r.logger)
if err := a.Delete(ctx); err != nil {
backupBucketLogger.Errorf("Failed to delete backup bucket: %+v", err)
deleteErr := &gardencorev1beta1.LastError{
Codes: gardencorev1beta1helper.ExtractErrorCodes(err),
Description: err.Error(),
}
r.recorder.Eventf(backupBucket, corev1.EventTypeWarning, gardencorev1beta1.EventDeleteError, "%s", deleteErr.Description)
if updateErr := updateBackupBucketStatusError(ctx, gardenClient.DirectClient(), backupBucket, deleteErr.Description+" Operation will be retried.", deleteErr); updateErr != nil {
backupBucketLogger.Errorf("Could not update the BackupBucket status after deletion error: %+v", updateErr)
return reconcile.Result{}, updateErr
}
return reconcile.Result{}, errors.New(deleteErr.Description)
}
if updateErr := updateBackupBucketStatusSucceeded(ctx, gardenClient.DirectClient(), backupBucket, "Backup Bucket has been successfully deleted."); updateErr != nil {
backupBucketLogger.Errorf("Could not update the BackupBucket status after deletion successful: %+v", updateErr)
return reconcile.Result{}, updateErr
}
backupBucketLogger.Infof("Successfully deleted backup bucket %q", backupBucket.Name)
secret, err := common.GetSecretFromSecretRef(ctx, gardenClient.Client(), &backupBucket.Spec.SecretRef)
if err != nil {
backupBucketLogger.Errorf("Failed to get referred secret: %+v", err)
return reconcile.Result{}, err
}
if err := controllerutils.PatchRemoveFinalizers(ctx, gardenClient.Client(), secret, gardencorev1beta1.ExternalGardenerName); err != nil {
backupBucketLogger.Errorf("Failed to remove external gardener finalizer on referred secret: %+v", err)
return reconcile.Result{}, err
}
return reconcile.Result{}, controllerutils.PatchRemoveFinalizers(ctx, gardenClient.Client(), backupBucket, gardencorev1beta1.GardenerName)
}
func updateBackupBucketStatusProcessing(ctx context.Context, c client.Client, bb *gardencorev1beta1.BackupBucket, message string, progress int32) error {
return kutil.TryUpdateStatus(ctx, retry.DefaultBackoff, c, bb, func() error {
bb.Status.LastOperation = &gardencorev1beta1.LastOperation{
Type: gardencorev1beta1helper.ComputeOperationType(bb.ObjectMeta, bb.Status.LastOperation),
State: gardencorev1beta1.LastOperationStateProcessing,
Progress: progress,
Description: message,
LastUpdateTime: metav1.Now(),
}
return nil
})
}
func updateBackupBucketStatusError(ctx context.Context, c client.Client, bb *gardencorev1beta1.BackupBucket, message string, lastError *gardencorev1beta1.LastError) error {
return kutil.TryUpdateStatus(ctx, retry.DefaultBackoff, c, bb, func() error {
var progress int32 = 1
if bb.Status.LastOperation != nil {
progress = bb.Status.LastOperation.Progress
}
bb.Status.LastOperation = &gardencorev1beta1.LastOperation{
Type: gardencorev1beta1helper.ComputeOperationType(bb.ObjectMeta, bb.Status.LastOperation),
State: gardencorev1beta1.LastOperationStateError,
Progress: progress,
Description: message,
LastUpdateTime: metav1.Now(),
}
bb.Status.LastError = lastError
return nil
})
}
func updateBackupBucketStatusPending(ctx context.Context, c client.Client, bb *gardencorev1beta1.BackupBucket, message string) error {
return kutil.TryUpdateStatus(ctx, retry.DefaultBackoff, c, bb, func() error {
var progress int32 = 1
if bb.Status.LastOperation != nil {
progress = bb.Status.LastOperation.Progress
}
bb.Status.LastOperation = &gardencorev1beta1.LastOperation{
Type: gardencorev1beta1helper.ComputeOperationType(bb.ObjectMeta, bb.Status.LastOperation),
State: gardencorev1beta1.LastOperationStatePending,
Progress: progress,
Description: message,
LastUpdateTime: metav1.Now(),
}
bb.Status.ObservedGeneration = bb.Generation
return nil
})
}
func updateBackupBucketStatusSucceeded(ctx context.Context, c client.Client, bb *gardencorev1beta1.BackupBucket, message string) error {
return kutil.TryUpdateStatus(ctx, retry.DefaultBackoff, c, bb, func() error {
bb.Status.LastError = nil
bb.Status.LastOperation = &gardencorev1beta1.LastOperation{
Type: gardencorev1beta1helper.ComputeOperationType(bb.ObjectMeta, bb.Status.LastOperation),
State: gardencorev1beta1.LastOperationStateSucceeded,
Progress: 100,
Description: message,
LastUpdateTime: metav1.Now(),
}
bb.Status.ObservedGeneration = bb.Generation
return nil
})
}