-
Notifications
You must be signed in to change notification settings - Fork 258
/
dataimportcron-controller.go
1369 lines (1232 loc) · 47.1 KB
/
dataimportcron-controller.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
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
/*
Copyright 2021 The CDI Authors.
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.
limitations under the License.
See the License for the specific language governing permissions and
*/
package controller
import (
"context"
"fmt"
"net/url"
"reflect"
"sort"
"strings"
"time"
"github.com/containers/image/v5/docker/reference"
"github.com/go-logr/logr"
"github.com/gorhill/cronexpr"
imagev1 "github.com/openshift/api/image/v1"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
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/apimachinery/pkg/util/validation"
"k8s.io/client-go/tools/record"
"k8s.io/utils/pointer"
"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/manager"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1"
"kubevirt.io/containerized-data-importer/pkg/common"
cc "kubevirt.io/containerized-data-importer/pkg/controller/common"
cdv "kubevirt.io/containerized-data-importer/pkg/controller/datavolume"
"kubevirt.io/containerized-data-importer/pkg/monitoring"
"kubevirt.io/containerized-data-importer/pkg/operator"
"kubevirt.io/containerized-data-importer/pkg/util"
"kubevirt.io/containerized-data-importer/pkg/util/naming"
)
const (
// ErrDataSourceAlreadyManaged provides a const to indicate DataSource already managed error
ErrDataSourceAlreadyManaged = "ErrDataSourceAlreadyManaged"
// MessageDataSourceAlreadyManaged provides a const to form DataSource already managed error message
MessageDataSourceAlreadyManaged = "DataSource %s is already managed by DataImportCron %s"
prometheusNsLabel = "ns"
prometheusCronNameLabel = "cron_name"
)
var (
// DataImportCronOutdatedGauge is the metric we use to alert about DataImportCrons failing
DataImportCronOutdatedGauge = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: monitoring.MetricOptsList[monitoring.DataImportCronOutdated].Name,
Help: monitoring.MetricOptsList[monitoring.DataImportCronOutdated].Help,
},
[]string{prometheusNsLabel, prometheusCronNameLabel},
)
)
// DataImportCronReconciler members
type DataImportCronReconciler struct {
client client.Client
uncachedClient client.Client
recorder record.EventRecorder
scheme *runtime.Scheme
log logr.Logger
image string
pullPolicy string
cdiNamespace string
installerLabels map[string]string
}
const (
// AnnSourceDesiredDigest is the digest of the pending updated image
AnnSourceDesiredDigest = cc.AnnAPIGroup + "/storage.import.sourceDesiredDigest"
// AnnImageStreamDockerRef is the ImageStream Docker reference
AnnImageStreamDockerRef = cc.AnnAPIGroup + "/storage.import.imageStreamDockerRef"
// AnnNextCronTime is the next time stamp which satisfies the cron expression
AnnNextCronTime = cc.AnnAPIGroup + "/storage.import.nextCronTime"
// AnnLastCronTime is the cron last execution time stamp
AnnLastCronTime = cc.AnnAPIGroup + "/storage.import.lastCronTime"
// AnnLastUseTime is the PVC last use time stamp
AnnLastUseTime = cc.AnnAPIGroup + "/storage.import.lastUseTime"
// AnnStorageClass is the cron DV's storage class
AnnStorageClass = cc.AnnAPIGroup + "/storage.import.storageClass"
dataImportControllerName = "dataimportcron-controller"
digestPrefix = "sha256:"
digestDvNameSuffixLength = 12
cronJobUIDSuffixLength = 8
defaultImportsToKeepPerCron = 3
)
// Reconcile loop for DataImportCronReconciler
func (r *DataImportCronReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
dataImportCron := &cdiv1.DataImportCron{}
if err := r.client.Get(ctx, req.NamespacedName, dataImportCron); cc.IgnoreNotFound(err) != nil {
return reconcile.Result{}, err
} else if err != nil || dataImportCron.DeletionTimestamp != nil {
err := r.cleanup(ctx, req.NamespacedName)
return reconcile.Result{}, err
}
shouldReconcile, err := r.shouldReconcileCron(ctx, dataImportCron)
if !shouldReconcile || err != nil {
return reconcile.Result{}, err
}
if err := r.initCron(ctx, dataImportCron); err != nil {
return reconcile.Result{}, err
}
return r.update(ctx, dataImportCron)
}
func (r *DataImportCronReconciler) shouldReconcileCron(ctx context.Context, cron *cdiv1.DataImportCron) (bool, error) {
dataSource := &cdiv1.DataSource{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: cron.Namespace, Name: cron.Spec.ManagedDataSource}, dataSource); err != nil {
if k8serrors.IsNotFound(err) {
return true, nil
}
return false, err
}
dataSourceCronLabel := dataSource.Labels[common.DataImportCronLabel]
if dataSourceCronLabel == cron.Name || dataSourceCronLabel == "" {
return true, nil
}
otherCron := &cdiv1.DataImportCron{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: cron.Namespace, Name: dataSourceCronLabel}, otherCron); err != nil {
if k8serrors.IsNotFound(err) {
return true, nil
}
return false, err
}
if otherCron.Spec.ManagedDataSource == dataSource.Name {
msg := fmt.Sprintf(MessageDataSourceAlreadyManaged, dataSource.Name, otherCron.Name)
r.recorder.Event(cron, corev1.EventTypeWarning, ErrDataSourceAlreadyManaged, msg)
r.log.V(3).Info(msg)
return false, nil
}
return true, nil
}
func (r *DataImportCronReconciler) initCron(ctx context.Context, dataImportCron *cdiv1.DataImportCron) error {
if dataImportCron.Spec.Schedule == "" {
return nil
}
if isImageStreamSource(dataImportCron) {
if dataImportCron.Annotations[AnnNextCronTime] == "" {
cc.AddAnnotation(dataImportCron, AnnNextCronTime, time.Now().Format(time.RFC3339))
}
return nil
}
if !isURLSource(dataImportCron) {
return nil
}
exists, err := r.cronJobExistsAndUpdated(ctx, dataImportCron)
if exists || err != nil {
return err
}
cronJob, err := r.newCronJob(dataImportCron)
if err != nil {
return err
}
if err := r.client.Create(ctx, cronJob); err != nil {
return err
}
job, err := r.newInitialJob(dataImportCron, cronJob)
if err != nil {
return err
}
if err := r.client.Create(ctx, job); err != nil {
return err
}
return nil
}
func (r *DataImportCronReconciler) getImageStream(ctx context.Context, imageStreamName, imageStreamNamespace string) (*imagev1.ImageStream, string, error) {
if imageStreamName == "" || imageStreamNamespace == "" {
return nil, "", errors.Errorf("Missing ImageStream name or namespace")
}
imageStream := &imagev1.ImageStream{}
name, tag, err := splitImageStreamName(imageStreamName)
if err != nil {
return nil, "", err
}
imageStreamNamespacedName := types.NamespacedName{
Namespace: imageStreamNamespace,
Name: name,
}
if err := r.client.Get(ctx, imageStreamNamespacedName, imageStream); err != nil {
return nil, "", err
}
return imageStream, tag, nil
}
func getImageStreamDigest(imageStream *imagev1.ImageStream, imageStreamTag string) (string, string, error) {
if imageStream == nil {
return "", "", errors.Errorf("No ImageStream")
}
tags := imageStream.Status.Tags
if len(tags) == 0 {
return "", "", errors.Errorf("ImageStream %s has no tags", imageStream.Name)
}
tagIdx := 0
if len(imageStreamTag) > 0 {
tagIdx = -1
for i, tag := range tags {
if tag.Tag == imageStreamTag {
tagIdx = i
break
}
}
}
if tagIdx == -1 {
return "", "", errors.Errorf("ImageStream %s has no tag %s", imageStream.Name, imageStreamTag)
}
if len(tags[tagIdx].Items) == 0 {
return "", "", errors.Errorf("ImageStream %s tag %s has no items", imageStream.Name, imageStreamTag)
}
return tags[tagIdx].Items[0].Image, tags[tagIdx].Items[0].DockerImageReference, nil
}
func splitImageStreamName(imageStreamName string) (string, string, error) {
if subs := strings.Split(imageStreamName, ":"); len(subs) == 1 {
return imageStreamName, "", nil
} else if len(subs) == 2 && len(subs[0]) > 0 && len(subs[1]) > 0 {
return subs[0], subs[1], nil
}
return "", "", errors.Errorf("Illegal ImageStream name %s", imageStreamName)
}
func (r *DataImportCronReconciler) pollImageStreamDigest(ctx context.Context, dataImportCron *cdiv1.DataImportCron) (reconcile.Result, error) {
if nextTimeStr := dataImportCron.Annotations[AnnNextCronTime]; nextTimeStr != "" {
nextTime, err := time.Parse(time.RFC3339, nextTimeStr)
if err != nil {
return reconcile.Result{}, err
}
if nextTime.Before(time.Now()) {
if err := r.updateImageStreamDesiredDigest(ctx, dataImportCron); err != nil {
return reconcile.Result{}, err
}
}
}
return r.setNextCronTime(dataImportCron)
}
func (r *DataImportCronReconciler) setNextCronTime(dataImportCron *cdiv1.DataImportCron) (reconcile.Result, error) {
now := time.Now()
expr, err := cronexpr.Parse(dataImportCron.Spec.Schedule)
if err != nil {
return reconcile.Result{}, err
}
nextTime := expr.Next(now)
diffSec := time.Duration(nextTime.Sub(now).Seconds()) + 1
res := reconcile.Result{Requeue: true, RequeueAfter: diffSec * time.Second}
cc.AddAnnotation(dataImportCron, AnnNextCronTime, nextTime.Format(time.RFC3339))
return res, err
}
func isImageStreamSource(dataImportCron *cdiv1.DataImportCron) bool {
regSource, err := getCronRegistrySource(dataImportCron)
return err == nil && regSource.ImageStream != nil
}
func isURLSource(dataImportCron *cdiv1.DataImportCron) bool {
regSource, err := getCronRegistrySource(dataImportCron)
return err == nil && regSource.URL != nil
}
func getCronRegistrySource(cron *cdiv1.DataImportCron) (*cdiv1.DataVolumeSourceRegistry, error) {
source := cron.Spec.Template.Spec.Source
if source == nil || source.Registry == nil {
return nil, errors.Errorf("Cron with no registry source %s", cron.Name)
}
return source.Registry, nil
}
func (r *DataImportCronReconciler) update(ctx context.Context, dataImportCron *cdiv1.DataImportCron) (reconcile.Result, error) {
res := reconcile.Result{}
dv, pvc, err := r.getImportState(ctx, dataImportCron)
if err != nil {
return res, err
}
dataImportCronCopy := dataImportCron.DeepCopy()
imports := dataImportCron.Status.CurrentImports
importSucceeded := false
dataVolume := dataImportCron.Spec.Template
explicitScName := cc.GetStorageClassFromDVSpec(&dataVolume)
desiredStorageClass, err := cc.GetStorageClassByNameWithVirtFallback(ctx, r.client, explicitScName, dataVolume.Spec.ContentType)
if err != nil {
return res, err
}
if desiredStorageClass != nil {
cc.AddAnnotation(dataImportCron, AnnStorageClass, desiredStorageClass.Name)
}
format, err := r.getSourceFormat(ctx, desiredStorageClass)
if err != nil {
return res, err
}
snapshot, err := r.getSnapshot(ctx, dataImportCron, format)
if err != nil {
return res, err
}
handlePopulatedPvc := func() error {
if pvc != nil {
if err := r.updateSource(ctx, dataImportCron, pvc); err != nil {
return err
}
}
importSucceeded = true
if err := r.handleCronFormat(ctx, dataImportCron, pvc, format, desiredStorageClass); err != nil {
return err
}
return nil
}
if dv != nil {
switch dv.Status.Phase {
case cdiv1.Succeeded:
if err := handlePopulatedPvc(); err != nil {
return res, err
}
case cdiv1.ImportScheduled:
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronProgressing, corev1.ConditionFalse, "Import is scheduled", scheduled)
case cdiv1.ImportInProgress:
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronProgressing, corev1.ConditionTrue, "Import is progressing", inProgress)
default:
dvPhase := string(dv.Status.Phase)
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronProgressing, corev1.ConditionFalse, fmt.Sprintf("Import DataVolume phase %s", dvPhase), dvPhase)
}
} else if pvc != nil {
// TODO: with plain populator PVCs (no DataVolumes) we may need to wait for corev1.Bound
if err := handlePopulatedPvc(); err != nil {
return res, err
}
} else if snapshot != nil {
if err := r.updateSource(ctx, dataImportCron, snapshot); err != nil {
return res, err
}
importSucceeded = true
} else {
if len(imports) > 0 {
dataImportCron.Status.CurrentImports = imports[1:]
}
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronProgressing, corev1.ConditionFalse, "No current import", noImport)
}
if importSucceeded {
if err := updateDataImportCronOnSuccess(dataImportCron); err != nil {
return res, err
}
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronProgressing, corev1.ConditionFalse, "No current import", noImport)
if err := r.garbageCollectOldImports(ctx, dataImportCron); err != nil {
return res, err
}
}
if err := r.updateDataSource(ctx, dataImportCron, format); err != nil {
return res, err
}
// Skip if schedule is disabled
if isImageStreamSource(dataImportCron) && dataImportCron.Spec.Schedule != "" {
// We use the poll returned reconcile.Result for RequeueAfter if needed
pollRes, err := r.pollImageStreamDigest(ctx, dataImportCron)
if err != nil {
return pollRes, err
}
res = pollRes
}
desiredDigest := dataImportCron.Annotations[AnnSourceDesiredDigest]
digestUpdated := desiredDigest != "" && (len(imports) == 0 || desiredDigest != imports[0].Digest)
if digestUpdated {
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionFalse, "Source digest updated since last import", outdated)
if dv != nil {
if err := r.deleteErroneousDataVolume(ctx, dataImportCron, dv); err != nil {
return res, err
}
}
if importSucceeded || len(imports) == 0 {
if err := r.createImportDataVolume(ctx, dataImportCron); err != nil {
return res, err
}
}
} else if importSucceeded {
if err := r.updateDataImportCronSuccessCondition(ctx, dataImportCron, format, snapshot); err != nil {
return res, err
}
} else if len(imports) > 0 {
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionFalse, "Import is progressing", inProgress)
} else {
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionFalse, "No source digest", noDigest)
}
if err := updateLastExecutionTimestamp(dataImportCron); err != nil {
return res, err
}
if !reflect.DeepEqual(dataImportCron, dataImportCronCopy) {
if err := r.client.Update(ctx, dataImportCron); err != nil {
return res, err
}
}
return res, nil
}
// Returns the current import DV if exists, and the last imported PVC
func (r *DataImportCronReconciler) getImportState(ctx context.Context, cron *cdiv1.DataImportCron) (*cdiv1.DataVolume, *corev1.PersistentVolumeClaim, error) {
imports := cron.Status.CurrentImports
if len(imports) == 0 {
return nil, nil, nil
}
dvName := imports[0].DataVolumeName
dv := &cdiv1.DataVolume{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: cron.Namespace, Name: dvName}, dv); err != nil {
if !k8serrors.IsNotFound(err) {
return nil, nil, err
}
dv = nil
}
pvc := &corev1.PersistentVolumeClaim{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: cron.Namespace, Name: dvName}, pvc); err != nil {
if !k8serrors.IsNotFound(err) {
return nil, nil, err
}
pvc = nil
}
return dv, pvc, nil
}
// Returns the current import DV if exists, and the last imported PVC
func (r *DataImportCronReconciler) getSnapshot(ctx context.Context, cron *cdiv1.DataImportCron, format cdiv1.DataImportCronSourceFormat) (*snapshotv1.VolumeSnapshot, error) {
if format != cdiv1.DataImportCronSourceFormatSnapshot {
return nil, nil
}
imports := cron.Status.CurrentImports
if len(imports) == 0 {
return nil, nil
}
snapName := imports[0].DataVolumeName
snapshot := &snapshotv1.VolumeSnapshot{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: cron.Namespace, Name: snapName}, snapshot); err != nil {
if !k8serrors.IsNotFound(err) {
return nil, err
}
return nil, nil
}
return snapshot, nil
}
func (r *DataImportCronReconciler) updateSource(ctx context.Context, cron *cdiv1.DataImportCron, obj client.Object) error {
objCopy := obj.DeepCopyObject()
cc.AddAnnotation(obj, AnnLastUseTime, time.Now().UTC().Format(time.RFC3339Nano))
r.setDataImportCronResourceLabels(cron, obj)
if !reflect.DeepEqual(obj, objCopy) {
if err := r.client.Update(ctx, obj); err != nil {
return err
}
}
return nil
}
func (r *DataImportCronReconciler) deleteErroneousDataVolume(ctx context.Context, cron *cdiv1.DataImportCron, dv *cdiv1.DataVolume) error {
log := r.log.WithValues("name", dv.Name).WithValues("uid", dv.UID)
if cond := cdv.FindConditionByType(cdiv1.DataVolumeRunning, dv.Status.Conditions); cond != nil {
if cond.Status == corev1.ConditionFalse && cond.Reason == common.GenericError {
log.Info("Delete DataVolume and reset DesiredDigest due to error", "message", cond.Message)
// Unlabel the DV before deleting it, to eliminate reconcile before DIC is updated
dv.Labels[common.DataImportCronLabel] = ""
if err := r.client.Update(ctx, dv); cc.IgnoreNotFound(err) != nil {
return err
}
if err := r.client.Delete(ctx, dv); cc.IgnoreNotFound(err) != nil {
return err
}
cron.Status.CurrentImports = nil
}
}
return nil
}
func (r *DataImportCronReconciler) updateImageStreamDesiredDigest(ctx context.Context, dataImportCron *cdiv1.DataImportCron) error {
log := r.log.WithValues("name", dataImportCron.Name).WithValues("uid", dataImportCron.UID)
regSource, err := getCronRegistrySource(dataImportCron)
if err != nil {
return err
}
if regSource.ImageStream == nil {
return nil
}
imageStream, imageStreamTag, err := r.getImageStream(ctx, *regSource.ImageStream, dataImportCron.Namespace)
if err != nil {
return err
}
digest, dockerRef, err := getImageStreamDigest(imageStream, imageStreamTag)
if err != nil {
return err
}
cc.AddAnnotation(dataImportCron, AnnLastCronTime, time.Now().Format(time.RFC3339))
if digest != "" && dataImportCron.Annotations[AnnSourceDesiredDigest] != digest {
log.Info("Updating DataImportCron", "digest", digest)
cc.AddAnnotation(dataImportCron, AnnSourceDesiredDigest, digest)
cc.AddAnnotation(dataImportCron, AnnImageStreamDockerRef, dockerRef)
}
return nil
}
func (r *DataImportCronReconciler) updateDataSource(ctx context.Context, dataImportCron *cdiv1.DataImportCron, format cdiv1.DataImportCronSourceFormat) error {
log := r.log.WithName("updateDataSource")
dataSourceName := dataImportCron.Spec.ManagedDataSource
dataSource := &cdiv1.DataSource{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: dataImportCron.Namespace, Name: dataSourceName}, dataSource); err != nil {
if k8serrors.IsNotFound(err) {
dataSource = r.newDataSource(dataImportCron)
if err := r.client.Create(ctx, dataSource); err != nil {
return err
}
log.Info("DataSource created", "name", dataSourceName, "uid", dataSource.UID)
} else {
return err
}
}
if dataSource.Labels[common.DataImportCronLabel] == "" {
log.Info("DataSource has no DataImportCron label, so it is not updated", "name", dataSourceName, "uid", dataSource.UID)
return nil
}
dataSourceCopy := dataSource.DeepCopy()
r.setDataImportCronResourceLabels(dataImportCron, dataSource)
for _, defaultInstanceTypeLabel := range cc.DefaultInstanceTypeLabels {
passCronLabelToDataSource(dataImportCron, dataSource, defaultInstanceTypeLabel)
}
passCronLabelToDataSource(dataImportCron, dataSource, cc.LabelDynamicCredentialSupport)
sourcePVC := dataImportCron.Status.LastImportedPVC
populateDataSource(format, dataSource, sourcePVC)
if !reflect.DeepEqual(dataSource, dataSourceCopy) {
if err := r.client.Update(ctx, dataSource); err != nil {
return err
}
}
return nil
}
func populateDataSource(format cdiv1.DataImportCronSourceFormat, dataSource *cdiv1.DataSource, sourcePVC *cdiv1.DataVolumeSourcePVC) {
if sourcePVC == nil {
return
}
switch format {
case cdiv1.DataImportCronSourceFormatPvc:
dataSource.Spec.Source = cdiv1.DataSourceSource{
PVC: sourcePVC,
}
case cdiv1.DataImportCronSourceFormatSnapshot:
dataSource.Spec.Source = cdiv1.DataSourceSource{
Snapshot: &cdiv1.DataVolumeSourceSnapshot{
Namespace: sourcePVC.Namespace,
Name: sourcePVC.Name,
},
}
}
}
func updateDataImportCronOnSuccess(dataImportCron *cdiv1.DataImportCron) error {
if dataImportCron.Status.CurrentImports == nil {
return errors.Errorf("No CurrentImports in cron %s", dataImportCron.Name)
}
sourcePVC := &cdiv1.DataVolumeSourcePVC{
Namespace: dataImportCron.Namespace,
Name: dataImportCron.Status.CurrentImports[0].DataVolumeName,
}
if dataImportCron.Status.LastImportedPVC == nil || *dataImportCron.Status.LastImportedPVC != *sourcePVC {
dataImportCron.Status.LastImportedPVC = sourcePVC
now := metav1.Now()
dataImportCron.Status.LastImportTimestamp = &now
}
return nil
}
func updateLastExecutionTimestamp(cron *cdiv1.DataImportCron) error {
lastTimeStr := cron.Annotations[AnnLastCronTime]
if lastTimeStr == "" {
return nil
}
lastTime, err := time.Parse(time.RFC3339, lastTimeStr)
if err != nil {
return err
}
if ts := cron.Status.LastExecutionTimestamp; ts == nil || ts.Time != lastTime {
cron.Status.LastExecutionTimestamp = &metav1.Time{Time: lastTime}
}
return nil
}
func (r *DataImportCronReconciler) createImportDataVolume(ctx context.Context, dataImportCron *cdiv1.DataImportCron) error {
dataSourceName := dataImportCron.Spec.ManagedDataSource
digest := dataImportCron.Annotations[AnnSourceDesiredDigest]
if digest == "" {
return nil
}
dvName, err := createDvName(dataSourceName, digest)
if err != nil {
return err
}
dataImportCron.Status.CurrentImports = []cdiv1.ImportStatus{{DataVolumeName: dvName, Digest: digest}}
sources := []client.Object{&snapshotv1.VolumeSnapshot{}, &corev1.PersistentVolumeClaim{}}
for _, src := range sources {
if err := r.client.Get(ctx, types.NamespacedName{Namespace: dataImportCron.Namespace, Name: dvName}, src); err != nil {
if !k8serrors.IsNotFound(err) && !meta.IsNoMatchError(err) {
return err
}
} else {
if err := r.updateSource(ctx, dataImportCron, src); err != nil {
return err
}
// If source exists don't create DV
return nil
}
}
dv := r.newSourceDataVolume(dataImportCron, dvName)
if err := r.client.Create(ctx, dv); err != nil && !k8serrors.IsAlreadyExists(err) {
return err
}
return nil
}
func (r *DataImportCronReconciler) handleCronFormat(ctx context.Context, dataImportCron *cdiv1.DataImportCron, pvc *corev1.PersistentVolumeClaim, format cdiv1.DataImportCronSourceFormat, desiredStorageClass *storagev1.StorageClass) error {
switch format {
case cdiv1.DataImportCronSourceFormatPvc:
return nil
case cdiv1.DataImportCronSourceFormatSnapshot:
return r.handleSnapshot(ctx, dataImportCron, pvc, desiredStorageClass)
default:
return fmt.Errorf("unknown source format for snapshot")
}
}
func (r *DataImportCronReconciler) handleSnapshot(ctx context.Context, dataImportCron *cdiv1.DataImportCron, pvc *corev1.PersistentVolumeClaim, desiredStorageClass *storagev1.StorageClass) error {
if sc := pvc.Spec.StorageClassName; sc != nil && *sc != desiredStorageClass.Name {
r.log.Info("Attempt to change storage class, will not try making a snapshot of the old PVC")
return nil
}
storageProfile := &cdiv1.StorageProfile{}
if err := r.client.Get(ctx, types.NamespacedName{Name: desiredStorageClass.Name}, storageProfile); err != nil {
return err
}
className, err := cc.GetSnapshotClassForSmartClone(pvc, &desiredStorageClass.Name, storageProfile.Status.SnapshotClass, r.log, r.client, r.recorder)
if err != nil {
return err
}
labels := map[string]string{
common.CDILabelKey: common.CDILabelValue,
common.CDIComponentLabel: "",
}
desiredSnapshot := &snapshotv1.VolumeSnapshot{
ObjectMeta: metav1.ObjectMeta{
Name: pvc.Name,
Namespace: dataImportCron.Namespace,
Labels: labels,
},
Spec: snapshotv1.VolumeSnapshotSpec{
Source: snapshotv1.VolumeSnapshotSource{
PersistentVolumeClaimName: &pvc.Name,
},
VolumeSnapshotClassName: &className,
},
}
r.setDataImportCronResourceLabels(dataImportCron, desiredSnapshot)
currentSnapshot := &snapshotv1.VolumeSnapshot{}
if err := r.client.Get(ctx, client.ObjectKeyFromObject(desiredSnapshot), currentSnapshot); err != nil {
if !k8serrors.IsNotFound(err) {
return err
}
cc.AddAnnotation(desiredSnapshot, AnnLastUseTime, time.Now().UTC().Format(time.RFC3339Nano))
if err := r.client.Create(ctx, desiredSnapshot); err != nil {
return err
}
} else {
if cc.IsSnapshotReady(currentSnapshot) {
// Clean up DV/PVC as they are not needed anymore
r.log.Info("Deleting dv/pvc as snapshot is ready", "name", desiredSnapshot.Name)
if err := r.deleteDvPvc(ctx, desiredSnapshot.Name, desiredSnapshot.Namespace); err != nil {
return err
}
}
}
return nil
}
func (r *DataImportCronReconciler) updateDataImportCronSuccessCondition(ctx context.Context, dataImportCron *cdiv1.DataImportCron, format cdiv1.DataImportCronSourceFormat, snapshot *snapshotv1.VolumeSnapshot) error {
dataImportCron.Status.SourceFormat = &format
switch format {
case cdiv1.DataImportCronSourceFormatPvc:
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionTrue, "Latest import is up to date", upToDate)
case cdiv1.DataImportCronSourceFormatSnapshot:
if snapshot == nil {
// Snapshot create/update will trigger reconcile
return nil
}
if cc.IsSnapshotReady(snapshot) {
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionTrue, "Latest import is up to date", upToDate)
} else {
updateDataImportCronCondition(dataImportCron, cdiv1.DataImportCronUpToDate, corev1.ConditionFalse, "Snapshot of imported data is progressing", inProgress)
}
default:
return fmt.Errorf("unknown source format for snapshot")
}
return nil
}
func (r *DataImportCronReconciler) getSourceFormat(ctx context.Context, desiredStorageClass *storagev1.StorageClass) (cdiv1.DataImportCronSourceFormat, error) {
format := cdiv1.DataImportCronSourceFormatPvc
if desiredStorageClass == nil {
return format, nil
}
storageProfile := &cdiv1.StorageProfile{}
if err := r.client.Get(ctx, types.NamespacedName{Name: desiredStorageClass.Name}, storageProfile); err != nil {
return format, err
}
if storageProfile.Status.DataImportCronSourceFormat != nil {
format = *storageProfile.Status.DataImportCronSourceFormat
}
return format, nil
}
func (r *DataImportCronReconciler) garbageCollectOldImports(ctx context.Context, cron *cdiv1.DataImportCron) error {
if cron.Spec.GarbageCollect != nil && *cron.Spec.GarbageCollect != cdiv1.DataImportCronGarbageCollectOutdated {
return nil
}
selector, err := getSelector(map[string]string{common.DataImportCronLabel: cron.Name})
if err != nil {
return err
}
maxImports := defaultImportsToKeepPerCron
if cron.Spec.ImportsToKeep != nil && *cron.Spec.ImportsToKeep >= 0 {
maxImports = int(*cron.Spec.ImportsToKeep)
}
if err := r.garbageCollectPVCs(ctx, cron.Namespace, cron.Name, selector, maxImports); err != nil {
return err
}
if err := r.garbageCollectSnapshots(ctx, cron.Namespace, selector, maxImports); err != nil {
return err
}
return nil
}
func (r *DataImportCronReconciler) garbageCollectPVCs(ctx context.Context, namespace, cronName string, selector labels.Selector, maxImports int) error {
pvcList := &corev1.PersistentVolumeClaimList{}
if err := r.client.List(ctx, pvcList, &client.ListOptions{Namespace: namespace, LabelSelector: selector}); err != nil {
return err
}
if len(pvcList.Items) > maxImports {
sort.Slice(pvcList.Items, func(i, j int) bool {
return pvcList.Items[i].Annotations[AnnLastUseTime] > pvcList.Items[j].Annotations[AnnLastUseTime]
})
for _, pvc := range pvcList.Items[maxImports:] {
r.log.Info("Deleting dv/pvc", "name", pvc.Name, "pvc.uid", pvc.UID)
if err := r.deleteDvPvc(ctx, pvc.Name, pvc.Namespace); err != nil {
return err
}
}
}
dvList := &cdiv1.DataVolumeList{}
if err := r.client.List(ctx, dvList, &client.ListOptions{Namespace: namespace, LabelSelector: selector}); err != nil {
return err
}
if len(dvList.Items) > maxImports {
for _, dv := range dvList.Items {
pvc := &corev1.PersistentVolumeClaim{}
if err := r.client.Get(ctx, types.NamespacedName{Namespace: namespace, Name: dv.Name}, pvc); err != nil {
return err
}
if pvc.Labels[common.DataImportCronLabel] != cronName {
r.log.Info("Deleting old version dv/pvc", "name", pvc.Name, "pvc.uid", pvc.UID)
if err := r.deleteDvPvc(ctx, dv.Name, dv.Namespace); err != nil {
return err
}
}
}
}
return nil
}
// deleteDvPvc deletes DV or PVC if DV was GCed
func (r *DataImportCronReconciler) deleteDvPvc(ctx context.Context, name, namespace string) error {
om := metav1.ObjectMeta{Name: name, Namespace: namespace}
dv := &cdiv1.DataVolume{ObjectMeta: om}
if err := r.client.Delete(ctx, dv); err == nil || !k8serrors.IsNotFound(err) {
return err
}
pvc := &corev1.PersistentVolumeClaim{ObjectMeta: om}
if err := r.client.Delete(ctx, pvc); err != nil && !k8serrors.IsNotFound(err) {
return err
}
return nil
}
func (r *DataImportCronReconciler) garbageCollectSnapshots(ctx context.Context, namespace string, selector labels.Selector, maxImports int) error {
snapList := &snapshotv1.VolumeSnapshotList{}
if err := r.client.List(ctx, snapList, &client.ListOptions{Namespace: namespace, LabelSelector: selector}); err != nil {
if meta.IsNoMatchError(err) {
return nil
}
return err
}
if len(snapList.Items) > maxImports {
sort.Slice(snapList.Items, func(i, j int) bool {
return snapList.Items[i].Annotations[AnnLastUseTime] > snapList.Items[j].Annotations[AnnLastUseTime]
})
for _, snap := range snapList.Items[maxImports:] {
r.log.Info("Deleting snapshot", "name", snap.Name, "uid", snap.UID)
if err := r.client.Delete(ctx, &snap); err != nil && !k8serrors.IsNotFound(err) {
return err
}
}
}
return nil
}
func (r *DataImportCronReconciler) cleanup(ctx context.Context, cron types.NamespacedName) error {
// Don't keep alerting over a cron thats being deleted, will get set back to 1 again by reconcile loop if needed.
DataImportCronOutdatedGauge.DeletePartialMatch(getPrometheusCronLabels(cron))
if err := r.deleteJobs(ctx, cron); err != nil {
return err
}
selector, err := getSelector(map[string]string{common.DataImportCronLabel: cron.Name, common.DataImportCronCleanupLabel: "true"})
if err != nil {
return err
}
opts := &client.DeleteAllOfOptions{ListOptions: client.ListOptions{Namespace: cron.Namespace, LabelSelector: selector}}
if err := r.client.DeleteAllOf(ctx, &cdiv1.DataSource{}, opts); err != nil {
return err
}
if err := r.client.DeleteAllOf(ctx, &cdiv1.DataVolume{}, opts); err != nil {
return err
}
if err := r.client.DeleteAllOf(ctx, &corev1.PersistentVolumeClaim{}, opts); err != nil {
return err
}
if err := r.client.DeleteAllOf(ctx, &snapshotv1.VolumeSnapshot{}, opts); cc.IgnoreIsNoMatchError(err) != nil {
return err
}
return nil
}
func (r *DataImportCronReconciler) deleteJobs(ctx context.Context, cron types.NamespacedName) error {
deletePropagationBackground := metav1.DeletePropagationBackground
deleteOpts := &client.DeleteOptions{PropagationPolicy: &deletePropagationBackground}
selector, err := getSelector(map[string]string{common.DataImportCronLabel: getCronJobLabelValue(cron.Namespace, cron.Name)})
if err != nil {
return err
}
cronJobList := &batchv1.CronJobList{}
if err := r.client.List(ctx, cronJobList, &client.ListOptions{Namespace: r.cdiNamespace, LabelSelector: selector}); err != nil {
return err
}
for _, cronJob := range cronJobList.Items {
if err := r.client.Delete(ctx, &cronJob, deleteOpts); cc.IgnoreNotFound(err) != nil {
return err
}
}
jobList := &batchv1.JobList{}
if err := r.client.List(ctx, jobList, &client.ListOptions{Namespace: r.cdiNamespace, LabelSelector: selector}); err != nil {
return err
}
for _, job := range jobList.Items {
if err := r.client.Delete(ctx, &job, deleteOpts); cc.IgnoreNotFound(err) != nil {
return err
}
}
return nil
}
// NewDataImportCronController creates a new instance of the DataImportCron controller
func NewDataImportCronController(mgr manager.Manager, log logr.Logger, importerImage, pullPolicy string, installerLabels map[string]string) (controller.Controller, error) {
uncachedClient, err := client.New(mgr.GetConfig(), client.Options{
Scheme: mgr.GetScheme(),
Mapper: mgr.GetRESTMapper(),
})
if err != nil {
return nil, err
}
reconciler := &DataImportCronReconciler{
client: mgr.GetClient(),
uncachedClient: uncachedClient,
recorder: mgr.GetEventRecorderFor(dataImportControllerName),
scheme: mgr.GetScheme(),
log: log.WithName(dataImportControllerName),
image: importerImage,
pullPolicy: pullPolicy,
cdiNamespace: util.GetNamespace(),
installerLabels: installerLabels,
}
dataImportCronController, err := controller.New(dataImportControllerName, mgr, controller.Options{
MaxConcurrentReconciles: 3,
Reconciler: reconciler,
})
if err != nil {
return nil, err
}
if err := addDataImportCronControllerWatches(mgr, dataImportCronController, log); err != nil {
return nil, err
}
log.Info("Initialized DataImportCron controller")
return dataImportCronController, nil
}
func addDataImportCronControllerWatches(mgr manager.Manager, c controller.Controller, log logr.Logger) error {
if err := c.Watch(&source.Kind{Type: &cdiv1.DataImportCron{}}, &handler.EnqueueRequestForObject{}); err != nil {
return err
}
getCronName := func(obj client.Object) string {
return obj.GetLabels()[common.DataImportCronLabel]
}
mapSourceObjectToCron := func(obj client.Object) []reconcile.Request {
if cronName := getCronName(obj); cronName != "" {
return []reconcile.Request{{NamespacedName: types.NamespacedName{Name: cronName, Namespace: obj.GetNamespace()}}}
}
return nil
}
mapStorageProfileToCron := func(obj client.Object) (reqs []reconcile.Request) {
// TODO: Get rid of this after at least one version; use indexer on storage class annotation instead
// Otherwise we risk losing the storage profile event
var crons cdiv1.DataImportCronList
if err := mgr.GetClient().List(context.TODO(), &crons); err != nil {
c.GetLogger().Error(err, "Unable to list DataImportCrons")
return
}
// Storage profiles are 1:1 to storage classes
scName := obj.GetName()
for _, cron := range crons.Items {
dataVolume := cron.Spec.Template
explicitScName := cc.GetStorageClassFromDVSpec(&dataVolume)