-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmantlebackup_controller.go
More file actions
3192 lines (2769 loc) · 95.8 KB
/
Copy pathmantlebackup_controller.go
File metadata and controls
3192 lines (2769 loc) · 95.8 KB
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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package controller
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"slices"
"strconv"
"strings"
"time"
_ "embed"
mantlev1 "github.com/cybozu-go/mantle/api/v1"
"github.com/cybozu-go/mantle/internal/ceph"
"github.com/cybozu-go/mantle/internal/controller/internal/objectstorage"
"github.com/cybozu-go/mantle/internal/controller/metrics"
"github.com/cybozu-go/mantle/pkg/controller/proto"
"github.com/prometheus/client_golang/prometheus"
"golang.org/x/time/rate"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
aerrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
"k8s.io/kube-openapi/pkg/validation/strfmt"
"k8s.io/utils/ptr"
ctrl "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/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const (
MantleBackupFinalizerName = "mantlebackup.mantle.cybozu.io/finalizer"
labelLocalBackupTargetPVCUID = "mantle.cybozu.io/local-backup-target-pvc-uid"
labelRemoteBackupTargetPVCUID = "mantle.cybozu.io/remote-backup-target-pvc-uid"
labelAppNameValue = "mantle"
labelComponentExportData = "export-data"
labelComponentExportJob = "export-job"
labelComponentUploadJob = "upload-job"
labelComponentImportJob = "import-job"
labelComponentVerifyJob = "verify-job"
labelComponentVerifyVolume = "verify-volume"
labelComponentZeroOutJob = "zeroout-job"
labelComponentZeroOutVolume = "zeroout-volume"
annotRemoteUID = "mantle.cybozu.io/remote-uid"
annotDiffFrom = "mantle.cybozu.io/diff-from"
annotDiffTo = "mantle.cybozu.io/diff-to"
annotRetainIfExpired = "mantle.cybozu.io/retain-if-expired"
annotSyncMode = "mantle.cybozu.io/sync-mode"
MantleExportJobPrefix = "mantle-export-"
MantleUploadJobPrefix = "mantle-upload-"
MantleExportDataPVCPrefix = "mantle-export-"
MantleImportJobPrefix = "mantle-import-"
mantleVerifyImagePrefix = "mantle-verify-"
MantleVerifyJobPrefix = "mantle-verify-"
mantleVerifyPVCPrefix = "mantle-verify-"
mantleVerifyPVPrefix = "mantle-verify-"
MantleZeroOutJobPrefix = "mantle-zeroout-"
MantleZeroOutPVCPrefix = "mantle-zeroout-"
MantleZeroOutPVPrefix = "mantle-zeroout-"
syncModeFull = "full"
syncModeIncremental = "incremental"
EnvExportJobScript = "EXPORT_JOB_SCRIPT"
EnvUploadJobScript = "UPLOAD_JOB_SCRIPT"
EnvImportJobScript = "IMPORT_JOB_SCRIPT"
nonRootFSGroup = int64(10000)
nonRootGroupID = int64(10000)
nonRootUserID = int64(10000)
)
var (
//go:embed script/job-export.sh
EmbedJobExportScript string
//go:embed script/job-upload.sh
EmbedJobUploadScript string
//go:embed script/job-import.sh
EmbedJobImportScript string
)
type ObjectStorageSettings struct {
CACertConfigMap *string
CACertKey *string
BucketName string
Endpoint string
}
type ProxySettings struct {
HttpProxy string
HttpsProxy string
NoProxy string
}
// MantleBackupReconciler reconciles a MantleBackup object.
type MantleBackupReconciler struct {
client.Client
Scheme *runtime.Scheme
ceph ceph.CephCmd
managedCephClusterID string
role string
primarySettings *PrimarySettings // This should be non-nil if and only if role equals 'primary'.
expireQueueCh chan event.GenericEvent
podImage string
envSecret string
objectStorageSettings *ObjectStorageSettings // This should be non-nil if and only if role equals 'primary' or 'secondary'.
objectStorageClient objectstorage.Bucket
proxySettings *ProxySettings
backupTransferPartSize resource.Quantity
}
// NewMantleBackupReconciler returns NodeReconciler.
func NewMantleBackupReconciler(
client client.Client,
scheme *runtime.Scheme,
managedCephClusterID,
role string,
primarySettings *PrimarySettings,
podImage string,
envSecret string,
objectStorageSettings *ObjectStorageSettings,
proxySettings *ProxySettings,
backupTransferPartSize resource.Quantity,
) *MantleBackupReconciler {
return &MantleBackupReconciler{
Client: client,
Scheme: scheme,
ceph: ceph.NewCephCmd(),
managedCephClusterID: managedCephClusterID,
role: role,
primarySettings: primarySettings,
expireQueueCh: make(chan event.GenericEvent),
podImage: podImage,
envSecret: envSecret,
objectStorageSettings: objectStorageSettings,
proxySettings: proxySettings,
backupTransferPartSize: backupTransferPartSize,
}
}
func (r *MantleBackupReconciler) removeRBDSnapshot(ctx context.Context, poolName, imageName, snapshotName string) error {
logger := log.FromContext(ctx)
rmErr := r.ceph.RBDSnapRm(poolName, imageName, snapshotName)
if rmErr != nil {
_, findErr := ceph.FindRBDSnapshot(r.ceph, poolName, imageName, snapshotName)
if findErr == nil || !errors.Is(findErr, ceph.ErrSnapshotNotFound) {
err := errors.Join(rmErr, findErr)
logger.Error(err, "failed to remove rbd snapshot", "poolName", poolName, "imageName", imageName, "snapshotName", snapshotName)
return fmt.Errorf("failed to remove rbd snapshot: %w", err)
}
logger.Info("rbd snapshot has already been removed", "poolName", poolName, "imageName", imageName, "snapshotName", snapshotName)
return nil
}
return nil
}
func (r *MantleBackupReconciler) createRBDSnapshot(ctx context.Context, poolName, imageName string, backup *mantlev1.MantleBackup) (*ceph.RBDSnapshot, error) {
logger := log.FromContext(ctx)
createErr := r.ceph.RBDSnapCreate(poolName, imageName, backup.Name)
snap, findErr := ceph.FindRBDSnapshot(r.ceph, poolName, imageName, backup.Name)
if findErr != nil {
logger.Error(errors.Join(createErr, findErr), "failed to find rbd snapshot")
return nil, errors.Join(createErr, findErr)
}
return snap, nil
}
func (r *MantleBackupReconciler) checkPVCInManagedCluster(ctx context.Context, pvc *corev1.PersistentVolumeClaim) error {
logger := log.FromContext(ctx)
clusterID, err := getCephClusterIDFromPVC(ctx, r.Client, pvc)
if err != nil {
logger.Error(err, "failed to get clusterID from PVC", "namespace", pvc.Namespace, "name", pvc.Name)
return err
}
if clusterID != r.managedCephClusterID {
logger.Info("clusterID not matched", "pvc", pvc.Name, "clusterID", clusterID, "managedCephClusterID", r.managedCephClusterID)
return errSkipProcessing
}
return nil
}
func (r *MantleBackupReconciler) isPVCBound(ctx context.Context, pvc *corev1.PersistentVolumeClaim) (bool, error) {
logger := log.FromContext(ctx)
if pvc.Status.Phase != corev1.ClaimBound {
if pvc.Status.Phase == corev1.ClaimPending {
return false, nil
} else {
logger.Info("PVC phase is neither bound nor pending", "status.phase", pvc.Status.Phase)
return false, fmt.Errorf("PVC phase is neither bound nor pending (status.phase: %s)", pvc.Status.Phase)
}
}
return true, nil
}
type snapshotTarget struct {
pvc *corev1.PersistentVolumeClaim
pv *corev1.PersistentVolume
imageName string
poolName string
}
var errSkipProcessing = errors.New("skip processing")
func (r *MantleBackupReconciler) getSnapshotTarget(ctx context.Context, backup *mantlev1.MantleBackup) (
*snapshotTarget,
ctrl.Result,
error,
) {
logger := log.FromContext(ctx)
pvcNamespace := backup.Namespace
pvcName := backup.Spec.PVC
var pvc corev1.PersistentVolumeClaim
err := r.Get(ctx, types.NamespacedName{Namespace: pvcNamespace, Name: pvcName}, &pvc)
if err != nil {
logger.Error(err, "failed to get PVC", "namespace", pvcNamespace, "name", pvcName)
return nil, ctrl.Result{}, fmt.Errorf("failed to get PVC: %w", err)
}
// Return an error if the PVC has been re-created after the first call.
if uid, ok := backup.GetLabels()[labelLocalBackupTargetPVCUID]; ok && uid != string(pvc.GetUID()) {
return nil, ctrl.Result{}, errors.New("PVC UID does not match the backup target")
}
if err := r.checkPVCInManagedCluster(ctx, &pvc); err != nil {
return nil, ctrl.Result{}, err
}
ok, err := r.isPVCBound(ctx, &pvc)
if err != nil {
return nil, ctrl.Result{}, err
}
if !ok {
logger.Info("waiting for PVC bound.")
return nil, requeueReconciliation(), nil
}
pvName := pvc.Spec.VolumeName
var pv corev1.PersistentVolume
err = r.Get(ctx, types.NamespacedName{Name: pvName}, &pv)
if err != nil {
logger.Error(err, "failed to get PV", "name", pvName)
return nil, ctrl.Result{}, err
}
imageName, ok := pv.Spec.CSI.VolumeAttributes["imageName"]
if !ok {
return nil, ctrl.Result{}, errors.New("failed to get imageName from PV")
}
poolName, ok := pv.Spec.CSI.VolumeAttributes["pool"]
if !ok {
return nil, ctrl.Result{}, errors.New("failed to get pool from PV")
}
return &snapshotTarget{&pvc, &pv, imageName, poolName}, ctrl.Result{}, nil
}
// expire deletes the backup if it is already expired. Otherwise it schedules deletion.
// Note that this function does not use requeue to scheduled deletion because the caller
// will do other tasks after this function returns.
func (r *MantleBackupReconciler) expire(ctx context.Context, backup *mantlev1.MantleBackup) error {
logger := log.FromContext(ctx)
if backup.Status.CreatedAt.IsZero() {
// the RBD snapshot has not be taken yet, do nothing.
return nil
}
if v, ok := backup.Annotations[annotRetainIfExpired]; ok && v == "true" {
// retain this backup.
// If the annotation is deleted, reconciliation will run, so no need to schedule.
return nil
}
expire, err := strfmt.ParseDuration(backup.Spec.Expire)
if err != nil {
return err
}
expireAt := backup.Status.CreatedAt.Add(expire)
if time.Now().UTC().After(expireAt) {
// already expired, delete it immediately.
logger.Info("delete expired backup", "createdAt", backup.Status.CreatedAt, "expire", expire)
return r.Delete(ctx, backup)
}
// not expired yet. schedule deletion.
// The event may be sent many times, but it is safe because workqueue AddAfter
// deduplicates events for same object.
r.expireQueueCh <- event.GenericEvent{
Object: backup,
}
return nil
}
//+kubebuilder:rbac:groups=mantle.cybozu.io,resources=mantlebackups,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=mantle.cybozu.io,resources=mantlebackups/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=mantle.cybozu.io,resources=mantlebackups/finalizers,verbs=update
//+kubebuilder:rbac:groups=core,resources=configmaps,verbs=get;list;watch
//+kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch
//+kubebuilder:rbac:groups="",resources=persistentvolumeclaims,verbs=get;list;watch
//+kubebuilder:rbac:groups="",resources=persistentvolumes,verbs=get;list;watch
//+kubebuilder:rbac:groups=storage.k8s.io,resources=storageclasses,verbs=get;list;watch
//+kubebuilder:rbac:groups="batch",resources=jobs,verbs=get;list;watch;create;update;patch;delete
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
// TODO(user): Modify the Reconcile function to compare the state specified by
// the MantleBackup object against the actual cluster state, and then
// perform operations to make the cluster state reflect the state specified by
// the user.
//
// For more details, check Reconcile and its Result here:
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.16.3/pkg/reconcile
func (r *MantleBackupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx)
var backup mantlev1.MantleBackup
err := r.Get(ctx, req.NamespacedName, &backup)
if aerrors.IsNotFound(err) {
logger.Info("MantleBackup is not found", "error", err)
return ctrl.Result{}, nil
}
if err != nil {
logger.Error(err, "failed to get MantleBackup")
return ctrl.Result{}, err
}
switch r.role {
case RoleStandalone:
return r.reconcileAsStandalone(ctx, &backup)
case RolePrimary:
return r.reconcileAsPrimary(ctx, &backup)
case RoleSecondary:
return r.reconcileAsSecondary(ctx, &backup)
}
panic("unreachable")
}
func (r *MantleBackupReconciler) reconcileLocalBackup(ctx context.Context, backup *mantlev1.MantleBackup) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if isCreatedWhenMantleControllerWasSecondary(backup) {
logger.Info(
"skipping to reconcile the MantleBackup created by a remote mantle-controller to prevent accidental data loss",
)
return ctrl.Result{}, nil
}
target, result, err := r.getSnapshotTarget(ctx, backup)
notFound := aerrors.IsNotFound(err)
switch {
case errors.Is(err, errSkipProcessing):
return ctrl.Result{}, nil
case err != nil && !notFound:
return ctrl.Result{}, err
}
if !result.IsZero() {
return result, nil
}
if !backup.DeletionTimestamp.IsZero() {
return r.finalizeStandalone(ctx, backup, target, notFound)
}
// Only the NotFound error reaches this point, so return it as is.
if notFound {
return ctrl.Result{}, err
}
if backup.Labels == nil {
backup.Labels = make(map[string]string)
}
if _, ok := backup.Labels[labelLocalBackupTargetPVCUID]; !ok {
backup.Labels[labelLocalBackupTargetPVCUID] = string(target.pvc.GetUID())
if err := r.Update(ctx, backup); err != nil {
logger.Error(err, "failed to add label", "label", labelLocalBackupTargetPVCUID)
return ctrl.Result{}, err
}
}
if !controllerutil.ContainsFinalizer(backup, MantleBackupFinalizerName) {
controllerutil.AddFinalizer(backup, MantleBackupFinalizerName)
if err := r.Update(ctx, backup); err != nil {
logger.Error(err, "failed to add finalizer", "finalizer", MantleBackupFinalizerName)
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
if err := r.expire(ctx, backup); err != nil {
return ctrl.Result{}, err
}
if !backup.IsSnapshotCaptured() {
if err := r.provisionRBDSnapshot(ctx, backup, target); err != nil {
return ctrl.Result{}, err
}
}
return ctrl.Result{}, nil
}
func (r *MantleBackupReconciler) reconcileAsStandalone(ctx context.Context, backup *mantlev1.MantleBackup) (ctrl.Result, error) {
result, err := r.reconcileLocalBackup(ctx, backup)
if err != nil || !result.IsZero() {
return result, err
}
if !backup.IsVerifiedTrue() && !backup.IsVerifiedFalse() {
if err := r.verify(ctx, backup); err != nil {
return ctrl.Result{}, err
}
return requeueReconciliation(), nil
}
return r.primaryCleanup(ctx, backup)
}
func (r *MantleBackupReconciler) reconcileAsPrimary(ctx context.Context, backup *mantlev1.MantleBackup) (ctrl.Result, error) {
result, err := r.reconcileLocalBackup(ctx, backup)
if err != nil || !result.IsZero() {
return result, err
}
if !backup.IsVerifiedTrue() && !backup.IsVerifiedFalse() {
if err := r.verify(ctx, backup); err != nil {
return ctrl.Result{}, err
}
}
if !backup.IsSynced() {
result, err := r.replicate(ctx, backup)
if err != nil || !result.IsZero() {
return result, err
}
}
if (!backup.IsVerifiedTrue() && !backup.IsVerifiedFalse()) || !backup.IsSynced() {
return requeueReconciliation(), nil
}
return r.primaryCleanup(ctx, backup)
}
func (r *MantleBackupReconciler) reconcileAsSecondary(ctx context.Context, backup *mantlev1.MantleBackup) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if err := r.prepareObjectStorageClient(ctx); err != nil {
return ctrl.Result{}, err
}
if !isCreatedWhenMantleControllerWasSecondary(backup) {
logger.Info(
"skipping to reconcile the MantleBackup created by a different mantle-controller to prevent accidental data loss",
)
return ctrl.Result{}, nil
}
target, result, err := r.getSnapshotTarget(ctx, backup)
notFound := aerrors.IsNotFound(err)
switch {
case errors.Is(err, errSkipProcessing):
return ctrl.Result{}, nil
case err != nil && !notFound:
return ctrl.Result{}, err
}
if !result.IsZero() {
return result, nil
}
if !backup.DeletionTimestamp.IsZero() {
return r.finalizeSecondary(ctx, backup, target, notFound)
}
// Only the NotFound error reaches this point, so return it as is.
if notFound {
return ctrl.Result{}, err
}
if err := r.expire(ctx, backup); err != nil {
return ctrl.Result{}, err
}
if !backup.IsSnapshotCaptured() {
result, err := r.startImport(ctx, backup, target)
if err != nil || !result.IsZero() {
return result, err
}
}
if backup.IsSnapshotCaptured() && !backup.IsVerifiedTrue() && !backup.IsVerifiedFalse() {
if err := r.verify(ctx, backup); err != nil {
return ctrl.Result{}, err
}
return requeueReconciliation(), nil
}
return r.secondaryCleanup(ctx, backup, true)
}
func scheduleExpire(_ context.Context, evt event.TypedGenericEvent[client.Object], q workqueue.TypedRateLimitingInterface[ctrl.Request]) {
backup := evt.Object.(*mantlev1.MantleBackup)
// the parse never fails because expire method checked it.
expire, _ := strfmt.ParseDuration(backup.Spec.Expire)
q.AddAfter(
ctrl.Request{
NamespacedName: types.NamespacedName{
Namespace: backup.GetNamespace(),
Name: backup.GetName(),
},
},
time.Until(backup.Status.CreatedAt.Add(expire)),
)
}
func newMantleBackupReconcilerRateLimiter[T comparable]() workqueue.TypedRateLimiter[T] {
// Use 3 minutes as the max delay for the exponential backoff to speed backups up.
// The rest is the same as the default rate limiter.
// cf. https://github.com/kubernetes/client-go/blob/18a1faa115ed571de5af3e8f0f9c02973769ceb3/util/workqueue/default_rate_limiters.go#L50-L56
return workqueue.NewTypedMaxOfRateLimiter(
workqueue.NewTypedItemExponentialFailureRateLimiter[T](5*time.Millisecond, 3*time.Minute),
&workqueue.TypedBucketRateLimiter[T]{Limiter: rate.NewLimiter(rate.Limit(10), 100)},
)
}
// SetupWithManager sets up the controller with the Manager.
func (r *MantleBackupReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
WithOptions(controller.TypedOptions[reconcile.Request]{
RateLimiter: newMantleBackupReconcilerRateLimiter[reconcile.Request](),
}).
For(&mantlev1.MantleBackup{}).
WatchesRawSource(
source.TypedChannel(r.expireQueueCh, handler.Funcs{GenericFunc: scheduleExpire}),
).
Complete(r)
}
func (r *MantleBackupReconciler) replicate(
ctx context.Context,
backup *mantlev1.MantleBackup,
) (ctrl.Result, error) {
logger := log.FromContext(ctx)
result, err := r.replicateManifests(ctx, backup)
if err != nil || result != (ctrl.Result{}) {
return result, err
}
prepareResult, err := r.prepareForDataSynchronization(ctx, backup, r.primarySettings.Client)
if err != nil {
return ctrl.Result{}, err
}
if prepareResult.isSecondaryMantleBackupSnapshotCaptured {
if err := r.updateMantleBackupCondition(
ctx, backup,
mantlev1.BackupConditionSyncedToRemote,
metav1.ConditionTrue,
mantlev1.ConditionReasonSyncedToRemoteNoProblem,
); err != nil {
return ctrl.Result{}, fmt.Errorf("failed to set SyncedToRemote condition to True: %w", err)
}
logger.Info("succeeded to sync a backup to the remote ceph cluster")
duration := time.Since(backup.GetCreationTimestamp().Time).Seconds()
metrics.BackupDurationSeconds.With(prometheus.Labels{
"persistentvolumeclaim": backup.Spec.PVC,
"resource_namespace": backup.GetNamespace(),
}).Observe(duration)
return requeueReconciliation(), nil
}
return r.startExportAndUpload(ctx, backup, prepareResult)
}
func (r *MantleBackupReconciler) replicateManifests(
ctx context.Context,
backup *mantlev1.MantleBackup,
) (ctrl.Result, error) {
// Unmarshal the PVC manifest stored in the status of the MantleBackup resource.
var pvc corev1.PersistentVolumeClaim
if err := json.Unmarshal([]byte(backup.Status.PVCManifest), &pvc); err != nil {
return ctrl.Result{}, fmt.Errorf("failed to unmarshal the PVC stored in the status of the MantleBackup resource: %w", err)
}
// Make sure the arguments are valid
if backup.Status.SnapID == nil {
return ctrl.Result{}, fmt.Errorf("backup.Status.SnapID should not be nil: %s: %s", backup.GetName(), backup.GetNamespace())
}
// Make sure all of the preceding backups for the same PVC have already been replicated.
var backupList mantlev1.MantleBackupList
if err := r.List(ctx, &backupList, &client.ListOptions{
LabelSelector: labels.SelectorFromSet(map[string]string{labelLocalBackupTargetPVCUID: string(pvc.GetUID())}),
}); err != nil {
return ctrl.Result{}, err
}
for _, backup1 := range backupList.Items {
if backup1.Status.SnapID == nil ||
*backup1.Status.SnapID < *backup.Status.SnapID &&
backup1.DeletionTimestamp.IsZero() &&
!backup1.IsSynced() {
return requeueReconciliation(), nil
}
}
// Create a PVC that should be sent to the secondary mantle.
var pvcSent corev1.PersistentVolumeClaim
pvcSent.SetName(pvc.GetName())
pvcSent.SetNamespace(pvc.GetNamespace())
pvcSent.SetAnnotations(map[string]string{
annotRemoteUID: string(pvc.GetUID()),
})
pvcSent.Spec = *pvc.Spec.DeepCopy()
capacity, err := resource.ParseQuantity(strconv.FormatInt(*backup.Status.SnapSize, 10))
if err != nil {
return ctrl.Result{}, fmt.Errorf("failed to parse quantity: %w", err)
}
pvcSent.Spec.Resources = corev1.VolumeResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceStorage: capacity,
},
}
pvcSentJson, err := json.Marshal(pvcSent)
if err != nil {
return ctrl.Result{}, err
}
// Call CreateOrUpdatePVC
client := r.primarySettings.Client
resp, err := client.CreateOrUpdatePVC(
ctx,
&proto.CreateOrUpdatePVCRequest{
Pvc: pvcSentJson,
},
)
if err != nil {
return ctrl.Result{}, err
}
// Create a MantleBackup that should be sent to the secondary mantle.
var backupSent mantlev1.MantleBackup
backupSent.SetName(backup.GetName())
backupSent.SetNamespace(backup.GetNamespace())
backupSent.SetAnnotations(map[string]string{
annotRemoteUID: string(backup.GetUID()),
})
backupSent.SetLabels(map[string]string{
labelLocalBackupTargetPVCUID: resp.GetUid(),
labelRemoteBackupTargetPVCUID: string(pvc.GetUID()),
})
backupSent.SetFinalizers([]string{MantleBackupFinalizerName})
backupSent.Spec = backup.Spec
backupSent.Status.CreatedAt = backup.Status.CreatedAt
backupSent.Status.SnapSize = backup.Status.SnapSize
backupSent.Status.TransferPartSize = backup.Status.TransferPartSize
backupSentJson, err := json.Marshal(backupSent)
if err != nil {
return ctrl.Result{}, err
}
// Call CreateMantleBackup.
if _, err := client.CreateMantleBackup(
ctx,
&proto.CreateMantleBackupRequest{
MantleBackup: backupSentJson,
},
); err != nil {
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
func (r *MantleBackupReconciler) verify(
ctx context.Context,
backup *mantlev1.MantleBackup,
) error {
logger := log.FromContext(ctx)
logger.Info("starting verification reconciliation", "backupUID", string(backup.GetUID()))
var storedPVC corev1.PersistentVolumeClaim
if err := json.Unmarshal([]byte(backup.Status.PVCManifest), &storedPVC); err != nil {
return fmt.Errorf("failed to unmarshal PVC manifest: %w", err)
}
var storedPV corev1.PersistentVolume
if err := json.Unmarshal([]byte(backup.Status.PVManifest), &storedPV); err != nil {
return fmt.Errorf("failed to unmarshal PV manifest: %w", err)
}
// create a clone by the snapshot bound to the MB
if err := createCloneByPV(ctx, r.ceph, &storedPV, backup.Name, MakeVerifyImageName(backup)); err != nil {
return fmt.Errorf("failed to create a clone by the snapshot: %w", err)
}
// create a static PV with the clone
if err := r.createOrUpdateStaticPV(
ctx,
&storedPV,
MakeVerifyImageName(backup),
corev1.ResourceList{
corev1.ResourceStorage: *resource.NewQuantity(*backup.Status.SnapSize, resource.BinarySI),
},
MakeVerifyPVName(backup),
labelComponentVerifyVolume,
true,
); err != nil {
return fmt.Errorf("failed to create a static PV with the clone: %w", err)
}
// create a PVC with the PV
if err := r.createOrUpdateStaticPVC(
ctx,
MakeVerifyPVCName(backup),
MakeVerifyPVName(backup),
labelComponentVerifyVolume,
storedPVC.Spec.Resources,
); err != nil {
return fmt.Errorf("failed to create a PVC with the PV: %w", err)
}
// create a Job to execute e2fsck on the PVC
if err := r.createOrUpdateVerifyJob(
ctx,
MakeVerifyJobName(backup),
MakeVerifyPVCName(backup),
); err != nil {
return fmt.Errorf("failed to create a Job to execute e2fsck on the PVC: %w", err)
}
// wait for the Job to complete
jobFinished, jobSucceeded, err := r.checkJobStatus(ctx, MakeVerifyJobName(backup))
if err != nil {
return fmt.Errorf("failed to check the Job status: %w", err)
}
if !jobFinished {
// still running
return nil
}
// update MB's conditions field
condition := metav1.ConditionTrue
reason := mantlev1.ConditionReasonVerifiedSuccess
if !jobSucceeded {
condition = metav1.ConditionFalse
reason = mantlev1.ConditionReasonVerifiedFailed
}
if err := r.updateMantleBackupCondition(
ctx, backup,
mantlev1.BackupConditionVerified,
condition,
reason,
); err != nil {
return fmt.Errorf("failed to update MantleBackup condition: %w", err)
}
return nil
}
// checkJobStatus checks the status of the Job with the given name.
// It returns (is job finished, is job succeeded, error).
func (r *MantleBackupReconciler) checkJobStatus(ctx context.Context, jobName string) (bool, bool, error) {
var job batchv1.Job
if err := r.Get(
ctx,
types.NamespacedName{
Namespace: r.managedCephClusterID,
Name: jobName,
},
&job,
); err != nil {
if aerrors.IsNotFound(err) {
// The cache must be stale.
return false, false, nil
}
return false, false, fmt.Errorf("failed to get Job for checking job status: %w", err)
}
for _, c := range job.Status.Conditions {
if c.Type == batchv1.JobComplete && c.Status == corev1.ConditionTrue {
return true, true, nil
}
if c.Type == batchv1.JobFailed && c.Status == corev1.ConditionTrue {
return true, false, nil
}
}
// job is still running
return false, false, nil
}
func (r *MantleBackupReconciler) provisionRBDSnapshot(
ctx context.Context,
backup *mantlev1.MantleBackup,
target *snapshotTarget,
) error {
logger := log.FromContext(ctx)
// Attach local-backup-target-pvc-uid label before trying to create a RBD
// snapshot corresponding to the given MantleBackup, so that we can make
// sure that every MantleBackup that has a RBD snapshot is labelled with
// local-backup-target-pvc-uid.
key := client.ObjectKeyFromObject(backup)
if err := r.Get(ctx, key, backup); err != nil {
return err
}
if backup.Labels == nil {
backup.Labels = map[string]string{}
}
backup.Labels[labelLocalBackupTargetPVCUID] = string(target.pvc.GetUID())
if err := r.Update(ctx, backup); err != nil {
return err
}
snapshot, err := r.createRBDSnapshot(ctx, target.poolName, target.imageName, backup)
if err != nil {
return err
}
if err := updateStatus(ctx, r.Client, backup, func() error {
pvcJs, err := json.Marshal(target.pvc)
if err != nil {
logger.Error(err, "failed to marshal PVC")
return err
}
backup.Status.PVCManifest = string(pvcJs)
pvJs, err := json.Marshal(target.pv)
if err != nil {
logger.Error(err, "failed to marshal PV")
return err
}
backup.Status.PVManifest = string(pvJs)
backup.Status.SnapID = &snapshot.Id
backup.Status.CreatedAt = metav1.NewTime(snapshot.Timestamp.Time)
backup.Status.SnapSize = &snapshot.Size
if backup.Status.TransferPartSize == nil {
// .status.transferPartSize isn't necessary in the standalone mode,
// but its value must be set before CreateMantleBackup RPC, so we
// set it here.
backup.Status.TransferPartSize = &r.backupTransferPartSize
}
meta.SetStatusCondition(&backup.Status.Conditions, metav1.Condition{
Type: mantlev1.BackupConditionSnapshotCaptured, Status: metav1.ConditionTrue, Reason: mantlev1.ConditionReasonSnapshotCapturedNoProblem})
return nil
}); err != nil {
logger.Error(err, "failed to update MantleBackup status", "status", backup.Status)
return err
}
logger.Info("succeeded to create a backup")
return nil
}
// isCreatedWhenMantleControllerWasSecondary returns true iff the MantleBackup
// is created by the secondary mantle.
func isCreatedWhenMantleControllerWasSecondary(backup *mantlev1.MantleBackup) bool {
_, ok := backup.Annotations[annotRemoteUID]
return ok
}
func (r *MantleBackupReconciler) finalizeStandalone(
ctx context.Context,
backup *mantlev1.MantleBackup,
target *snapshotTarget,
targetPVCNotFound bool,
) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if _, ok := backup.GetAnnotations()[annotDiffTo]; ok {
return ctrl.Result{}, nil
}
if !controllerutil.ContainsFinalizer(backup, MantleBackupFinalizerName) {
return ctrl.Result{}, nil
}
// primaryClean() is called in finalizeStandalone() to delete resources for
// exported and uploaded snapshots in both standalone and primary Mantle.
result, err := r.primaryCleanup(ctx, backup)
if err != nil || result != (ctrl.Result{}) {
return result, err
}
if !targetPVCNotFound {
err := r.removeRBDSnapshot(ctx, target.poolName, target.imageName, backup.Name)
if err != nil {
return ctrl.Result{}, err
}
}
controllerutil.RemoveFinalizer(backup, MantleBackupFinalizerName)
if err := r.Update(ctx, backup); err != nil {
logger.Error(err, "failed to remove finalizer", "finalizer", MantleBackupFinalizerName)
return ctrl.Result{}, err
}
logger.Info("succeeded to delete a backup")
return ctrl.Result{}, nil
}
func (r *MantleBackupReconciler) finalizeSecondary(
ctx context.Context,
backup *mantlev1.MantleBackup,
target *snapshotTarget,
targetPVCNotFound bool,
) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if _, ok := backup.GetAnnotations()[annotDiffTo]; ok {
return ctrl.Result{}, nil
}
if !controllerutil.ContainsFinalizer(backup, MantleBackupFinalizerName) {
return ctrl.Result{}, nil
}
result, err := r.secondaryCleanup(ctx, backup, false)
if err != nil || result != (ctrl.Result{}) {
return result, err
}
if !targetPVCNotFound {
err := r.removeRBDSnapshot(ctx, target.poolName, target.imageName, backup.Name)
if err != nil {
return ctrl.Result{}, err
}
}
controllerutil.RemoveFinalizer(backup, MantleBackupFinalizerName)
if err := r.Update(ctx, backup); err != nil {
logger.Error(err, "failed to remove finalizer", "finalizer", MantleBackupFinalizerName)
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
type dataSyncPrepareResult struct {
isIncremental bool // NOTE: The value is forcibly set to false if isSecondaryMantleBackupSnapshotCaptured is true.
isSecondaryMantleBackupSnapshotCaptured bool
diffFrom *mantlev1.MantleBackup // non-nil value iff isIncremental is true.
}
func (r *MantleBackupReconciler) prepareForDataSynchronization(
ctx context.Context,
backup *mantlev1.MantleBackup,
msc proto.MantleServiceClient,
) (*dataSyncPrepareResult, error) {
exportTargetPVCUID, ok := backup.GetLabels()[labelLocalBackupTargetPVCUID]