forked from kubevirt/containerized-data-importer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathimport-controller.go
1330 lines (1214 loc) · 42.9 KB
/
import-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
package controller
import (
"context"
"fmt"
"net/url"
"path"
"reflect"
"strconv"
"strings"
"time"
"github.com/go-logr/logr"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/record"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"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"
featuregates "kubevirt.io/containerized-data-importer/pkg/feature-gates"
"kubevirt.io/containerized-data-importer/pkg/util"
"kubevirt.io/containerized-data-importer/pkg/util/naming"
sdkapi "kubevirt.io/controller-lifecycle-operator-sdk/api"
)
const (
// ErrImportFailedPVC provides a const to indicate an import to the PVC failed
ErrImportFailedPVC = "ErrImportFailed"
// ImportSucceededPVC provides a const to indicate an import to the PVC failed
ImportSucceededPVC = "ImportSucceeded"
// creatingScratch provides a const to indicate scratch is being created.
creatingScratch = "CreatingScratchSpace"
// ImportTargetInUse is reason for event created when an import pvc is in use
ImportTargetInUse = "ImportTargetInUse"
// importPodImageStreamFinalizer ensures image stream import pod is deleted when pvc is deleted,
// as in this case pod has no pvc OwnerReference
importPodImageStreamFinalizer = "cdi.kubevirt.io/importImageStream"
// secretExtraHeadersVolumeName is the format string that specifies where extra HTTP header secrets will be mounted
secretExtraHeadersVolumeName = "cdi-secret-extra-headers-vol-%d"
)
// ImportReconciler members
type ImportReconciler struct {
client client.Client
uncachedClient client.Client
recorder record.EventRecorder
scheme *runtime.Scheme
log logr.Logger
image string
verbose string
pullPolicy string
filesystemOverhead string //nolint:unused // TODO: check if need to remove this field
cdiNamespace string
featureGates featuregates.FeatureGates
installerLabels map[string]string
}
type importPodEnvVar struct {
ep string
secretName string
source string
contentType string
imageSize string
certConfigMap string
diskID string
uuid string
pullMethod string
readyFile string
doneFile string
backingFile string
thumbprint string
filesystemOverhead string
insecureTLS bool
currentCheckpoint string
previousCheckpoint string
finalCheckpoint string
preallocation bool
httpProxy string
httpsProxy string
noProxy string
certConfigMapProxy string
extraHeaders []string
secretExtraHeaders []string
cacheMode string
}
type importerPodArgs struct {
image string
importImage string
verbose string
pullPolicy string
podEnvVar *importPodEnvVar
pvc *corev1.PersistentVolumeClaim
scratchPvcName *string
podResourceRequirements *corev1.ResourceRequirements
imagePullSecrets []corev1.LocalObjectReference
workloadNodePlacement *sdkapi.NodePlacement
vddkImageName *string
priorityClassName string
}
// NewImportController creates a new instance of the import controller.
func NewImportController(mgr manager.Manager, log logr.Logger, importerImage, pullPolicy, verbose 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
}
client := mgr.GetClient()
reconciler := &ImportReconciler{
client: client,
uncachedClient: uncachedClient,
scheme: mgr.GetScheme(),
log: log.WithName("import-controller"),
image: importerImage,
verbose: verbose,
pullPolicy: pullPolicy,
recorder: mgr.GetEventRecorderFor("import-controller"),
cdiNamespace: util.GetNamespace(),
featureGates: featuregates.NewFeatureGates(client),
installerLabels: installerLabels,
}
importController, err := controller.New("import-controller", mgr, controller.Options{
MaxConcurrentReconciles: 3,
Reconciler: reconciler,
})
if err != nil {
return nil, err
}
if err := addImportControllerWatches(mgr, importController); err != nil {
return nil, err
}
return importController, nil
}
func addImportControllerWatches(mgr manager.Manager, importController controller.Controller) error {
// Setup watches
if err := importController.Watch(source.Kind(mgr.GetCache(), &corev1.PersistentVolumeClaim{}, &handler.TypedEnqueueRequestForObject[*corev1.PersistentVolumeClaim]{})); err != nil {
return err
}
if err := importController.Watch(source.Kind(mgr.GetCache(), &corev1.Pod{}, handler.TypedEnqueueRequestForOwner[*corev1.Pod](
mgr.GetScheme(), mgr.GetClient().RESTMapper(), &corev1.PersistentVolumeClaim{}, handler.OnlyControllerOwner()))); err != nil {
return err
}
return nil
}
func (r *ImportReconciler) shouldReconcilePVC(pvc *corev1.PersistentVolumeClaim,
log logr.Logger) (bool, error) {
_, pvcUsesExternalPopulator := pvc.Annotations[cc.AnnExternalPopulation]
if pvcUsesExternalPopulator {
return false, nil
}
waitForFirstConsumerEnabled, err := cc.IsWaitForFirstConsumerEnabled(pvc, r.featureGates)
if err != nil {
return false, err
}
return (!cc.IsPVCComplete(pvc) || cc.IsMultiStageImportInProgress(pvc)) &&
(checkPVC(pvc, cc.AnnEndpoint, log) || checkPVC(pvc, cc.AnnSource, log)) &&
shouldHandlePvc(pvc, waitForFirstConsumerEnabled, log),
nil
}
// Reconcile the reconcile loop for the CDIConfig object.
func (r *ImportReconciler) Reconcile(_ context.Context, req reconcile.Request) (reconcile.Result, error) {
log := r.log.WithValues("PVC", req.NamespacedName)
log.V(1).Info("reconciling Import PVCs")
// Get the PVC.
pvc := &corev1.PersistentVolumeClaim{}
if err := r.client.Get(context.TODO(), req.NamespacedName, pvc); err != nil {
if k8serrors.IsNotFound(err) {
return reconcile.Result{}, nil
}
return reconcile.Result{}, err
}
shouldReconcile, err := r.shouldReconcilePVC(pvc, log)
if err != nil {
return reconcile.Result{}, err
}
if !shouldReconcile {
multiStageImport := metav1.HasAnnotation(pvc.ObjectMeta, cc.AnnCurrentCheckpoint)
multiStageAlreadyDone := metav1.HasAnnotation(pvc.ObjectMeta, cc.AnnMultiStageImportDone)
log.V(3).Info("Should not reconcile this PVC",
"pvc.annotation.phase.complete", cc.IsPVCComplete(pvc),
"pvc.annotations.endpoint", checkPVC(pvc, cc.AnnEndpoint, log),
"pvc.annotations.source", checkPVC(pvc, cc.AnnSource, log),
"isBound", isBound(pvc, log), "isMultistage", multiStageImport, "multiStageDone", multiStageAlreadyDone)
return reconcile.Result{}, nil
}
return r.reconcilePvc(pvc, log)
}
func (r *ImportReconciler) findImporterPod(pvc *corev1.PersistentVolumeClaim, log logr.Logger) (*corev1.Pod, error) {
podName := getImportPodNameFromPvc(pvc)
pod := &corev1.Pod{}
if err := r.client.Get(context.TODO(), types.NamespacedName{Name: podName, Namespace: pvc.GetNamespace()}, pod); err != nil {
if !k8serrors.IsNotFound(err) {
return nil, errors.Wrapf(err, "error getting import pod %s/%s", pvc.Namespace, podName)
}
return nil, nil
}
if !metav1.IsControlledBy(pod, pvc) && !cc.IsImageStream(pvc) {
return nil, errors.Errorf("Pod is not owned by PVC")
}
log.V(1).Info("Pod is owned by PVC", pod.Name, pvc.Name)
return pod, nil
}
func (r *ImportReconciler) reconcilePvc(pvc *corev1.PersistentVolumeClaim, log logr.Logger) (reconcile.Result, error) {
// See if we have a pod associated with the PVC, we know the PVC has the needed annotations.
pod, err := r.findImporterPod(pvc, log)
if err != nil {
return reconcile.Result{}, err
}
if pod == nil {
if cc.IsPVCComplete(pvc) {
// Don't create the POD if the PVC is completed already
log.V(1).Info("PVC is already complete")
} else if pvc.DeletionTimestamp == nil {
podsUsingPVC, err := cc.GetPodsUsingPVCs(context.TODO(), r.client, pvc.Namespace, sets.New(pvc.Name), false)
if err != nil {
return reconcile.Result{}, err
}
if len(podsUsingPVC) > 0 {
for _, pod := range podsUsingPVC {
r.log.V(1).Info("can't create import pod, pvc in use by other pod",
"namespace", pvc.Namespace, "name", pvc.Name, "pod", pod.Name)
r.recorder.Eventf(pvc, corev1.EventTypeWarning, ImportTargetInUse,
"pod %s/%s using PersistentVolumeClaim %s", pod.Namespace, pod.Name, pvc.Name)
}
return reconcile.Result{Requeue: true}, nil
}
if _, ok := pvc.Annotations[cc.AnnImportPod]; ok {
// Create importer pod, make sure the PVC owns it.
if err := r.createImporterPod(pvc); err != nil {
return reconcile.Result{}, err
}
} else {
// Create importer pod Name and store in PVC?
if err := r.initPvcPodName(pvc, log); err != nil {
return reconcile.Result{}, err
}
}
}
} else {
if pvc.DeletionTimestamp != nil {
log.V(1).Info("PVC being terminated, delete pods", "pod.Name", pod.Name)
if err := r.cleanup(pvc, pod, log); err != nil {
return reconcile.Result{}, err
}
} else {
// Copy import proxy ConfigMap (if exists) from cdi namespace to the import namespace
if err := r.copyImportProxyConfigMap(pvc, pod); err != nil {
return reconcile.Result{}, err
}
// Pod exists, we need to update the PVC status.
if err := r.updatePvcFromPod(pvc, pod, log); err != nil {
return reconcile.Result{}, err
}
}
}
if !cc.IsPVCComplete(pvc) {
// We are not done yet, force a re-reconcile in 2 seconds to get an update.
log.V(1).Info("Force Reconcile pvc import not finished", "pvc.Name", pvc.Name)
return reconcile.Result{RequeueAfter: 2 * time.Second}, nil
}
return reconcile.Result{}, nil
}
func (r *ImportReconciler) copyImportProxyConfigMap(pvc *corev1.PersistentVolumeClaim, pod *corev1.Pod) error {
cdiConfig := &cdiv1.CDIConfig{}
if err := r.client.Get(context.TODO(), types.NamespacedName{Name: common.ConfigName}, cdiConfig); err != nil {
return err
}
cmName, err := GetImportProxyConfig(cdiConfig, common.ImportProxyConfigMapName)
if err != nil || cmName == "" {
return nil
}
cdiConfigMap := &corev1.ConfigMap{}
if err := r.uncachedClient.Get(context.TODO(), types.NamespacedName{Name: cmName, Namespace: r.cdiNamespace}, cdiConfigMap); err != nil {
return err
}
importConfigMap := &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: GetImportProxyConfigMapName(pvc.Name),
Namespace: pvc.Namespace,
OwnerReferences: []metav1.OwnerReference{{
APIVersion: pod.APIVersion,
Kind: pod.Kind,
Name: pod.Name,
UID: pod.UID,
BlockOwnerDeletion: ptr.To[bool](true),
Controller: ptr.To[bool](true),
}},
},
Data: cdiConfigMap.Data,
}
if err := r.client.Create(context.TODO(), importConfigMap); err != nil && !k8serrors.IsAlreadyExists(err) {
return err
}
return nil
}
// GetImportProxyConfigMapName returns the import proxy ConfigMap name
func GetImportProxyConfigMapName(pvcName string) string {
return naming.GetResourceName("import-proxy-cm", pvcName)
}
func (r *ImportReconciler) initPvcPodName(pvc *corev1.PersistentVolumeClaim, log logr.Logger) error {
currentPvcCopy := pvc.DeepCopyObject()
log.V(1).Info("Init pod name on PVC")
anno := pvc.GetAnnotations()
anno[cc.AnnImportPod] = createImportPodNameFromPvc(pvc)
requiresScratch := r.requiresScratchSpace(pvc)
if requiresScratch {
anno[cc.AnnRequiresScratch] = "true"
}
if !reflect.DeepEqual(currentPvcCopy, pvc) {
if err := r.updatePVC(pvc, log); err != nil {
return err
}
log.V(1).Info("Updated PVC", "pvc.anno.AnnImportPod", anno[cc.AnnImportPod])
}
return nil
}
func (r *ImportReconciler) updatePvcFromPod(pvc *corev1.PersistentVolumeClaim, pod *corev1.Pod, log logr.Logger) error {
// Keep a copy of the original for comparison later.
currentPvcCopy := pvc.DeepCopyObject()
log.V(1).Info("Updating PVC from pod")
anno := pvc.GetAnnotations()
termMsg, err := parseTerminationMessage(pod)
if err != nil {
log.V(3).Info("Ignoring failure to parse termination message", "error", err.Error())
}
setAnnotationsFromPodWithPrefix(anno, pod, termMsg, cc.AnnRunningCondition)
scratchSpaceRequired := termMsg != nil && termMsg.ScratchSpaceRequired != nil && *termMsg.ScratchSpaceRequired
if scratchSpaceRequired {
log.V(1).Info("Pod requires scratch space, terminating pod, and restarting with scratch space", "pod.Name", pod.Name)
}
podModificationsNeeded := scratchSpaceRequired
if statuses := pod.Status.ContainerStatuses; len(statuses) > 0 {
if isOOMKilled(statuses[0]) {
log.V(1).Info("Pod died of an OOM, deleting pod, and restarting with qemu cache mode=none if storage supports it", "pod.Name", pod.Name)
podModificationsNeeded = true
anno[cc.AnnRequiresDirectIO] = "true"
}
if terminated := statuses[0].State.Terminated; terminated != nil && terminated.ExitCode > 0 {
log.Info("Pod termination code", "pod.Name", pod.Name, "ExitCode", terminated.ExitCode)
r.recorder.Event(pvc, corev1.EventTypeWarning, ErrImportFailedPVC, terminated.Message)
}
}
if anno[cc.AnnCurrentCheckpoint] != "" {
anno[cc.AnnCurrentPodID] = string(pod.ObjectMeta.UID)
}
anno[cc.AnnImportPod] = pod.Name
if !podModificationsNeeded {
// No scratch space required, update the phase based on the pod. If we require scratch space we don't want to update the
// phase, because the pod might terminate cleanly and mistakenly mark the import complete.
anno[cc.AnnPodPhase] = string(pod.Status.Phase)
}
for _, ev := range pod.Spec.Containers[0].Env {
if ev.Name == common.CacheMode && ev.Value == common.CacheModeTryNone {
anno[cc.AnnRequiresDirectIO] = "false"
}
}
// Check if the POD is waiting for scratch space, if so create some.
if pod.Status.Phase == corev1.PodPending && r.requiresScratchSpace(pvc) {
if err := r.createScratchPvcForPod(pvc, pod); err != nil {
if !k8serrors.IsAlreadyExists(err) {
return err
}
}
} else {
// No scratch space, or scratch space is bound, remove annotation
delete(anno, cc.AnnBoundCondition)
delete(anno, cc.AnnBoundConditionMessage)
delete(anno, cc.AnnBoundConditionReason)
}
if pvc.GetLabels() == nil {
pvc.SetLabels(make(map[string]string, 0))
}
if !checkIfLabelExists(pvc, common.CDILabelKey, common.CDILabelValue) {
pvc.GetLabels()[common.CDILabelKey] = common.CDILabelValue
}
if cc.IsPVCComplete(pvc) {
pvc.SetLabels(addLabelsFromTerminationMessage(pvc.GetLabels(), termMsg))
}
if !reflect.DeepEqual(currentPvcCopy, pvc) {
if err := r.updatePVC(pvc, log); err != nil {
return err
}
log.V(1).Info("Updated PVC", "pvc.anno.Phase", anno[cc.AnnPodPhase], "pvc.anno.Restarts", anno[cc.AnnPodRestarts])
}
if cc.IsPVCComplete(pvc) || podModificationsNeeded {
if !podModificationsNeeded {
r.recorder.Event(pvc, corev1.EventTypeNormal, ImportSucceededPVC, "Import Successful")
log.V(1).Info("Import completed successfully")
}
if cc.ShouldDeletePod(pvc) {
log.V(1).Info("Deleting pod", "pod.Name", pod.Name)
if err := r.cleanup(pvc, pod, log); err != nil {
return err
}
}
}
return nil
}
func (r *ImportReconciler) cleanup(pvc *corev1.PersistentVolumeClaim, pod *corev1.Pod, log logr.Logger) error {
if err := r.client.Delete(context.TODO(), pod); cc.IgnoreNotFound(err) != nil {
return err
}
if cc.HasFinalizer(pvc, importPodImageStreamFinalizer) {
cc.RemoveFinalizer(pvc, importPodImageStreamFinalizer)
if err := r.updatePVC(pvc, log); err != nil {
return err
}
}
return nil
}
func (r *ImportReconciler) updatePVC(pvc *corev1.PersistentVolumeClaim, log logr.Logger) error {
if err := r.client.Update(context.TODO(), pvc); err != nil {
return err
}
return nil
}
func (r *ImportReconciler) createImporterPod(pvc *corev1.PersistentVolumeClaim) error {
r.log.V(1).Info("Creating importer POD for PVC", "pvc.Name", pvc.Name)
var scratchPvcName *string
var vddkImageName *string
var err error
requiresScratch := r.requiresScratchSpace(pvc)
if requiresScratch {
name := createScratchNameFromPvc(pvc)
scratchPvcName = &name
}
if cc.GetSource(pvc) == cc.SourceVDDK {
r.log.V(1).Info("Pod requires VDDK sidecar for VMware transfer")
anno := pvc.GetAnnotations()
if imageName, ok := anno[cc.AnnVddkInitImageURL]; ok {
vddkImageName = &imageName
} else {
if vddkImageName, err = r.getVddkImageName(); err != nil {
r.log.V(1).Error(err, "failed to get VDDK image name from configmap")
}
}
if vddkImageName == nil {
message := fmt.Sprintf("waiting for %s configmap or %s annotation for VDDK image", common.VddkConfigMap, cc.AnnVddkInitImageURL)
anno[cc.AnnBoundCondition] = "false"
anno[cc.AnnBoundConditionMessage] = message
anno[cc.AnnBoundConditionReason] = common.AwaitingVDDK
if err := r.updatePVC(pvc, r.log); err != nil {
return err
}
return errors.New(message)
}
}
podEnvVar, err := r.createImportEnvVar(pvc)
if err != nil {
return err
}
// all checks passed, let's create the importer pod!
podArgs := &importerPodArgs{
image: r.image,
verbose: r.verbose,
pullPolicy: r.pullPolicy,
podEnvVar: podEnvVar,
pvc: pvc,
scratchPvcName: scratchPvcName,
vddkImageName: vddkImageName,
priorityClassName: cc.GetPriorityClass(pvc),
}
pod, err := createImporterPod(context.TODO(), r.log, r.client, podArgs, r.installerLabels)
// Check if pod has failed and, in that case, record an event with the error
if podErr := cc.HandleFailedPod(err, pvc.Annotations[cc.AnnImportPod], pvc, r.recorder, r.client); podErr != nil {
return podErr
}
r.log.V(1).Info("Created POD", "pod.Name", pod.Name)
// If importing from image stream, add finalizer. Note we don't watch the importer pod in this case,
// so to prevent a deadlock we add finalizer only if the pod is not retained after completion.
if cc.IsImageStream(pvc) && pvc.GetAnnotations()[cc.AnnPodRetainAfterCompletion] != "true" {
cc.AddFinalizer(pvc, importPodImageStreamFinalizer)
if err := r.updatePVC(pvc, r.log); err != nil {
return err
}
}
if requiresScratch {
r.log.V(1).Info("Pod requires scratch space")
return r.createScratchPvcForPod(pvc, pod)
}
return nil
}
func createScratchNameFromPvc(pvc *v1.PersistentVolumeClaim) string {
return naming.GetResourceName(pvc.Name, common.ScratchNameSuffix)
}
func (r *ImportReconciler) createImportEnvVar(pvc *corev1.PersistentVolumeClaim) (*importPodEnvVar, error) {
podEnvVar := &importPodEnvVar{}
podEnvVar.source = cc.GetSource(pvc)
podEnvVar.contentType = string(cc.GetPVCContentType(pvc))
var err error
if podEnvVar.source != cc.SourceNone {
podEnvVar.ep, err = cc.GetEndpoint(pvc)
if err != nil {
return nil, err
}
podEnvVar.secretName = r.getSecretName(pvc)
if podEnvVar.secretName == "" {
r.log.V(2).Info("no secret will be supplied to endpoint", "endPoint", podEnvVar.ep)
}
//get the CDIConfig to extract the proxy configuration to be used to import an image
cdiConfig := &cdiv1.CDIConfig{}
err = r.client.Get(context.TODO(), types.NamespacedName{Name: common.ConfigName}, cdiConfig)
if err != nil {
return nil, err
}
podEnvVar.certConfigMap, err = r.getCertConfigMap(pvc)
if err != nil {
return nil, err
}
podEnvVar.insecureTLS, err = r.isInsecureTLS(pvc, cdiConfig)
if err != nil {
return nil, err
}
podEnvVar.diskID = getValueFromAnnotation(pvc, cc.AnnDiskID)
podEnvVar.backingFile = getValueFromAnnotation(pvc, cc.AnnBackingFile)
podEnvVar.uuid = getValueFromAnnotation(pvc, cc.AnnUUID)
podEnvVar.thumbprint = getValueFromAnnotation(pvc, cc.AnnThumbprint)
podEnvVar.previousCheckpoint = getValueFromAnnotation(pvc, cc.AnnPreviousCheckpoint)
podEnvVar.currentCheckpoint = getValueFromAnnotation(pvc, cc.AnnCurrentCheckpoint)
podEnvVar.finalCheckpoint = getValueFromAnnotation(pvc, cc.AnnFinalCheckpoint)
for annotation, value := range pvc.Annotations {
if strings.HasPrefix(annotation, cc.AnnExtraHeaders) {
podEnvVar.extraHeaders = append(podEnvVar.extraHeaders, value)
}
if strings.HasPrefix(annotation, cc.AnnSecretExtraHeaders) {
podEnvVar.secretExtraHeaders = append(podEnvVar.secretExtraHeaders, value)
}
}
var field string
if field, err = GetImportProxyConfig(cdiConfig, common.ImportProxyHTTP); err != nil {
r.log.V(3).Info("no proxy http url will be supplied:", "error", err.Error())
}
podEnvVar.httpProxy = field
if field, err = GetImportProxyConfig(cdiConfig, common.ImportProxyHTTPS); err != nil {
r.log.V(3).Info("no proxy https url will be supplied:", "error", err.Error())
}
podEnvVar.httpsProxy = field
if field, err = GetImportProxyConfig(cdiConfig, common.ImportProxyNoProxy); err != nil {
r.log.V(3).Info("the noProxy field will not be supplied:", "error", err.Error())
}
podEnvVar.noProxy = field
if field, err = GetImportProxyConfig(cdiConfig, common.ImportProxyConfigMapName); err != nil {
r.log.V(3).Info("no proxy CA certiticate will be supplied:", "error", err.Error())
}
podEnvVar.certConfigMapProxy = field
}
fsOverhead, err := GetFilesystemOverhead(context.TODO(), r.client, pvc)
if err != nil {
return nil, err
}
podEnvVar.filesystemOverhead = string(fsOverhead)
if preallocation, err := strconv.ParseBool(getValueFromAnnotation(pvc, cc.AnnPreallocationRequested)); err == nil {
podEnvVar.preallocation = preallocation
} // else use the default "false"
//get the requested image size.
podEnvVar.imageSize, err = cc.GetRequestedImageSize(pvc)
if err != nil {
return nil, err
}
if v, ok := pvc.Annotations[cc.AnnRequiresDirectIO]; ok && v == "true" {
podEnvVar.cacheMode = common.CacheModeTryNone
}
return podEnvVar, nil
}
func (r *ImportReconciler) isInsecureTLS(pvc *corev1.PersistentVolumeClaim, cdiConfig *cdiv1.CDIConfig) (bool, error) {
ep, ok := pvc.Annotations[cc.AnnEndpoint]
if !ok || ep == "" {
return false, nil
}
return IsInsecureTLS(ep, cdiConfig, r.log)
}
// IsInsecureTLS checks if TLS security is disabled for the given endpoint
func IsInsecureTLS(ep string, cdiConfig *cdiv1.CDIConfig, log logr.Logger) (bool, error) {
url, err := url.Parse(ep)
if err != nil {
return false, err
}
if url.Scheme != "docker" {
return false, nil
}
for _, value := range cdiConfig.Spec.InsecureRegistries {
log.V(1).Info("Checking host against value", "host", url.Host, "value", value)
if value == url.Host {
return true, nil
}
}
return false, nil
}
func (r *ImportReconciler) getCertConfigMap(pvc *corev1.PersistentVolumeClaim) (string, error) {
value, ok := pvc.Annotations[cc.AnnCertConfigMap]
if !ok || value == "" {
return "", nil
}
configMap := &corev1.ConfigMap{}
if err := r.uncachedClient.Get(context.TODO(), types.NamespacedName{Name: value, Namespace: pvc.Namespace}, configMap); err != nil {
if k8serrors.IsNotFound(err) {
r.log.V(1).Info("Configmap does not exist, pod will not start until it does", "configMapName", value)
return value, nil
}
return "", err
}
return value, nil
}
// returns the name of the secret containing endpoint credentials consumed by the importer pod.
// A value of "" implies there are no credentials for the endpoint being used. A returned error
// causes processNextItem() to stop.
func (r *ImportReconciler) getSecretName(pvc *corev1.PersistentVolumeClaim) string {
ns := pvc.Namespace
name, found := pvc.Annotations[cc.AnnSecret]
if !found || name == "" {
msg := "getEndpointSecret: "
if !found {
msg += fmt.Sprintf("annotation %q is missing in pvc \"%s/%s\"", cc.AnnSecret, ns, pvc.Name)
} else {
msg += fmt.Sprintf("secret name is missing from annotation %q in pvc \"%s/%s\"", cc.AnnSecret, ns, pvc.Name)
}
r.log.V(2).Info(msg)
return "" // importer pod will not contain secret credentials
}
return name
}
func (r *ImportReconciler) requiresScratchSpace(pvc *corev1.PersistentVolumeClaim) bool {
scratchRequired := false
contentType := cc.GetPVCContentType(pvc)
// All archive requires scratch space.
if contentType == cdiv1.DataVolumeArchive {
scratchRequired = true
} else {
switch cc.GetSource(pvc) {
case cc.SourceGlance:
scratchRequired = true
case cc.SourceImageio:
if val, ok := pvc.Annotations[cc.AnnCurrentCheckpoint]; ok {
scratchRequired = val != ""
}
case cc.SourceRegistry:
scratchRequired = pvc.Annotations[cc.AnnRegistryImportMethod] != string(cdiv1.RegistryPullNode)
}
}
value, ok := pvc.Annotations[cc.AnnRequiresScratch]
if ok {
boolVal, _ := strconv.ParseBool(value)
scratchRequired = scratchRequired || boolVal
}
return scratchRequired
}
func (r *ImportReconciler) createScratchPvcForPod(pvc *corev1.PersistentVolumeClaim, pod *corev1.Pod) error {
scratchPvc := &corev1.PersistentVolumeClaim{}
scratchPVCName, exists := getScratchNameFromPod(pod)
if !exists {
return errors.New("Scratch Volume not configured for pod")
}
anno := pvc.GetAnnotations()
err := r.client.Get(context.TODO(), types.NamespacedName{Namespace: pvc.GetNamespace(), Name: scratchPVCName}, scratchPvc)
if cc.IgnoreNotFound(err) != nil {
return err
}
if k8serrors.IsNotFound(err) {
r.log.V(1).Info("Creating scratch space for POD and PVC", "pod.Name", pod.Name, "pvc.Name", pvc.Name)
storageClassName := GetScratchPvcStorageClass(r.client, pvc)
// Scratch PVC doesn't exist yet, create it. Determine which storage class to use.
_, err = createScratchPersistentVolumeClaim(r.client, pvc, pod, scratchPVCName, storageClassName, r.installerLabels, r.recorder)
if err != nil {
return err
}
anno[cc.AnnBoundCondition] = "false"
anno[cc.AnnBoundConditionMessage] = "Creating scratch space"
anno[cc.AnnBoundConditionReason] = creatingScratch
} else {
if scratchPvc.DeletionTimestamp != nil {
// Delete the pod since we are in a deadlock situation now. The scratch PVC from the previous import is not gone
// yet but terminating, and the new pod is still being created and the scratch PVC now has a finalizer on it.
// Only way to break it, is to delete the importer pod, and give the pvc a chance to disappear.
err = r.client.Delete(context.TODO(), pod)
if err != nil {
return err
}
return fmt.Errorf("terminating scratch space found, deleting pod %s", pod.Name)
}
setBoundConditionFromPVC(anno, cc.AnnBoundCondition, scratchPvc)
}
anno[cc.AnnRequiresScratch] = "false"
return nil
}
// Get path to VDDK image from 'v2v-vmware' ConfigMap
func (r *ImportReconciler) getVddkImageName() (*string, error) {
namespace := util.GetNamespace()
cm := &corev1.ConfigMap{}
err := r.uncachedClient.Get(context.TODO(), types.NamespacedName{Name: common.VddkConfigMap, Namespace: namespace}, cm)
if k8serrors.IsNotFound(err) {
return nil, errors.Errorf("No %s ConfigMap present in namespace %s", common.VddkConfigMap, namespace)
}
image, found := cm.Data[common.VddkConfigDataKey]
if found {
msg := fmt.Sprintf("Found %s ConfigMap in namespace %s, VDDK image path is: ", common.VddkConfigMap, namespace)
r.log.V(1).Info(msg, common.VddkConfigDataKey, image)
return &image, nil
}
return nil, errors.Errorf("found %s ConfigMap in namespace %s, but it does not contain a '%s' entry", common.VddkConfigMap, namespace, common.VddkConfigDataKey)
}
// returns the import image part of the endpoint string
func getRegistryImportImage(pvc *corev1.PersistentVolumeClaim) (string, error) {
ep, err := cc.GetEndpoint(pvc)
if err != nil {
return "", nil
}
if cc.IsImageStream(pvc) {
return ep, nil
}
url, err := url.Parse(ep)
if err != nil {
return "", errors.Errorf("illegal registry endpoint %s", ep)
}
return url.Host + url.Path, nil
}
// getValueFromAnnotation returns the value of an annotation
func getValueFromAnnotation(pvc *corev1.PersistentVolumeClaim, annotation string) string {
return pvc.Annotations[annotation]
}
// If this pod is going to transfer one checkpoint in a multi-stage import, attach the checkpoint name to the pod name so
// that each checkpoint gets a unique pod. That way each pod can be inspected using the retainAfterCompletion annotation.
func podNameWithCheckpoint(pvc *corev1.PersistentVolumeClaim) string {
if checkpoint := pvc.Annotations[cc.AnnCurrentCheckpoint]; checkpoint != "" {
return pvc.Name + "-checkpoint-" + checkpoint
}
return pvc.Name
}
func getImportPodNameFromPvc(pvc *corev1.PersistentVolumeClaim) string {
podName, ok := pvc.Annotations[cc.AnnImportPod]
if ok {
return podName
}
// fallback to legacy naming, in fact the following function is fully compatible with legacy
// name concatenation "importer-{pvc.Name}" if the name length is under the size limits,
return naming.GetResourceName(common.ImporterPodName, podNameWithCheckpoint(pvc))
}
func createImportPodNameFromPvc(pvc *corev1.PersistentVolumeClaim) string {
return naming.GetResourceName(common.ImporterPodName, podNameWithCheckpoint(pvc))
}
// createImporterPod creates and returns a pointer to a pod which is created based on the passed-in endpoint, secret
// name, and pvc. A nil secret means the endpoint credentials are not passed to the
// importer pod.
func createImporterPod(ctx context.Context, log logr.Logger, client client.Client, args *importerPodArgs, installerLabels map[string]string) (*corev1.Pod, error) {
var err error
args.podResourceRequirements, err = cc.GetDefaultPodResourceRequirements(client)
if err != nil {
return nil, err
}
args.imagePullSecrets, err = cc.GetImagePullSecrets(client)
if err != nil {
return nil, err
}
args.workloadNodePlacement, err = cc.GetWorkloadNodePlacement(ctx, client)
if err != nil {
return nil, err
}
if isRegistryNodeImport(args) {
args.importImage, err = getRegistryImportImage(args.pvc)
if err != nil {
return nil, err
}
setRegistryNodeImportEnvVars(args)
}
pod := makeImporterPodSpec(args)
util.SetRecommendedLabels(pod, installerLabels, "cdi-controller")
if err = client.Create(context.TODO(), pod); err != nil {
return nil, err
}
log.V(3).Info("importer pod created\n", "pod.Name", pod.Name, "pod.Namespace", pod.Namespace, "image name", args.image)
return pod, nil
}
// makeImporterPodSpec creates and return the importer pod spec based on the passed-in endpoint, secret and pvc.
func makeImporterPodSpec(args *importerPodArgs) *corev1.Pod {
// importer pod name contains the pvc name
podName := args.pvc.Annotations[cc.AnnImportPod]
pod := &corev1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: "Pod",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: podName,
Namespace: args.pvc.Namespace,
Annotations: map[string]string{
cc.AnnCreatedBy: "yes",
},
Labels: map[string]string{
common.CDILabelKey: common.CDILabelValue,
common.CDIComponentLabel: common.ImporterPodName,
common.PrometheusLabelKey: common.PrometheusLabelValue,
},
OwnerReferences: []metav1.OwnerReference{
{
APIVersion: "v1",
Kind: "PersistentVolumeClaim",
Name: args.pvc.Name,
UID: args.pvc.GetUID(),
BlockOwnerDeletion: ptr.To[bool](true),
Controller: ptr.To[bool](true),
},
},
},
Spec: corev1.PodSpec{
Containers: makeImporterContainerSpec(args),
InitContainers: makeImporterInitContainersSpec(args),
Volumes: makeImporterVolumeSpec(args),
RestartPolicy: corev1.RestartPolicyOnFailure,
NodeSelector: args.workloadNodePlacement.NodeSelector,
Tolerations: args.workloadNodePlacement.Tolerations,
Affinity: args.workloadNodePlacement.Affinity,
PriorityClassName: args.priorityClassName,
ImagePullSecrets: args.imagePullSecrets,
},
}
/**
FIXME: When registry source is ImageStream, if we set importer pod OwnerReference (to its pvc, like all other cases),
for some reason (OCP issue?) we get the following error:
Failed to pull image "imagestream-name": rpc error: code = Unknown
desc = Error reading manifest latest in docker.io/library/imagestream-name: errors:
denied: requested access to the resource is denied
unauthorized: authentication required
When we don't set pod OwnerReferences, all works well.
*/
if isRegistryNodeImport(args) && cc.IsImageStream(args.pvc) {
pod.OwnerReferences = nil
pod.Annotations[cc.AnnOpenShiftImageLookup] = "*"
}
cc.CopyAllowedAnnotations(args.pvc, pod)
cc.SetRestrictedSecurityContext(&pod.Spec)
// We explicitly define a NodeName for dynamically provisioned PVCs
// when the PVC is being handled by a populator (PVC')
cc.SetNodeNameIfPopulator(args.pvc, &pod.Spec)
return pod
}
func makeImporterContainerSpec(args *importerPodArgs) []corev1.Container {
containers := []corev1.Container{
{
Name: common.ImporterPodName,
Image: args.image,
ImagePullPolicy: corev1.PullPolicy(args.pullPolicy),
Args: []string{"-v=" + args.verbose},
Env: makeImportEnv(args.podEnvVar, getOwnerUID(args)),
Ports: []corev1.ContainerPort{
{
Name: "metrics",
ContainerPort: 8443,
Protocol: corev1.ProtocolTCP,
},
},
},
}
if cc.GetVolumeMode(args.pvc) == corev1.PersistentVolumeBlock {
containers[0].VolumeDevices = cc.AddVolumeDevices()
} else {
containers[0].VolumeMounts = cc.AddImportVolumeMounts()
}
if isRegistryNodeImport(args) {
containers = append(containers, corev1.Container{
Name: "server",
Image: args.importImage,
ImagePullPolicy: corev1.PullPolicy(args.pullPolicy),
Command: []string{"/shared/server", "-p", "8100", "-image-dir", "/disk", "-ready-file", "/shared/ready", "-done-file", "/shared/done"},
VolumeMounts: []corev1.VolumeMount{
{
MountPath: "/shared",
Name: "shared-volume",
},
},
})
containers[0].VolumeMounts = append(containers[0].VolumeMounts, corev1.VolumeMount{
MountPath: "/shared",
Name: "shared-volume",
})
}
if args.scratchPvcName != nil {
containers[0].VolumeMounts = append(containers[0].VolumeMounts, corev1.VolumeMount{
Name: cc.ScratchVolName,
MountPath: common.ScratchDataDir,
})
}
if args.vddkImageName != nil {
containers[0].VolumeMounts = append(containers[0].VolumeMounts, corev1.VolumeMount{
Name: "vddk-vol-mount",
MountPath: "/opt",
})