generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 28
/
controller.go
823 lines (735 loc) · 22.9 KB
/
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
/*
Copyright 2021 The Kubernetes 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.
See the License for the specific language governing permissions and
limitations under the License.
*/
package populator_machinery
import (
"context"
"fmt"
"os"
"os/signal"
"strings"
"sync"
"syscall"
"time"
corev1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/json"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/dynamic/dynamicinformer"
"k8s.io/client-go/dynamic/dynamiclister"
kubeinformers "k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme"
typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
corelisters "k8s.io/client-go/listers/core/v1"
storagelisters "k8s.io/client-go/listers/storage/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
"k8s.io/component-helpers/storage/volume"
"k8s.io/klog/v2"
)
const (
populatorContainerName = "populate"
populatorPodPrefix = "populate"
populatorPodVolumeName = "target"
populatorPvcPrefix = "prime"
populatedFromAnnoSuffix = "populated-from"
pvcFinalizerSuffix = "populate-target-protection"
annSelectedNode = "volume.kubernetes.io/selected-node"
controllerNameSuffix = "populator"
reasonPodCreationError = "PopulatorCreationError"
reasonPodCreationSuccess = "PopulatorCreated"
reasonPodFailed = "PopulatorFailed"
reasonPodFinished = "PopulatorFinished"
reasonPVCCreationError = "PopulatorPVCCreationError"
)
type empty struct{}
type stringSet struct {
set map[string]empty
}
type controller struct {
populatorNamespace string
populatedFromAnno string
pvcFinalizer string
kubeClient kubernetes.Interface
imageName string
devicePath string
mountPath string
pvcLister corelisters.PersistentVolumeClaimLister
pvcSynced cache.InformerSynced
pvLister corelisters.PersistentVolumeLister
pvSynced cache.InformerSynced
podLister corelisters.PodLister
podSynced cache.InformerSynced
scLister storagelisters.StorageClassLister
scSynced cache.InformerSynced
unstLister dynamiclister.Lister
unstSynced cache.InformerSynced
mu sync.Mutex
notifyMap map[string]*stringSet
cleanupMap map[string]*stringSet
workqueue workqueue.RateLimitingInterface
populatorArgs func(bool, *unstructured.Unstructured) ([]string, error)
gk schema.GroupKind
metrics *metricsManager
recorder record.EventRecorder
}
func RunController(masterURL, kubeconfig, imageName, httpEndpoint, metricsPath, namespace, prefix string,
gk schema.GroupKind, gvr schema.GroupVersionResource, mountPath, devicePath string,
populatorArgs func(bool, *unstructured.Unstructured) ([]string, error),
) {
klog.Infof("Starting populator controller for %s", gk)
stopCh := make(chan struct{})
sigCh := make(chan os.Signal, 2)
signal.Notify(sigCh, os.Interrupt, syscall.SIGTERM)
go func() {
<-sigCh
close(stopCh)
<-sigCh
os.Exit(1) // second signal. Exit directly.
}()
cfg, err := clientcmd.BuildConfigFromFlags(masterURL, kubeconfig)
if err != nil {
klog.Fatalf("Failed to create config: %v", err)
}
kubeClient, err := kubernetes.NewForConfig(cfg)
if err != nil {
klog.Fatalf("Failed to create client: %v", err)
}
dynClient, err := dynamic.NewForConfig(cfg)
if err != nil {
klog.Fatalf("Failed to create dynamic client: %v", err)
}
kubeInformerFactory := kubeinformers.NewSharedInformerFactory(kubeClient, time.Second*30)
dynInformerFactory := dynamicinformer.NewDynamicSharedInformerFactory(dynClient, time.Second*30)
pvcInformer := kubeInformerFactory.Core().V1().PersistentVolumeClaims()
pvInformer := kubeInformerFactory.Core().V1().PersistentVolumes()
podInformer := kubeInformerFactory.Core().V1().Pods()
scInformer := kubeInformerFactory.Storage().V1().StorageClasses()
unstInformer := dynInformerFactory.ForResource(gvr).Informer()
c := &controller{
kubeClient: kubeClient,
imageName: imageName,
populatorNamespace: namespace,
devicePath: devicePath,
mountPath: mountPath,
populatedFromAnno: prefix + "/" + populatedFromAnnoSuffix,
pvcFinalizer: prefix + "/" + pvcFinalizerSuffix,
pvcLister: pvcInformer.Lister(),
pvcSynced: pvcInformer.Informer().HasSynced,
pvLister: pvInformer.Lister(),
pvSynced: pvInformer.Informer().HasSynced,
podLister: podInformer.Lister(),
podSynced: podInformer.Informer().HasSynced,
scLister: scInformer.Lister(),
scSynced: scInformer.Informer().HasSynced,
unstLister: dynamiclister.New(unstInformer.GetIndexer(), gvr),
unstSynced: unstInformer.HasSynced,
notifyMap: make(map[string]*stringSet),
cleanupMap: make(map[string]*stringSet),
workqueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
populatorArgs: populatorArgs,
gk: gk,
metrics: initMetrics(),
recorder: getRecorder(kubeClient, prefix+"-"+controllerNameSuffix),
}
c.metrics.startListener(httpEndpoint, metricsPath)
defer c.metrics.stopListener()
pvcInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: c.handlePVC,
UpdateFunc: func(old, new interface{}) {
newPvc := new.(*corev1.PersistentVolumeClaim)
oldPvc := old.(*corev1.PersistentVolumeClaim)
if newPvc.ResourceVersion == oldPvc.ResourceVersion {
return
}
c.handlePVC(new)
},
DeleteFunc: c.handlePVC,
})
pvInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: c.handlePV,
UpdateFunc: func(old, new interface{}) {
newPv := new.(*corev1.PersistentVolume)
oldPv := old.(*corev1.PersistentVolume)
if newPv.ResourceVersion == oldPv.ResourceVersion {
return
}
c.handlePV(new)
},
DeleteFunc: c.handlePV,
})
podInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: c.handlePod,
UpdateFunc: func(old, new interface{}) {
newPod := new.(*corev1.Pod)
oldPod := old.(*corev1.Pod)
if newPod.ResourceVersion == oldPod.ResourceVersion {
return
}
c.handlePod(new)
},
DeleteFunc: c.handlePod,
})
scInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: c.handleSC,
UpdateFunc: func(old, new interface{}) {
newSc := new.(*storagev1.StorageClass)
oldSc := old.(*storagev1.StorageClass)
if newSc.ResourceVersion == oldSc.ResourceVersion {
return
}
c.handleSC(new)
},
DeleteFunc: c.handleSC,
})
unstInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: c.handleUnstructured,
UpdateFunc: func(old, new interface{}) {
newUnstructured := new.(*unstructured.Unstructured)
oldUnstructured := old.(*unstructured.Unstructured)
if newUnstructured.GetResourceVersion() == oldUnstructured.GetResourceVersion() {
return
}
c.handleUnstructured(new)
},
DeleteFunc: c.handleUnstructured,
})
kubeInformerFactory.Start(stopCh)
dynInformerFactory.Start(stopCh)
if err = c.run(stopCh); err != nil {
klog.Fatalf("Failed to run controller: %v", err)
}
}
func getRecorder(kubeClient kubernetes.Interface, controllerName string) record.EventRecorder {
eventBroadcaster := record.NewBroadcaster()
eventBroadcaster.StartStructuredLogging(0)
eventBroadcaster.StartRecordingToSink(&typedcorev1.EventSinkImpl{Interface: kubeClient.CoreV1().Events("")})
recorder := eventBroadcaster.NewRecorder(scheme.Scheme, corev1.EventSource{Component: controllerName})
return recorder
}
func (c *controller) addNotification(keyToCall, objType, namespace, name string) {
var key string
if 0 == len(namespace) {
key = objType + "/" + name
} else {
key = objType + "/" + namespace + "/" + name
}
c.mu.Lock()
defer c.mu.Unlock()
s := c.notifyMap[key]
if s == nil {
s = &stringSet{make(map[string]empty)}
c.notifyMap[key] = s
}
s.set[keyToCall] = empty{}
s = c.cleanupMap[keyToCall]
if s == nil {
s = &stringSet{make(map[string]empty)}
c.cleanupMap[keyToCall] = s
}
s.set[key] = empty{}
}
func (c *controller) cleanupNotifications(keyToCall string) {
c.mu.Lock()
defer c.mu.Unlock()
s := c.cleanupMap[keyToCall]
if s == nil {
return
}
for key := range s.set {
t := c.notifyMap[key]
if t == nil {
continue
}
delete(t.set, keyToCall)
if 0 == len(t.set) {
delete(c.notifyMap, key)
}
}
}
func translateObject(obj interface{}) metav1.Object {
var object metav1.Object
var ok bool
if object, ok = obj.(metav1.Object); !ok {
tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
if !ok {
utilruntime.HandleError(fmt.Errorf("error decoding object, invalid type"))
return nil
}
object, ok = tombstone.Obj.(metav1.Object)
if !ok {
utilruntime.HandleError(fmt.Errorf("error decoding object tombstone, invalid type"))
return nil
}
}
return object
}
func (c *controller) handleMapped(obj interface{}, objType string) {
object := translateObject(obj)
if object == nil {
return
}
var key string
if len(object.GetNamespace()) == 0 {
key = objType + "/" + object.GetName()
} else {
key = objType + "/" + object.GetNamespace() + "/" + object.GetName()
}
c.mu.Lock()
defer c.mu.Unlock()
if s, ok := c.notifyMap[key]; ok {
for k := range s.set {
c.workqueue.Add(k)
}
}
}
func (c *controller) handlePVC(obj interface{}) {
c.handleMapped(obj, "pvc")
object := translateObject(obj)
if object == nil {
return
}
if c.populatorNamespace != object.GetNamespace() {
c.workqueue.Add("pvc/" + object.GetNamespace() + "/" + object.GetName())
}
}
func (c *controller) handlePV(obj interface{}) {
c.handleMapped(obj, "pv")
}
func (c *controller) handlePod(obj interface{}) {
c.handleMapped(obj, "pod")
}
func (c *controller) handleSC(obj interface{}) {
c.handleMapped(obj, "sc")
}
func (c *controller) handleUnstructured(obj interface{}) {
c.handleMapped(obj, "unstructured")
}
func (c *controller) run(stopCh <-chan struct{}) error {
defer utilruntime.HandleCrash()
defer c.workqueue.ShutDown()
ok := cache.WaitForCacheSync(stopCh, c.pvcSynced, c.pvSynced, c.podSynced, c.scSynced, c.unstSynced)
if !ok {
return fmt.Errorf("failed to wait for caches to sync")
}
go wait.Until(c.runWorker, time.Second, stopCh)
<-stopCh
return nil
}
func (c *controller) runWorker() {
processNextWorkItem := func(obj interface{}) error {
defer c.workqueue.Done(obj)
var key string
var ok bool
if key, ok = obj.(string); !ok {
c.workqueue.Forget(obj)
utilruntime.HandleError(fmt.Errorf("expected string in workqueue but got %#v", obj))
return nil
}
var err error
parts := strings.Split(key, "/")
switch parts[0] {
case "pvc":
if len(parts) != 3 {
utilruntime.HandleError(fmt.Errorf("invalid resource key: %s", key))
return nil
}
err = c.syncPvc(context.TODO(), key, parts[1], parts[2])
default:
utilruntime.HandleError(fmt.Errorf("invalid resource key: %s", key))
return nil
}
if err != nil {
c.workqueue.AddRateLimited(key)
return fmt.Errorf("error syncing '%s': %s, requeuing", key, err.Error())
}
c.workqueue.Forget(obj)
return nil
}
for {
obj, shutdown := c.workqueue.Get()
if shutdown {
return
}
err := processNextWorkItem(obj)
if err != nil {
utilruntime.HandleError(err)
}
}
}
func (c *controller) syncPvc(ctx context.Context, key, pvcNamespace, pvcName string) error {
if c.populatorNamespace == pvcNamespace {
// Ignore PVCs in our own working namespace
return nil
}
var err error
var pvc *corev1.PersistentVolumeClaim
pvc, err = c.pvcLister.PersistentVolumeClaims(pvcNamespace).Get(pvcName)
if err != nil {
if errors.IsNotFound(err) {
utilruntime.HandleError(fmt.Errorf("pvc '%s' in work queue no longer exists", key))
return nil
}
return err
}
dataSourceRef := pvc.Spec.DataSourceRef
if dataSourceRef == nil {
// Ignore PVCs without a datasource
return nil
}
if c.gk.Group != *dataSourceRef.APIGroup || c.gk.Kind != dataSourceRef.Kind || "" == dataSourceRef.Name {
// Ignore PVCs that aren't for this populator to handle
return nil
}
var unstructured *unstructured.Unstructured
unstructured, err = c.unstLister.Namespace(pvc.Namespace).Get(dataSourceRef.Name)
if err != nil {
if !errors.IsNotFound(err) {
return err
}
c.addNotification(key, "unstructured", pvc.Namespace, dataSourceRef.Name)
// We'll get called again later when the data source exists
return nil
}
var waitForFirstConsumer bool
var nodeName string
if pvc.Spec.StorageClassName != nil {
storageClassName := *pvc.Spec.StorageClassName
var storageClass *storagev1.StorageClass
storageClass, err = c.scLister.Get(storageClassName)
if err != nil {
if !errors.IsNotFound(err) {
return err
}
c.addNotification(key, "sc", "", storageClassName)
// We'll get called again later when the storage class exists
return nil
}
if err := c.checkIntreeStorageClass(pvc, storageClass); err != nil {
klog.V(2).Infof("Ignoring PVC %s/%s: %s", pvcNamespace, pvcName, err)
return nil
}
if storageClass.VolumeBindingMode != nil && storagev1.VolumeBindingWaitForFirstConsumer == *storageClass.VolumeBindingMode {
waitForFirstConsumer = true
nodeName = pvc.Annotations[annSelectedNode]
if nodeName == "" {
// Wait for the PVC to get a node name before continuing
return nil
}
}
}
// Look for the populator pod
podName := fmt.Sprintf("%s-%s", populatorPodPrefix, pvc.UID)
c.addNotification(key, "pod", c.populatorNamespace, podName)
var pod *corev1.Pod
pod, err = c.podLister.Pods(c.populatorNamespace).Get(podName)
if err != nil {
if !errors.IsNotFound(err) {
return err
}
}
// Look for PVC'
pvcPrimeName := fmt.Sprintf("%s-%s", populatorPvcPrefix, pvc.UID)
c.addNotification(key, "pvc", c.populatorNamespace, pvcPrimeName)
var pvcPrime *corev1.PersistentVolumeClaim
pvcPrime, err = c.pvcLister.PersistentVolumeClaims(c.populatorNamespace).Get(pvcPrimeName)
if err != nil {
if !errors.IsNotFound(err) {
return err
}
}
// *** Here is the first place we start to create/modify objects ***
// If the PVC is unbound, we need to perform the population
if "" == pvc.Spec.VolumeName {
// Ensure the PVC has a finalizer on it so we can clean up the stuff we create
err = c.ensureFinalizer(ctx, pvc, c.pvcFinalizer, true)
if err != nil {
return err
}
// Record start time for populator metric
c.metrics.operationStart(pvc.UID)
// If the pod doesn't exist yet, create it
if pod == nil {
var rawBlock bool
if nil != pvc.Spec.VolumeMode && corev1.PersistentVolumeBlock == *pvc.Spec.VolumeMode {
rawBlock = true
}
// Calculate the args for the populator pod
var args []string
args, err = c.populatorArgs(rawBlock, unstructured)
if err != nil {
return err
}
// Make the pod
pod = &corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: podName,
Namespace: c.populatorNamespace,
},
Spec: makePopulatePodSpec(pvcPrimeName),
}
pod.Spec.Volumes[0].VolumeSource.PersistentVolumeClaim.ClaimName = pvcPrimeName
con := &pod.Spec.Containers[0]
con.Image = c.imageName
con.Args = args
if rawBlock {
con.VolumeDevices = []corev1.VolumeDevice{
{
Name: populatorPodVolumeName,
DevicePath: c.devicePath,
},
}
} else {
con.VolumeMounts = []corev1.VolumeMount{
{
Name: populatorPodVolumeName,
MountPath: c.mountPath,
},
}
}
if waitForFirstConsumer {
pod.Spec.NodeName = nodeName
}
_, err = c.kubeClient.CoreV1().Pods(c.populatorNamespace).Create(ctx, pod, metav1.CreateOptions{})
if err != nil {
c.recorder.Eventf(pvc, corev1.EventTypeWarning, reasonPodCreationError, "Failed to create populator pod: %s", err)
return err
}
c.recorder.Eventf(pvc, corev1.EventTypeNormal, reasonPodCreationSuccess, "Populator started")
// If PVC' doesn't exist yet, create it
if pvcPrime == nil {
pvcPrime = &corev1.PersistentVolumeClaim{
ObjectMeta: metav1.ObjectMeta{
Name: pvcPrimeName,
Namespace: c.populatorNamespace,
},
Spec: corev1.PersistentVolumeClaimSpec{
AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
Resources: pvc.Spec.Resources,
StorageClassName: pvc.Spec.StorageClassName,
VolumeMode: pvc.Spec.VolumeMode,
},
}
if waitForFirstConsumer {
pvcPrime.Annotations = map[string]string{
annSelectedNode: nodeName,
}
}
_, err = c.kubeClient.CoreV1().PersistentVolumeClaims(c.populatorNamespace).Create(ctx, pvcPrime, metav1.CreateOptions{})
if err != nil {
c.recorder.Eventf(pvc, corev1.EventTypeWarning, reasonPVCCreationError, "Failed to create populator PVC: %s", err)
return err
}
}
// We'll get called again later when the pod exists
return nil
}
if corev1.PodSucceeded != pod.Status.Phase {
if corev1.PodFailed == pod.Status.Phase {
c.recorder.Eventf(pvc, corev1.EventTypeWarning, reasonPodFailed, "Populator failed: %s", pod.Status.Message)
// Delete failed pods so we can try again
err = c.kubeClient.CoreV1().Pods(c.populatorNamespace).Delete(ctx, pod.Name, metav1.DeleteOptions{})
if err != nil {
return err
}
}
// We'll get called again later when the pod succeeds
return nil
}
// This would be bad
if pvcPrime == nil {
return fmt.Errorf("Failed to find PVC for populator pod")
}
// Get PV
var pv *corev1.PersistentVolume
c.addNotification(key, "pv", "", pvcPrime.Spec.VolumeName)
pv, err = c.kubeClient.CoreV1().PersistentVolumes().Get(ctx, pvcPrime.Spec.VolumeName, metav1.GetOptions{})
if err != nil {
if !errors.IsNotFound(err) {
return err
}
// We'll get called again later when the PV exists
return nil
}
// Examine the claimref for the PV and see if it's bound to the correct PVC
claimRef := pv.Spec.ClaimRef
if claimRef.Name != pvc.Name || claimRef.Namespace != pvc.Namespace || claimRef.UID != pvc.UID {
// Make new PV with strategic patch values to perform the PV rebind
patchPv := corev1.PersistentVolume{
ObjectMeta: metav1.ObjectMeta{
Name: pv.Name,
Annotations: map[string]string{},
},
Spec: corev1.PersistentVolumeSpec{
ClaimRef: &corev1.ObjectReference{
Namespace: pvc.Namespace,
Name: pvc.Name,
UID: pvc.UID,
ResourceVersion: pvc.ResourceVersion,
},
},
}
patchPv.Annotations[c.populatedFromAnno] = pvc.Namespace + "/" + dataSourceRef.Name
var patchData []byte
patchData, err = json.Marshal(patchPv)
if err != nil {
return err
}
_, err = c.kubeClient.CoreV1().PersistentVolumes().Patch(ctx, pv.Name, types.StrategicMergePatchType,
patchData, metav1.PatchOptions{})
if err != nil {
return err
}
// Don't start cleaning up yet -- we need to bind controller to acknowledge
// the switch
return nil
}
}
// Wait for the bind controller to rebind the PV
if pvcPrime != nil {
if corev1.ClaimLost != pvcPrime.Status.Phase {
return nil
}
}
// Record start time for populator metric
c.metrics.recordMetrics(pvc.UID, "success")
// *** At this point the volume population is done and we're just cleaning up ***
c.recorder.Eventf(pvc, corev1.EventTypeNormal, reasonPodFinished, "Populator finished")
// If the pod still exists, delete it
if pod != nil {
err = c.kubeClient.CoreV1().Pods(c.populatorNamespace).Delete(ctx, pod.Name, metav1.DeleteOptions{})
if err != nil {
return err
}
}
// If PVC' still exists, delete it
if pvcPrime != nil {
err = c.kubeClient.CoreV1().PersistentVolumeClaims(c.populatorNamespace).Delete(ctx, pvcPrime.Name, metav1.DeleteOptions{})
if err != nil {
return err
}
}
// Make sure the PVC finalizer is gone
err = c.ensureFinalizer(ctx, pvc, c.pvcFinalizer, false)
if err != nil {
return err
}
// Clean up our internal callback maps
c.cleanupNotifications(key)
return nil
}
func makePopulatePodSpec(pvcPrimeName string) corev1.PodSpec {
return corev1.PodSpec{
Containers: []corev1.Container{
{
Name: populatorContainerName,
ImagePullPolicy: corev1.PullIfNotPresent,
},
},
RestartPolicy: corev1.RestartPolicyNever,
Volumes: []corev1.Volume{
{
Name: populatorPodVolumeName,
VolumeSource: corev1.VolumeSource{
PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
ClaimName: pvcPrimeName,
},
},
},
},
}
}
func (c *controller) ensureFinalizer(ctx context.Context, pvc *corev1.PersistentVolumeClaim, finalizer string, want bool) error {
finalizers := pvc.GetFinalizers()
found := false
foundIdx := -1
for i, v := range finalizers {
if finalizer == v {
found = true
foundIdx = i
break
}
}
if found == want {
// Nothing to do in this case
return nil
}
type patchOp struct {
Op string `json:"op"`
Path string `json:"path"`
Value interface{} `json:"value,omitempty"`
}
var patch []patchOp
if want {
// Add the finalizer to the end of the list
patch = []patchOp{
{
Op: "test",
Path: "/metadata/finalizers",
Value: finalizers,
},
{
Op: "add",
Path: "/metadata/finalizers/-",
Value: finalizer,
},
}
} else {
// Remove the finalizer from the list index where it was found
path := fmt.Sprintf("/metadata/finalizers/%d", foundIdx)
patch = []patchOp{
{
Op: "test",
Path: path,
Value: finalizer,
},
{
Op: "remove",
Path: path,
},
}
}
data, err := json.Marshal(patch)
if err != nil {
return err
}
_, err = c.kubeClient.CoreV1().PersistentVolumeClaims(pvc.Namespace).Patch(ctx, pvc.Name, types.JSONPatchType,
data, metav1.PatchOptions{})
if err != nil {
return err
}
return nil
}
func (c *controller) checkIntreeStorageClass(pvc *corev1.PersistentVolumeClaim, sc *storagev1.StorageClass) error {
if !strings.HasPrefix(sc.Provisioner, "kubernetes.io/") {
// This is not an in-tree StorageClass
return nil
}
if pvc.Annotations != nil {
if migrated := pvc.Annotations[volume.AnnMigratedTo]; migrated != "" {
// The PVC is migrated to CSI
return nil
}
}
// The SC is in-tree & PVC is not migrated
return fmt.Errorf("in-tree volume volume plugin %q cannot use volume populator", sc.Provisioner)
}