forked from nbryant42/rexray
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mod_csi_docker_bridge.go
1094 lines (913 loc) · 25.1 KB
/
mod_csi_docker_bridge.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 csi
import (
"bufio"
"fmt"
"os"
"path"
"path/filepath"
"strconv"
"strings"
"sync"
gofig "github.com/akutz/gofig/types"
"github.com/akutz/gotil"
"github.com/codedellemc/gocsi"
"github.com/codedellemc/gocsi/csi"
"github.com/codedellemc/gocsi/mount"
apictx "github.com/codedellemc/rexray/libstorage/api/context"
"github.com/codedellemc/rexray/libstorage/api/registry"
apitypes "github.com/codedellemc/rexray/libstorage/api/types"
dvol "github.com/docker/go-plugins-helpers/volume"
)
const (
dockerMountPath = "rexray.docker.mount.path"
rrCSINFSVolumes = "rexray.csi.nfs.volumes"
)
func init() {
registry.RegisterConfigReg(
"Docker Bridge",
func(ctx apitypes.Context, r gofig.ConfigRegistration) {
pathConfig := apictx.MustPathConfig(ctx)
r.Key(gofig.String,
"", "", "",
rrCSINFSVolumes,
"csiNFSVolumes",
"X_CSI_NFS_VOLUMES")
r.Key(gofig.String, "",
path.Join(pathConfig.Lib, "docker", "volumes"),
"", dockerMountPath)
})
}
var (
nfsVols string
nfsVolsL sync.Mutex
nfsVolsOnce sync.Once
)
type dockerBridge struct {
ctx apitypes.Context
config gofig.Config
cs *csiService
fsType string
mntPath string
byName map[string]csi.VolumeInfo
byNameRWL sync.RWMutex
}
func newDockerBridge(
ctx apitypes.Context,
config gofig.Config,
cs *csiService) (*dockerBridge, error) {
oldMntPath := config.GetString(apitypes.ConfigIgVolOpsMountPath)
oldDatName := config.GetString(apitypes.ConfigIgVolOpsMountRootPath)
newMntPath := config.GetString(dockerMountPath)
if err := os.MkdirAll(newMntPath, 0755); err != nil {
err := fmt.Errorf(
"newDockerBridge: create new mount dir failed: %v", err)
ctx.WithField("newMntPath", newMntPath).Error(err)
return nil, err
}
// Migrate volumes with data directories from the previous mount
// area to the new mount area.
if err := bindMountOldDataDirs(
ctx, oldMntPath, oldDatName, newMntPath); err != nil {
err := fmt.Errorf(
"newDockerBridge: bindMountOldDataDirs failed: %v", err)
ctx.WithFields(map[string]interface{}{
"oldMntPath": oldMntPath,
"oldDatName": oldDatName,
"newMntPath": newMntPath,
}).Error(err)
return nil, err
}
byName := map[string]csi.VolumeInfo{}
nfsVolsOnce.Do(func() {
nfsVols = path.Join(apictx.MustPathConfig(ctx).Lib, "csi-nfs-vol.map")
})
// Check to see if there are any CSI-NFS volume mappings.
if isCSINFS(cs.serviceType) {
if err := initNFSVolMap(ctx, config, nfsVols, byName); err != nil {
return nil, err
}
}
endpoint := &dockerBridge{
ctx: ctx,
config: config,
cs: cs,
fsType: config.GetString(apitypes.ConfigIgVolOpsCreateDefaultFsType),
mntPath: newMntPath,
byName: byName,
}
ctx.Info("docker-csi-bridge: created Docker bridge endpoint")
return endpoint, nil
}
func initNFSVolMap(
ctx apitypes.Context,
config gofig.Config,
nfsVolsFilePath string,
byName map[string]csi.VolumeInfo) (failed error) {
r := strings.NewReplacer("/", "-", `\`, "-")
splitNameHostExport := func(p string) {
nameHostExport := strings.SplitN(p, "=", 2)
if len(nameHostExport) != 2 {
return
}
hostExport := strings.SplitN(nameHostExport[1], ":", 2)
if len(hostExport) != 2 {
return
}
var (
nfsVolName = r.Replace(nameHostExport[0])
nfsHost = hostExport[0]
nfsExport = hostExport[1]
)
byName[nfsVolName] = csi.VolumeInfo{
Id: &csi.VolumeID{
Values: map[string]string{
"host": nfsHost,
"export": nfsExport,
},
},
Metadata: &csi.VolumeMetadata{
Values: map[string]string{
"name": nfsVolName,
},
},
}
ctx.WithFields(map[string]interface{}{
"nfsHost": nfsHost,
"nfsExport": nfsExport,
"nfsVolName": nfsVolName,
}).Debug("getNFSVolMap: cached prepopulated nfs volume")
}
// Check to see if there is a mappings file and use it, otherwise
// look at the cofiguration property.
if gotil.FileExists(nfsVolsFilePath) {
f, err := os.Open(nfsVolsFilePath)
if err != nil {
return fmt.Errorf("getNFSVolMap: failed to open map file: %v", err)
}
scanner := bufio.NewScanner(f)
for scanner.Scan() {
splitNameHostExport(scanner.Text())
}
} else {
// Check the config property.
list := config.GetStringSlice(rrCSINFSVolumes)
for _, l := range list {
splitNameHostExport(l)
}
}
return nil
}
func bindMountOldDataDirs(
ctx apitypes.Context,
oldMntPath, oldDatName, newMntPath string) error {
lf := map[string]interface{}{
"oldMntPath": oldMntPath,
"oldDatName": oldDatName,
"newMntPath": newMntPath,
}
// Create the glob pattern for the directories to return.
globPatt := path.Join(oldMntPath, "*", oldDatName)
// Get the directories to bind mount into the new location.
fileNames, err := filepath.Glob(globPatt)
if err != nil {
ctx.WithFields(lf).Errorf("bindMountOldDataDirs: glob failed: %v", err)
return err
}
for _, p := range fileNames {
lfp := ctx.WithField("oldVolDatDir", p).WithFields(lf)
lfp.Debug("bindMountOldDataDirs: processing")
st, err := os.Stat(p)
if err != nil {
lfp.Errorf("bindMountOldDataDirs: stat old path failed: %v", err)
return err
}
if !st.IsDir() {
lfp.Debug("bindMountOldDataDirs: skip non-dir")
continue
}
// Get the volume name and new mount path.
volName := path.Base(path.Dir(p))
newVolMntPath := path.Join(newMntPath, volName)
lfn := ctx.WithField("newVolMntPath", newVolMntPath).WithFields(lf)
if _, err := os.Stat(newVolMntPath); err != nil {
if os.IsNotExist(err) {
if err := os.MkdirAll(newVolMntPath, 0755); err != nil {
lfn.Errorf("bindMountOldDataDirs: mkdir success: %v", err)
continue
}
lfn.Debug("bindMountOldDataDirs: mkdir")
if err := mount.BindMount(p, newVolMntPath); err != nil {
lfn.Errorf("bindMountOldDataDirs: mount failed: %v", err)
continue
}
lfn.Debug("bindMountOldDataDirs: mount success")
continue
}
lfn.Errorf("bindMountOldDataDirs: stat new path failed: %v", err)
return err
}
}
return nil
}
func isCSINFS(serviceType string) bool {
return strings.EqualFold(serviceType, "csi-nfs")
}
func (d *dockerBridge) isCSINFS() bool {
return isCSINFS(d.cs.serviceType)
}
// cacheListResult caches the name-to-id mapping for a list of
// csi.VolumeInfo objects. This function replaces the existing list
// as the result of a ListVolumes RPC represents the most up-to-date
// view of the underlying storage platform
func (d *dockerBridge) cacheListResult(vols []*csi.VolumeInfo) {
d.byNameRWL.Lock()
defer d.byNameRWL.Unlock()
// If this is not CSI-NFS then replace the existing volume info objects.
if !d.isCSINFS() {
d.byName = map[string]csi.VolumeInfo{}
}
for _, vi := range vols {
if vi.Id == nil {
continue
}
name := d.getName(*vi)
if name == "" {
d.ctx.Debugf("docker-csi-bridge: failed to cache id/name: %v", vi)
continue
}
if _, ok := d.byName[name]; ok {
// volume with same name exists already!
d.ctx.Warnf("docker-csi-bridge: volume with name:%s already exists, skipping id/name: %v", name, vi)
continue
}
d.byName[name] = *vi
}
}
func (d *dockerBridge) getName(vi csi.VolumeInfo) string {
if vi.Metadata != nil {
if v := vi.Metadata.Values[mdKeyName]; v != "" {
return v
}
}
if strings.EqualFold(d.cs.serviceType, "libstorage") {
return ""
}
return vi.Id.Values[idKeyID]
}
func (d *dockerBridge) getVolumeInfo(name string) (csi.VolumeInfo, bool) {
d.byNameRWL.RLock()
defer d.byNameRWL.RUnlock()
vol, ok := d.byName[name]
return vol, ok
}
func (d *dockerBridge) setVolumeInfo(name string, volInfo csi.VolumeInfo) {
d.byNameRWL.Lock()
defer d.byNameRWL.Unlock()
d.byName[name] = volInfo
}
func (d *dockerBridge) delVolumeInfo(name string) {
d.byNameRWL.Lock()
defer d.byNameRWL.Unlock()
delete(d.byName, name)
}
var (
createParamCapabilities []*csi.VolumeCapability
csiVersion = &csi.Version{
Major: 0,
Minor: 0,
Patch: 0,
}
)
const (
idKeyID = "id"
mdKeyName = "name"
errCodeCreateVolAlreadyExits = int32(
csi.Error_CreateVolumeError_VOLUME_ALREADY_EXISTS)
errCodeDeleteVolDoesNotExit = int32(
csi.Error_DeleteVolumeError_VOLUME_DOES_NOT_EXIST)
errCodeCtrlPubVolDoesNotExit = int32(
csi.Error_ControllerPublishVolumeError_VOLUME_DOES_NOT_EXIST)
errCodeCtrlUnpubVolDoesNotExit = int32(
csi.Error_ControllerUnpublishVolumeError_VOLUME_DOES_NOT_EXIST)
errCodeNodePubVolDoesNotExit = int32(
csi.Error_NodePublishVolumeError_VOLUME_DOES_NOT_EXIST)
errCodeNodeUnpubVolDoesNotExit = int32(
csi.Error_NodeUnpublishVolumeError_VOLUME_DOES_NOT_EXIST)
)
func errIsVolAlreadyExists(err error) error {
terr, ok := err.(*gocsi.Error)
if !ok {
return err
}
if terr.FullMethod == gocsi.FMCreateVolume &&
terr.Code == errCodeCreateVolAlreadyExits {
return nil
}
return err
}
func errIsVolDoesNotExist(err error) error {
terr, ok := err.(*gocsi.Error)
if !ok {
return err
}
var exp int32 = -1
switch terr.FullMethod {
case gocsi.FMControllerPublishVolume:
exp = errCodeCtrlPubVolDoesNotExit
case gocsi.FMControllerUnpublishVolume:
exp = errCodeCtrlUnpubVolDoesNotExit
case gocsi.FMDeleteVolume:
exp = errCodeDeleteVolDoesNotExit
case gocsi.FMNodePublishVolume:
exp = errCodeNodePubVolDoesNotExit
case gocsi.FMNodeUnpublishVolume:
exp = errCodeNodeUnpubVolDoesNotExit
}
if terr.Code == exp {
return nil
}
return err
}
func errIsVolAttToNode(err error) error {
terr, ok := err.(*gocsi.Error)
if !ok {
return err
}
var exp int32 = -1
switch terr.FullMethod {
case gocsi.FMNodePublishVolume:
exp = errCodeNodePubVolDoesNotExit
case gocsi.FMNodeUnpublishVolume:
exp = errCodeNodeUnpubVolDoesNotExit
}
if terr.Code == exp {
return nil
}
return err
}
func (d *dockerBridge) Create(req *dvol.CreateRequest) error {
// If the service is CSI-NFS then create is handled differently.
if d.isCSINFS() {
var (
nfsHost string
nfsExport string
nfsVolName = req.Name
)
for k, v := range req.Options {
if strings.EqualFold(k, "host") {
nfsHost = v
} else if strings.EqualFold(k, "export") {
nfsExport = v
}
}
// Cache the mapping.
nfsVolsL.Lock()
defer nfsVolsL.Unlock()
f, err := os.OpenFile(nfsVols, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
if err != nil {
return err
}
defer f.Close()
_, err = fmt.Fprintf(f, "%s=%s:%s\n", nfsVolName, nfsHost, nfsExport)
if err != nil {
return err
}
d.byNameRWL.Lock()
defer d.byNameRWL.Unlock()
d.byName[nfsVolName] = csi.VolumeInfo{
Id: &csi.VolumeID{
Values: map[string]string{
"host": nfsHost,
"export": nfsExport,
},
},
Metadata: &csi.VolumeMetadata{
Values: map[string]string{
"name": nfsVolName,
},
},
}
return nil
}
// Create a new gRPC, CSI client.
c, err := d.cs.dial(d.ctx)
if err != nil {
d.ctx.Errorf("docker-csi-bridge: Create: client failure: %v", err)
return err
}
defer c.Close()
// Create a new CSI Controller client.
cc := csi.NewControllerClient(c)
// Check to see if the create option "size" is set.
var (
sizeGiB int64
sizeBytes uint64
)
for k, v := range req.Options {
if strings.EqualFold(k, "size") {
i, err := strconv.Atoi(v)
if err != nil {
return err
}
sizeGiB = int64(i)
// Translate size from GiB to bytes.
if sizeGiB > 0 {
sizeBytes = uint64(sizeGiB * 1024 * 1024 * 1024)
}
break
}
}
// Call the CSI CreateVolume RPC.
vol, err := gocsi.CreateVolume(
d.ctx, cc, csiVersion,
req.Name,
sizeBytes, sizeBytes,
createParamCapabilities,
req.Options)
// If there is an error, check to see if it is VOLUME_ALREADY_EXISTS.
// If it is then the function below will return a nil value, otherwise
// the original error is returned.
if err != nil {
return errIsVolAlreadyExists(err)
}
// Cache the volume.
d.setVolumeInfo(req.Name, *vol)
return nil
}
func (d *dockerBridge) List() (*dvol.ListResponse, error) {
volMap := map[string]csi.VolumeInfo{}
// If the service is CSI-NFS then grab volumes from cache, as that's
// the only place they will be
if d.isCSINFS() {
d.byNameRWL.RLock()
defer d.byNameRWL.RUnlock()
for name, vi := range d.byName {
d.ctx.WithField("volume", vi.Id.Values).WithField(
"name", name).Debug(
"docker-csi-bridge: List: found volume from cache")
volMap[name] = vi
}
return d.buildListResponse(volMap)
}
// Create a new gRPC, CSI client.
c, err := d.cs.dial(d.ctx)
if err != nil {
d.ctx.Errorf("docker-csi-bridge: List: client failure: %v", err)
return nil, err
}
defer c.Close()
// Create a new CSI Controller client.
cc := csi.NewControllerClient(c)
// Check if the CSI plugin supports ListVolumes
caps, err := gocsi.ControllerGetCapabilities(d.ctx, cc, csiVersion)
if err != nil {
return nil, err
}
if !controllerListVolsSupported(caps) {
return d.buildListResponse(volMap)
}
vols, _, err := gocsi.ListVolumes(d.ctx, cc, csiVersion, 0, "")
if err != nil {
d.ctx.Errorf("docker-csi-bridge: List: list volumes failed: %v", err)
return nil, err
}
// Cache the list results in order to keep the name-to-id mappings
// as up-to-date as possible.
go d.cacheListResult(vols)
for _, vi := range vols {
if vi.Id == nil || len(vi.Id.Values) == 0 {
d.ctx.Warn("docker-csi-bridge: List: skipped volume w missing id")
continue
}
name := d.getName(*vi)
if name == "" {
d.ctx.WithField("volume", vi).Warn(
"docker-csi-bridge: List: skipped volume w missing id and name")
continue
}
if _, ok := volMap[name]; ok {
d.ctx.WithField("volume", vi).Warn(
"docker-csi-bridge: List: skipped volume with duplicate name")
continue
}
//d.ctx.WithField("volume", vi.Id.Values).WithField(
// "name", name).Debug(
// "docker-csi-bridge: List: found new volume")
volMap[name] = *vi
}
return d.buildListResponse(volMap)
}
func (d *dockerBridge) buildListResponse(
volMap map[string]csi.VolumeInfo) (*dvol.ListResponse, error) {
var (
i int
res = &dvol.ListResponse{
Volumes: make([]*dvol.Volume, len(volMap)),
}
)
for name, vi := range volMap {
vol, err := d.toDockerVolume(name, vi)
if err != nil {
return nil, fmt.Errorf(
"docker-csi-bridge: buildListResponse: %s: %v", name, err)
}
res.Volumes[i] = vol
i++
}
return res, nil
}
func (d *dockerBridge) Get(req *dvol.GetRequest) (*dvol.GetResponse, error) {
volInfo, ok := d.getVolumeInfo(req.Name)
if !ok {
return nil, fmt.Errorf(
"docker-csi-bridge: Get: unknown volume: %s", req.Name)
}
vol, err := d.toDockerVolume(req.Name, volInfo)
if err != nil {
return nil, fmt.Errorf(
"docker-csi-bridge: Get: %s: %v", req.Name, err)
}
return &dvol.GetResponse{Volume: vol}, nil
}
// Remove the volume with the following steps:
//
// * Get volume from cache
// * DeleteVolume
// * Remove volume from cache
func (d *dockerBridge) Remove(req *dvol.RemoveRequest) (failed error) {
// If the service is CSI-NFS then remove is handled differently.
if d.isCSINFS() {
// Make sure the volume is removed from the cache if this function
// completes successfully.
defer func() {
if failed == nil {
d.delVolumeInfo(req.Name)
}
}()
// Remove the volume from the mappings file.
nfsVolsL.Lock()
defer nfsVolsL.Unlock()
var lines []string
if err := func() error {
f, err := os.Open(nfsVols)
if err != nil {
return err
}
defer f.Close()
scanner := bufio.NewScanner(f)
for scanner.Scan() {
l := scanner.Text()
nameHostExport := strings.SplitN(l, "=", 2)
if len(nameHostExport) != 2 {
continue
}
nfsVolName := nameHostExport[0]
if strings.EqualFold(req.Name, nfsVolName) {
continue
}
lines = append(lines, l)
}
return nil
}(); err != nil {
return err
}
f, err := os.Create(nfsVols)
if err != nil {
return err
}
defer f.Close()
for _, l := range lines {
if _, err := fmt.Fprintln(f, l); err != nil {
return err
}
}
return nil
}
vol, ok := d.getVolumeInfo(req.Name)
if !ok {
return fmt.Errorf(
"docker-csi-bridge: Remove: unknown volume: %s", req.Name)
}
// Make sure the volume is removed from the cache if this function
// completes successfully.
defer func() {
if failed == nil {
d.delVolumeInfo(req.Name)
}
}()
// Create a new gRPC, CSI client.
c, err := d.cs.dial(d.ctx)
if err != nil {
d.ctx.Errorf("docker-csi-bridge: Remove: client failure: %v", err)
return err
}
defer c.Close()
// Delete the volume using the Controller.
if err := gocsi.DeleteVolume(
d.ctx,
csi.NewControllerClient(c),
csiVersion, vol.Id, vol.Metadata); err != nil {
// If there is an error, check to see if it is VOLUME_DOES_NOT_EXIST.
// If it is then the function below will return a nil value, otherwise
// the original error is returned.
return errIsVolDoesNotExist(err)
}
return nil
}
func (d *dockerBridge) Path(req *dvol.PathRequest) (*dvol.PathResponse, error) {
if _, ok := d.getVolumeInfo(req.Name); !ok {
return nil, fmt.Errorf(
"docker-csi-bridge: Path: unknown volume: %s", req.Name)
}
targetPath, ok, err := d.getTargetPath(req.Name)
if err != nil {
return nil, err
}
if !ok {
return nil, fmt.Errorf(
"docker-csi-bridge: Path: volume not mounted: %s", req.Name)
}
return &dvol.PathResponse{Mountpoint: targetPath}, nil
}
var (
refCounter = map[string]int{}
refCounterL sync.Mutex
)
func incRefCountFor(targetPath string) {
refCounterL.Lock()
defer refCounterL.Unlock()
refCounter[targetPath] = refCounter[targetPath] + 1
}
func decRefCountFor(targetPath string) int {
refCounterL.Lock()
defer refCounterL.Unlock()
v, ok := refCounter[targetPath]
if ok && v > 0 {
v--
refCounter[targetPath] = v
}
return v
}
// Mount the volume with the following steps:
//
// * Get volume from cache
// * If volume does not exist, attempt to create it
// * Check to see if volume is already mounted
// * GetNodeID
// * ControllerPublishVolume
// * NodePublishVolume
// * Update cache with volume's new state
func (d *dockerBridge) Mount(
req *dvol.MountRequest) (res *dvol.MountResponse, failed error) {
// Create a new gRPC, CSI client.
c, err := d.cs.dial(d.ctx)
if err != nil {
d.ctx.Errorf("docker-csi-bridge: Mount: client failure: %v", err)
return nil, err
}
defer c.Close()
// Create a new CSI Controller client.
cc := csi.NewControllerClient(c)
// Get the volume from the cache.
vol, ok := d.getVolumeInfo(req.Name)
// If the volume is not cached then create it.
if !ok {
if d.isCSINFS() {
return nil, fmt.Errorf(
"docker-csi-bridge: Mount: cannot implicitly create NFS volume: %s",
req.Name)
}
newVol, err := gocsi.CreateVolume(
d.ctx, cc, csiVersion,
req.Name,
0, 0,
createParamCapabilities,
nil)
// If there's an error and it's not VOLUME_ALREADY_EXISTS then
// fail this mount attempt.
if errIsVolAlreadyExists(err) != nil {
return nil, err
}
vol = *newVol
}
// Define the targetPath.
targetPath, targetPathExists, err := d.getTargetPath(req.Name)
if err != nil {
return nil, err
}
// If this function exits without an error then increment
// the ref cache for the target path.
defer func() {
if failed == nil {
incRefCountFor(targetPath)
}
}()
// Create the target directory.
if !targetPathExists {
if err := os.MkdirAll(targetPath, 0755); err != nil {
d.ctx.WithField("targetPath", targetPath).Errorf(
"docker-csi-bridge: Mount: create target path failed: %v", err)
}
d.ctx.WithField("targetPath", targetPath).Debug(
"docker-csi-bridge: Mount: created target path")
}
// At this point it's known the volume is not mounted, so proceed
// to do so:
//
// * GetNodeID
// * ControllerPublishVolume
// * NodePublishVolume
// * Update cache with volume's new state
// Create a new CSI Node client.
nc := csi.NewNodeClient(c)
// Check if the CSI plugin supports ControllerPublishVolume
caps, err := gocsi.ControllerGetCapabilities(d.ctx, cc, csiVersion)
if err != nil {
return nil, err
}
var (
volCap *csi.VolumeCapability
pubInfo *csi.PublishVolumeInfo
)
// Create a new volume capability for publishing the volume
// via the Controller and Node.
if d.isCSINFS() {
volCap = newVolumeCapability("nfs")
} else {
volCap = newVolumeCapability(d.fsType)
}
if controllerPublishSupported(caps) {
// Next, publish the volume at the Controller level. To do that this
// Node's ID is required.
nodeID, err := gocsi.GetNodeID(d.ctx, nc, csiVersion)
if err != nil {
return nil, err
}
// Publish the volume via the Controller.
pubInfo, err = gocsi.ControllerPublishVolume(
d.ctx, cc, csiVersion,
vol.Id, vol.Metadata, nodeID,
volCap, false)
if err != nil {
return nil, err
}
}
// The target path of the volume is determined based on the
// volume's name and the Docker-CSI bridge root path for
// mounting volumes.
targetPath = path.Join(d.mntPath, req.Name)
// Publish the volume via the Node.
if err := gocsi.NodePublishVolume(
d.ctx, nc, csiVersion,
vol.Id, vol.Metadata,
pubInfo, targetPath,
volCap, false); err != nil {
return nil, err
}
return &dvol.MountResponse{Mountpoint: targetPath}, nil
}
func newVolumeCapability(
fsType string, flags ...string) *csi.VolumeCapability {
return &csi.VolumeCapability{
AccessMode: &csi.VolumeCapability_AccessMode{
Mode: csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER,
},
AccessType: &csi.VolumeCapability_Mount{
Mount: &csi.VolumeCapability_MountVolume{
FsType: fsType,
MountFlags: flags,
},
},
}
}
// Unmount the volume with the following steps:
//
// * Get volume from cache
// * Check to see if volume is already unmounted
// * GetNodeID
// * NodeUnpublishVolume
// * ControllerUnpublishVolume
// * Update cache with volume's new state
func (d *dockerBridge) Unmount(req *dvol.UnmountRequest) (failed error) {
vol, ok := d.getVolumeInfo(req.Name)
if !ok {
return fmt.Errorf(
"docker-csi-bridge: Unmount: unknown volume: %s", req.Name)
}
// Get the target path(s) to unpublish
targetPath, _, _ := d.getTargetPath(req.Name)
// Create a new gRPC, CSI client.
c, err := d.cs.dial(d.ctx)
if err != nil {
d.ctx.Errorf("docker-csi-bridge: Unmount: client failure: %v", err)
return err
}
defer c.Close()
// Create a new CSI Node client.
nc := csi.NewNodeClient(c)
// First, unpublish the volume from this Node.
if err := gocsi.NodeUnpublishVolume(
d.ctx,
nc,
csiVersion,
vol.Id,
vol.Metadata,
targetPath); err != nil {
// If there is an error, check to see if it is VOLUME_DOES_NOT_EXIST.
// If it is then the function below will return a nil value, otherwise
// the original error is returned.
return errIsVolDoesNotExist(err)
}
// Only progress further if there are no more Docker containers
// using this target path.
if v := decRefCountFor(targetPath); v > 0 {
return nil
}
// If the function completes successfully the remove the target path.
defer func() {
if failed == nil {
os.RemoveAll(targetPath)
}
}()
// Create a new CSI Controller client.
cc := csi.NewControllerClient(c)
// Check if the CSI plugin supports ControllerPublishVolume