-
Notifications
You must be signed in to change notification settings - Fork 103
/
zfs_util.go
943 lines (783 loc) · 25.8 KB
/
zfs_util.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
/*
Copyright 2017 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 zfs
import (
"bufio"
"os/exec"
"path/filepath"
"strconv"
"fmt"
"os"
"time"
"strings"
"github.com/openebs/lib-csi/pkg/btrfs"
"github.com/openebs/lib-csi/pkg/xfs"
apis "github.com/openebs/zfs-localpv/pkg/apis/openebs.io/zfs/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/resource"
"k8s.io/klog"
)
// zfs related constants
const (
ZFSDevPath = "/dev/zvol/"
FSTypeZFS = "zfs"
)
// zfs command related constants
const (
ZFSVolCmd = "zfs"
ZFSCreateArg = "create"
ZFSCloneArg = "clone"
ZFSDestroyArg = "destroy"
ZFSSetArg = "set"
ZFSGetArg = "get"
ZFSListArg = "list"
ZFSSnapshotArg = "snapshot"
ZFSSendArg = "send"
ZFSRecvArg = "recv"
)
// constants to define volume type
const (
VolTypeDataset = "DATASET"
VolTypeZVol = "ZVOL"
)
// PropertyChanged return whether volume property is changed
func PropertyChanged(oldVol *apis.ZFSVolume, newVol *apis.ZFSVolume) bool {
if oldVol.Spec.VolumeType == VolTypeDataset &&
newVol.Spec.VolumeType == VolTypeDataset &&
oldVol.Spec.RecordSize != newVol.Spec.RecordSize {
return true
}
return oldVol.Spec.Compression != newVol.Spec.Compression ||
oldVol.Spec.Dedup != newVol.Spec.Dedup
}
// GetVolumeType returns the volume type
// whether it is a zvol or dataset
func GetVolumeType(fstype string) string {
/*
* if fstype is provided as zfs then a zfs dataset will be created
* otherwise a zvol will be created
*/
switch fstype {
case FSTypeZFS:
return VolTypeDataset
default:
return VolTypeZVol
}
}
// builldZvolCreateArgs returns zfs create command for zvol along with attributes as a string array
func buildZvolCreateArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSCreateArg)
if vol.Spec.ThinProvision == "yes" {
ZFSVolArg = append(ZFSVolArg, "-s")
}
if len(vol.Spec.Capacity) != 0 {
ZFSVolArg = append(ZFSVolArg, "-V", vol.Spec.Capacity)
}
if len(vol.Spec.VolBlockSize) != 0 {
ZFSVolArg = append(ZFSVolArg, "-b", vol.Spec.VolBlockSize)
}
if len(vol.Spec.Dedup) != 0 {
dedupProperty := "dedup=" + vol.Spec.Dedup
ZFSVolArg = append(ZFSVolArg, "-o", dedupProperty)
}
if len(vol.Spec.Compression) != 0 {
compressionProperty := "compression=" + vol.Spec.Compression
ZFSVolArg = append(ZFSVolArg, "-o", compressionProperty)
}
if len(vol.Spec.Encryption) != 0 {
encryptionProperty := "encryption=" + vol.Spec.Encryption
ZFSVolArg = append(ZFSVolArg, "-o", encryptionProperty)
}
if len(vol.Spec.KeyLocation) != 0 {
keyLocation := "keylocation=" + vol.Spec.KeyLocation
ZFSVolArg = append(ZFSVolArg, "-o", keyLocation)
}
if len(vol.Spec.KeyFormat) != 0 {
keyFormat := "keyformat=" + vol.Spec.KeyFormat
ZFSVolArg = append(ZFSVolArg, "-o", keyFormat)
}
ZFSVolArg = append(ZFSVolArg, volume)
return ZFSVolArg
}
// builldCloneCreateArgs returns zfs clone commands for zfs volume/dataset along with attributes as a string array
func buildCloneCreateArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
snapshot := vol.Spec.PoolName + "/" + vol.Spec.SnapName
ZFSVolArg = append(ZFSVolArg, ZFSCloneArg)
if vol.Spec.VolumeType == VolTypeDataset {
if len(vol.Spec.Capacity) != 0 {
quotaProperty := "quota=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, "-o", quotaProperty)
}
if len(vol.Spec.RecordSize) != 0 {
recordsizeProperty := "recordsize=" + vol.Spec.RecordSize
ZFSVolArg = append(ZFSVolArg, "-o", recordsizeProperty)
}
if vol.Spec.ThinProvision == "no" {
reservationProperty := "reservation=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, "-o", reservationProperty)
}
ZFSVolArg = append(ZFSVolArg, "-o", "mountpoint=legacy")
}
if len(vol.Spec.Dedup) != 0 {
dedupProperty := "dedup=" + vol.Spec.Dedup
ZFSVolArg = append(ZFSVolArg, "-o", dedupProperty)
}
if len(vol.Spec.Compression) != 0 {
compressionProperty := "compression=" + vol.Spec.Compression
ZFSVolArg = append(ZFSVolArg, "-o", compressionProperty)
}
if len(vol.Spec.Encryption) != 0 {
encryptionProperty := "encryption=" + vol.Spec.Encryption
ZFSVolArg = append(ZFSVolArg, "-o", encryptionProperty)
}
if len(vol.Spec.KeyLocation) != 0 {
keyLocation := "keylocation=" + vol.Spec.KeyLocation
ZFSVolArg = append(ZFSVolArg, "-o", keyLocation)
}
if len(vol.Spec.KeyFormat) != 0 {
keyFormat := "keyformat=" + vol.Spec.KeyFormat
ZFSVolArg = append(ZFSVolArg, "-o", keyFormat)
}
ZFSVolArg = append(ZFSVolArg, snapshot, volume)
return ZFSVolArg
}
// buildZFSSnapCreateArgs returns zfs create command for zfs snapshot
// zfs snapshot <poolname>/<volname>@<snapname>
func buildZFSSnapCreateArgs(snap *apis.ZFSSnapshot) []string {
var ZFSSnapArg []string
volname := snap.Labels[ZFSVolKey]
snapDataset := snap.Spec.PoolName + "/" + volname + "@" + snap.Name
ZFSSnapArg = append(ZFSSnapArg, ZFSSnapshotArg, snapDataset)
return ZFSSnapArg
}
// builldZFSSnapDestroyArgs returns zfs destroy command for zfs snapshot
// zfs destroy <poolname>/<volname>@<snapname>
func buildZFSSnapDestroyArgs(snap *apis.ZFSSnapshot) []string {
var ZFSSnapArg []string
volname := snap.Labels[ZFSVolKey]
snapDataset := snap.Spec.PoolName + "/" + volname + "@" + snap.Name
ZFSSnapArg = append(ZFSSnapArg, ZFSDestroyArg, snapDataset)
return ZFSSnapArg
}
// builldDatasetCreateArgs returns zfs create command for dataset along with attributes as a string array
func buildDatasetCreateArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSCreateArg)
if len(vol.Spec.Capacity) != 0 {
quotaProperty := "quota=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, "-o", quotaProperty)
}
if len(vol.Spec.RecordSize) != 0 {
recordsizeProperty := "recordsize=" + vol.Spec.RecordSize
ZFSVolArg = append(ZFSVolArg, "-o", recordsizeProperty)
}
if vol.Spec.ThinProvision == "no" {
reservationProperty := "reservation=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, "-o", reservationProperty)
}
if len(vol.Spec.Dedup) != 0 {
dedupProperty := "dedup=" + vol.Spec.Dedup
ZFSVolArg = append(ZFSVolArg, "-o", dedupProperty)
}
if len(vol.Spec.Compression) != 0 {
compressionProperty := "compression=" + vol.Spec.Compression
ZFSVolArg = append(ZFSVolArg, "-o", compressionProperty)
}
if len(vol.Spec.Encryption) != 0 {
encryptionProperty := "encryption=" + vol.Spec.Encryption
ZFSVolArg = append(ZFSVolArg, "-o", encryptionProperty)
}
if len(vol.Spec.KeyLocation) != 0 {
keyLocation := "keylocation=" + vol.Spec.KeyLocation
ZFSVolArg = append(ZFSVolArg, "-o", keyLocation)
}
if len(vol.Spec.KeyFormat) != 0 {
keyFormat := "keyformat=" + vol.Spec.KeyFormat
ZFSVolArg = append(ZFSVolArg, "-o", keyFormat)
}
// set the mount path to none, by default zfs mounts it to the default dataset path
ZFSVolArg = append(ZFSVolArg, "-o", "mountpoint=legacy", volume)
return ZFSVolArg
}
// builldVolumeSetArgs returns volume set command along with attributes as a string array
// TODO(pawan) need to find a way to identify which property has changed
func buildVolumeSetArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSSetArg)
if vol.Spec.VolumeType == VolTypeDataset &&
len(vol.Spec.RecordSize) != 0 {
recordsizeProperty := "recordsize=" + vol.Spec.RecordSize
ZFSVolArg = append(ZFSVolArg, recordsizeProperty)
}
if len(vol.Spec.Dedup) != 0 {
dedupProperty := "dedup=" + vol.Spec.Dedup
ZFSVolArg = append(ZFSVolArg, dedupProperty)
}
if len(vol.Spec.Compression) != 0 {
compressionProperty := "compression=" + vol.Spec.Compression
ZFSVolArg = append(ZFSVolArg, compressionProperty)
}
ZFSVolArg = append(ZFSVolArg, volume)
return ZFSVolArg
}
// builldVolumeResizeArgs returns volume set for resizing the zfs volume
func buildVolumeResizeArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSSetArg)
if vol.Spec.VolumeType == VolTypeDataset {
quotaProperty := "quota=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, quotaProperty)
} else {
volsizeProperty := "volsize=" + vol.Spec.Capacity
ZFSVolArg = append(ZFSVolArg, volsizeProperty)
}
ZFSVolArg = append(ZFSVolArg, volume)
return ZFSVolArg
}
// builldVolumeBackupArgs returns volume send command for sending the zfs volume
func buildVolumeBackupArgs(bkp *apis.ZFSBackup, vol *apis.ZFSVolume) ([]string, error) {
var ZFSVolArg []string
backupDest := bkp.Spec.BackupDest
bkpAddr := strings.Split(backupDest, ":")
if len(bkpAddr) != 2 {
return ZFSVolArg, fmt.Errorf("zfs: invalid backup server address %s", backupDest)
}
curSnap := vol.Spec.PoolName + "/" + vol.Name + "@" + bkp.Spec.SnapName
remote := " | nc -w 3 " + bkpAddr[0] + " " + bkpAddr[1]
cmd := ZFSVolCmd + " "
if len(bkp.Spec.PrevSnapName) > 0 {
prevSnap := vol.Spec.PoolName + "/" + vol.Name + "@" + bkp.Spec.PrevSnapName
// do incremental send
cmd += ZFSSendArg + " -i " + prevSnap + " " + curSnap + " " + remote
} else {
cmd += ZFSSendArg + " " + curSnap + remote
}
ZFSVolArg = append(ZFSVolArg, "-c", cmd)
return ZFSVolArg, nil
}
// builldVolumeRestoreArgs returns volume recv command for receiving the zfs volume
func buildVolumeRestoreArgs(rstr *apis.ZFSRestore) ([]string, error) {
var ZFSVolArg []string
var ZFSRecvParam string
restoreSrc := rstr.Spec.RestoreSrc
volume := rstr.VolSpec.PoolName + "/" + rstr.Spec.VolumeName
rstrAddr := strings.Split(restoreSrc, ":")
if len(rstrAddr) != 2 {
return ZFSVolArg, fmt.Errorf("zfs: invalid restore server address %s", restoreSrc)
}
source := "nc -w 3 " + rstrAddr[0] + " " + rstrAddr[1] + " | "
if rstr.VolSpec.VolumeType == VolTypeDataset {
if len(rstr.VolSpec.Capacity) != 0 {
ZFSRecvParam += " -o quota=" + rstr.VolSpec.Capacity
}
if len(rstr.VolSpec.RecordSize) != 0 {
ZFSRecvParam += " -o recordsize=" + rstr.VolSpec.RecordSize
}
if rstr.VolSpec.ThinProvision == "no" {
ZFSRecvParam += " -o reservation=" + rstr.VolSpec.Capacity
}
ZFSRecvParam += " -o mountpoint=legacy"
}
if len(rstr.VolSpec.Dedup) != 0 {
ZFSRecvParam += " -o dedup=" + rstr.VolSpec.Dedup
}
if len(rstr.VolSpec.Compression) != 0 {
ZFSRecvParam += " -o compression=" + rstr.VolSpec.Compression
}
if len(rstr.VolSpec.Encryption) != 0 {
ZFSRecvParam += " -o encryption=" + rstr.VolSpec.Encryption
}
if len(rstr.VolSpec.KeyLocation) != 0 {
ZFSRecvParam += " -o keylocation=" + rstr.VolSpec.KeyLocation
}
if len(rstr.VolSpec.KeyFormat) != 0 {
ZFSRecvParam += " -o keyformat=" + rstr.VolSpec.KeyFormat
}
cmd := source + ZFSVolCmd + " " + ZFSRecvArg + ZFSRecvParam + " -F " + volume
ZFSVolArg = append(ZFSVolArg, "-c", cmd)
return ZFSVolArg, nil
}
// builldVolumeDestroyArgs returns volume destroy command along with attributes as a string array
func buildVolumeDestroyArgs(vol *apis.ZFSVolume) []string {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSDestroyArg, "-r", volume)
return ZFSVolArg
}
func getVolume(volume string) error {
var ZFSVolArg []string
ZFSVolArg = append(ZFSVolArg, ZFSListArg, volume)
cmd := exec.Command(ZFSVolCmd, ZFSVolArg...)
_, err := cmd.CombinedOutput()
return err
}
// CreateVolume creates the zvol/dataset as per
// info provided in ZFSVolume object
func CreateVolume(vol *apis.ZFSVolume) error {
volume := vol.Spec.PoolName + "/" + vol.Name
if err := getVolume(volume); err != nil {
var args []string
if vol.Spec.VolumeType == VolTypeDataset {
args = buildDatasetCreateArgs(vol)
} else {
args = buildZvolCreateArgs(vol)
}
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not create volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
klog.Infof("created volume %s", volume)
} else if err == nil {
klog.Infof("using existing volume %v", volume)
}
return nil
}
// CreateClone creates clone for the zvol/dataset as per
// info provided in ZFSVolume object
func CreateClone(vol *apis.ZFSVolume) error {
volume := vol.Spec.PoolName + "/" + vol.Name
if srcVol, ok := vol.Labels[ZFSSrcVolKey]; ok {
// datasource is volume, create the snapshot first
snap := &apis.ZFSSnapshot{}
snap.Name = vol.Name // use volname as snapname
snap.Spec = vol.Spec
// add src vol name
snap.Labels = map[string]string{ZFSVolKey: srcVol}
klog.Infof("creating snapshot %s@%s for the clone %s", srcVol, snap.Name, volume)
err := CreateSnapshot(snap)
if err != nil {
klog.Errorf(
"zfs: could not create snapshot for the clone vol %s snap %s err %v", volume, snap.Name, err,
)
return err
}
}
if err := getVolume(volume); err != nil {
args := buildCloneCreateArgs(vol)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not clone volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
klog.Infof("created clone %s", volume)
} else if err == nil {
klog.Infof("using existing clone volume %v", volume)
}
if vol.Spec.FsType == "xfs" {
device := ZFSDevPath + volume
return xfs.GenerateUUID(device)
}
if vol.Spec.FsType == "btrfs" {
device := ZFSDevPath + volume
return btrfs.GenerateUUID(device)
}
return nil
}
// SetDatasetMountProp sets mountpoint for the volume
func SetDatasetMountProp(volume string, mountpath string) error {
var ZFSVolArg []string
mountProperty := "mountpoint=" + mountpath
ZFSVolArg = append(ZFSVolArg, ZFSSetArg, mountProperty, volume)
cmd := exec.Command(ZFSVolCmd, ZFSVolArg...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf("zfs: could not set mountpoint on dataset %v cmd %v error: %s",
volume, ZFSVolArg, string(out))
return fmt.Errorf("could not set the mountpoint, %s", string(out))
}
return nil
}
// MountZFSDataset mounts the dataset to the given mountpoint
func MountZFSDataset(vol *apis.ZFSVolume, mountpath string) error {
volume := vol.Spec.PoolName + "/" + vol.Name
// set the mountpoint to the path where this volume should be mounted
err := SetDatasetMountProp(volume, mountpath)
if err != nil {
return err
}
/*
* see if we should attempt to mount the dataset.
* Setting the mountpoint is sufficient to mount the zfs dataset,
* but if dataset has been unmounted, then setting the mountpoint
* is not sufficient, we have to mount the dataset explicitly
*/
mounted, err := GetVolumeProperty(vol, "mounted")
if err != nil {
return err
}
if mounted == "no" {
var MountVolArg []string
MountVolArg = append(MountVolArg, "mount", volume)
cmd := exec.Command(ZFSVolCmd, MountVolArg...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf("zfs: could not mount the dataset %v cmd %v error: %s",
volume, MountVolArg, string(out))
return fmt.Errorf("not able to mount, %s", string(out))
}
}
return nil
}
// SetDatasetLegacyMount sets the dataset mountpoint to legacy if not set
func SetDatasetLegacyMount(vol *apis.ZFSVolume) error {
if vol.Spec.VolumeType != VolTypeDataset {
return nil
}
prop, err := GetVolumeProperty(vol, "mountpoint")
if err != nil {
return err
}
if prop != "legacy" {
// set the mountpoint to legacy
volume := vol.Spec.PoolName + "/" + vol.Name
err = SetDatasetMountProp(volume, "legacy")
}
return err
}
// GetVolumeProperty gets zfs properties for the volume
func GetVolumeProperty(vol *apis.ZFSVolume, prop string) (string, error) {
var ZFSVolArg []string
volume := vol.Spec.PoolName + "/" + vol.Name
ZFSVolArg = append(ZFSVolArg, ZFSGetArg, "-pH", "-o", "value", prop, volume)
cmd := exec.Command(ZFSVolCmd, ZFSVolArg...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf("zfs: could not get %s on dataset %v cmd %v error: %s",
prop, volume, ZFSVolArg, string(out))
return "", fmt.Errorf("zfs get %s failed, %s", prop, string(out))
}
val := out[:len(out)-1]
return string(val), nil
}
// SetVolumeProp sets the volume property
func SetVolumeProp(vol *apis.ZFSVolume) error {
var err error
volume := vol.Spec.PoolName + "/" + vol.Name
if len(vol.Spec.Compression) == 0 &&
len(vol.Spec.Dedup) == 0 &&
(vol.Spec.VolumeType != VolTypeDataset ||
len(vol.Spec.RecordSize) == 0) {
//nothing to set, just return
return nil
}
/* Case: Restart =>
* In this case we get the add event but here we don't know which
* property has changed when we were down, so firing the zfs set
* command with the all property present on the ZFSVolume.
* Case: Property Change =>
* TODO(pawan) When we get the update event, we make sure at least
* one property has changed before adding it to the event queue for
* handling. At this stage, since we haven't stored the
* ZFSVolume object as it will be too heavy, we are firing the set
* command with the all property preset in the ZFSVolume object since
* it is guaranteed that at least one property has changed.
*/
args := buildVolumeSetArgs(vol)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not set property on volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
klog.Infof("property set on volume %s", volume)
return err
}
// DestroyVolume deletes the zfs volume
func DestroyVolume(vol *apis.ZFSVolume) error {
volume := vol.Spec.PoolName + "/" + vol.Name
if err := getVolume(volume); err != nil {
klog.Errorf(
"destroy: volume %v is not present, error: %s", volume, err.Error(),
)
return nil
}
args := buildVolumeDestroyArgs(vol)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not destroy volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
if srcVol, ok := vol.Labels[ZFSSrcVolKey]; ok {
// datasource is volume, delete the dependent snapshot
snap := &apis.ZFSSnapshot{}
snap.Name = vol.Name // snapname is same as volname
snap.Spec = vol.Spec
// add src vol name
snap.Labels = map[string]string{ZFSVolKey: srcVol}
klog.Infof("destroying snapshot %s@%s for the clone %s", srcVol, snap.Name, volume)
err := DestroySnapshot(snap)
if err != nil {
// no need to reconcile as volume has already been deleted
klog.Errorf(
"zfs: could not destroy snapshot for the clone vol %s snap %s err %v", volume, snap.Name, err,
)
}
}
klog.Infof("destroyed volume %s", volume)
return nil
}
// CreateSnapshot creates the zfs volume snapshot
func CreateSnapshot(snap *apis.ZFSSnapshot) error {
volume := snap.Labels[ZFSVolKey]
snapDataset := snap.Spec.PoolName + "/" + volume + "@" + snap.Name
if err := getVolume(snapDataset); err == nil {
klog.Infof("snapshot already there %s", snapDataset)
// snapshot already there just return
return nil
}
args := buildZFSSnapCreateArgs(snap)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not create snapshot %v@%v cmd %v error: %s", volume, snap.Name, args, string(out),
)
return err
}
klog.Infof("created snapshot %s@%s", volume, snap.Name)
return nil
}
// DestroySnapshot deletes the zfs volume snapshot
func DestroySnapshot(snap *apis.ZFSSnapshot) error {
volume := snap.Labels[ZFSVolKey]
snapDataset := snap.Spec.PoolName + "/" + volume + "@" + snap.Name
if err := getVolume(snapDataset); err != nil {
klog.Errorf(
"destroy: snapshot %v is not present, error: %s", volume, err.Error(),
)
return nil
}
args := buildZFSSnapDestroyArgs(snap)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not destroy snapshot %v@%v cmd %v error: %s", volume, snap.Name, args, string(out),
)
return err
}
klog.Infof("deleted snapshot %s@%s", volume, snap.Name)
return nil
}
// GetVolumeDevPath returns devpath for the given volume
func GetVolumeDevPath(vol *apis.ZFSVolume) (string, error) {
volume := vol.Spec.PoolName + "/" + vol.Name
if vol.Spec.VolumeType == VolTypeDataset {
return volume, nil
}
devicePath := ZFSDevPath + volume
// evaluate the symlink to get the dev path for zvol
dev, err := filepath.EvalSymlinks(devicePath)
if err != nil {
return "", err
}
return dev, nil
}
// ResizeZFSVolume resize volume
func ResizeZFSVolume(vol *apis.ZFSVolume, mountpath string, resizefs bool) error {
volume := vol.Spec.PoolName + "/" + vol.Name
args := buildVolumeResizeArgs(vol)
cmd := exec.Command(ZFSVolCmd, args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not resize the volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
if resizefs {
// resize the filesystem so that applications can use the expanded space
err = handleVolResize(vol, mountpath)
}
return err
}
// CreateBackup creates the backup
func CreateBackup(bkp *apis.ZFSBackup) error {
vol, err := GetZFSVolume(bkp.Spec.VolumeName)
if err != nil {
return err
}
volume := vol.Spec.PoolName + "/" + vol.Name
/* create the snapshot for the backup */
snap := &apis.ZFSSnapshot{}
snap.Name = bkp.Spec.SnapName
snap.Spec.PoolName = vol.Spec.PoolName
snap.Labels = map[string]string{ZFSVolKey: vol.Name}
err = CreateSnapshot(snap)
if err != nil {
klog.Errorf(
"zfs: could not create snapshot for the backup vol %s snap %s err %v", volume, snap.Name, err,
)
return err
}
args, err := buildVolumeBackupArgs(bkp, vol)
if err != nil {
return err
}
cmd := exec.Command("bash", args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not backup the volume %v cmd %v error: %s", volume, args, string(out),
)
}
return err
}
// DestoryBackup deletes the snapshot created
func DestoryBackup(bkp *apis.ZFSBackup) error {
vol, err := GetZFSVolume(bkp.Spec.VolumeName)
if err != nil {
if k8serrors.IsNotFound(err) {
// Volume has been deleted, return
return nil
}
return err
}
volume := vol.Spec.PoolName + "/" + vol.Name
/* create the snapshot for the backup */
snap := &apis.ZFSSnapshot{}
snap.Name = bkp.Spec.SnapName
snap.Spec.PoolName = vol.Spec.PoolName
snap.Labels = map[string]string{ZFSVolKey: vol.Name}
err = DestroySnapshot(snap)
if err != nil {
klog.Errorf(
"zfs: could not destroy snapshot for the backup vol %s snap %s err %v", volume, snap.Name, err,
)
}
return err
}
// getDevice waits for the device to be created and returns the devpath
func getDevice(volume string) (string, error) {
device := ZFSDevPath + volume
// device should be created within 5 seconds
timeout := time.After(5 * time.Second)
for {
select {
case <-timeout:
return "", fmt.Errorf("zfs: not able to get the device: %s", device)
default:
if _, err := os.Stat(device); err == nil {
return device, nil
}
}
time.Sleep(1 * time.Second)
}
}
// CreateRestore creates the restore
func CreateRestore(rstr *apis.ZFSRestore) error {
if len(rstr.VolSpec.PoolName) == 0 {
// for backward compatibility, older version of
// velero will not add spec in the ZFSRestore Object
// query it here and fill that information
vol, err := GetZFSVolume(rstr.Spec.VolumeName)
if err != nil {
return err
}
rstr.VolSpec = vol.Spec
}
args, err := buildVolumeRestoreArgs(rstr)
if err != nil {
return err
}
volume := rstr.VolSpec.PoolName + "/" + rstr.Spec.VolumeName
cmd := exec.Command("bash", args...)
out, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf(
"zfs: could not restore the volume %v cmd %v error: %s", volume, args, string(out),
)
return err
}
/*
* need to generate a new uuid for zfs and btrfs volumes
* so that we can mount it.
*/
if rstr.VolSpec.FsType == "xfs" {
device, err := getDevice(volume)
if err != nil {
return err
}
return xfs.GenerateUUID(device)
}
if rstr.VolSpec.FsType == "btrfs" {
device, err := getDevice(volume)
if err != nil {
return err
}
return btrfs.GenerateUUID(device)
}
return nil
}
// ListZFSPool invokes `zfs list` to list all the available
// pools in the node.
func ListZFSPool() ([]apis.Pool, error) {
args := []string{
ZFSListArg, "-s", "name",
"-o", "name,guid,available",
"-H", "-p",
}
cmd := exec.Command(ZFSVolCmd, args...)
output, err := cmd.CombinedOutput()
if err != nil {
klog.Errorf("zfs: could not list zpool cmd %v: %v", args, err)
return nil, err
}
return decodeListOutput(output)
}
// The `zfs list` command will list down all the resources including
// pools and volumes and as the pool names cannot have "/" in the name
// the function below filters out the pools. Sample output of command:
// $ zfs list -s name -o name,guid,available -H -p
// zfspv-pool 4734063099997348493 103498467328
// zfspv-pool/pvc-be02d230-3738-4de9-8968-70f5d10d86dd 3380225606535803752 4294942720
func decodeListOutput(raw []byte) ([]apis.Pool, error) {
scanner := bufio.NewScanner(strings.NewReader(string(raw)))
pools := []apis.Pool{}
for scanner.Scan() {
items := strings.Split(strings.TrimSpace(scanner.Text()), "\t")
if !strings.Contains(items[0], "/") {
var pool apis.Pool
pool.Name = items[0]
pool.UUID = items[1]
sizeBytes, err := strconv.ParseInt(items[2],
10, 64)
if err != nil {
err = fmt.Errorf("cannot get free size for pool %v: %v", pool.Name, err)
return pools, err
}
pool.Free = *resource.NewQuantity(sizeBytes, resource.BinarySI)
pools = append(pools, pool)
}
}
return pools, nil
}