-
Notifications
You must be signed in to change notification settings - Fork 219
/
ontap_nas_qtree.go
1647 lines (1381 loc) · 54.5 KB
/
ontap_nas_qtree.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2019 NetApp, Inc. All Rights Reserved.
package ontap
import (
"errors"
"fmt"
"math/rand"
"strconv"
"strings"
"sync"
"time"
"github.com/RoaringBitmap/roaring"
"github.com/google/uuid"
log "github.com/sirupsen/logrus"
tridentconfig "github.com/netapp/trident/config"
"github.com/netapp/trident/storage"
sa "github.com/netapp/trident/storage_attribute"
drivers "github.com/netapp/trident/storage_drivers"
"github.com/netapp/trident/storage_drivers/ontap/api"
"github.com/netapp/trident/storage_drivers/ontap/api/azgo"
"github.com/netapp/trident/utils"
)
const (
deletedQtreeNamePrefix = "deleted_"
maxQtreeNameLength = 64
maxQtreesPerFlexvol = 200
defaultPruneFlexvolsPeriodSecs = uint64(600) // default to 10 minutes
defaultResizeQuotasPeriodSecs = uint64(60) // default to 1 minute
defaultEmptyFlexvolDeferredDeletePeriodSecs = uint64(28800) // default to 8 hours
pruneTask = "prune"
resizeTask = "resize"
)
// NASQtreeStorageDriver is for NFS storage provisioning of qtrees
type NASQtreeStorageDriver struct {
initialized bool
Config drivers.OntapStorageDriverConfig
API *api.Client
Telemetry *Telemetry
quotaResizeMap map[string]bool
flexvolNamePrefix string
flexvolExportPolicy string
housekeepingTasks map[string]*HousekeepingTask
housekeepingWaitGroup *sync.WaitGroup
sharedLockID string
emptyFlexvolMap map[string]time.Time
emptyFlexvolDeferredDeletePeriod time.Duration
}
func (d *NASQtreeStorageDriver) GetConfig() *drivers.OntapStorageDriverConfig {
return &d.Config
}
func (d *NASQtreeStorageDriver) GetAPI() *api.Client {
return d.API
}
func (d *NASQtreeStorageDriver) GetTelemetry() *Telemetry {
d.Telemetry.Telemetry = tridentconfig.OrchestratorTelemetry
return d.Telemetry
}
// Name is for returning the name of this driver
func (d *NASQtreeStorageDriver) Name() string {
return drivers.OntapNASQtreeStorageDriverName
}
func (d *NASQtreeStorageDriver) FlexvolNamePrefix() string {
return d.flexvolNamePrefix
}
// Initialize from the provided config
func (d *NASQtreeStorageDriver) Initialize(
context tridentconfig.DriverContext, configJSON string, commonConfig *drivers.CommonStorageDriverConfig,
) error {
if commonConfig.DebugTraceFlags["method"] {
fields := log.Fields{"Method": "Initialize", "Type": "NASQtreeStorageDriver"}
log.WithFields(fields).Debug(">>>> Initialize")
defer log.WithFields(fields).Debug("<<<< Initialize")
}
// Parse the config
config, err := InitializeOntapConfig(context, configJSON, commonConfig)
if err != nil {
return fmt.Errorf("error initializing %s driver: %v", d.Name(), err)
}
d.Config = *config
d.API, err = InitializeOntapDriver(config)
if err != nil {
return fmt.Errorf("error initializing %s driver: %v", d.Name(), err)
}
d.Config = *config
// Remap context for artifact naming so the names remain stable over time
var artifactPrefix string
switch context {
case tridentconfig.ContextDocker:
artifactPrefix = artifactPrefixDocker
case tridentconfig.ContextKubernetes, tridentconfig.ContextCSI:
artifactPrefix = artifactPrefixKubernetes
default:
return fmt.Errorf("unknown driver context: %s", context)
}
// Set up internal driver state
d.quotaResizeMap = make(map[string]bool)
d.flexvolNamePrefix = fmt.Sprintf("%s_qtree_pool_%s_", artifactPrefix, *d.Config.StoragePrefix)
d.flexvolNamePrefix = strings.Replace(d.flexvolNamePrefix, "__", "_", -1)
d.flexvolExportPolicy = fmt.Sprintf("%s_qtree_pool_export_policy", artifactPrefix)
d.sharedLockID = d.API.SVMUUID + "-" + *d.Config.StoragePrefix
d.emptyFlexvolMap = make(map[string]time.Time)
log.WithFields(log.Fields{
"FlexvolNamePrefix": d.flexvolNamePrefix,
"FlexvolExportPolicy": d.flexvolExportPolicy,
"SharedLockID": d.sharedLockID,
}).Debugf("Qtree driver settings.")
err = d.validate()
if err != nil {
return fmt.Errorf("error validating %s driver: %v", d.Name(), err)
}
// Ensure all quotas are in force after a driver restart
d.queueAllFlexvolsForQuotaResize()
// Start periodic housekeeping tasks like cleaning up unused Flexvols
d.housekeepingWaitGroup = &sync.WaitGroup{}
d.housekeepingTasks = make(map[string]*HousekeepingTask, 2)
//pruneTasks := []func(){d.pruneUnusedFlexvols, d.reapDeletedQtrees}
//d.housekeepingTasks[pruneTask] = NewPruneTask(d, pruneTasks)
resizeTasks := []func(){d.resizeQuotas}
d.housekeepingTasks[resizeTask] = NewResizeTask(d, resizeTasks)
for _, task := range d.housekeepingTasks {
task.Start()
}
// Set up the autosupport heartbeat
d.Telemetry = NewOntapTelemetry(d)
d.Telemetry.Start()
d.initialized = true
return nil
}
func (d *NASQtreeStorageDriver) Initialized() bool {
return d.initialized
}
func (d *NASQtreeStorageDriver) Terminate() {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{"Method": "Terminate", "Type": "NASQtreeStorageDriver"}
log.WithFields(fields).Debug(">>>> Terminate")
defer log.WithFields(fields).Debug("<<<< Terminate")
}
if d.housekeepingWaitGroup != nil {
for _, task := range d.housekeepingTasks {
task.Stop()
}
}
if d.Telemetry != nil {
d.Telemetry.Stop()
}
if d.housekeepingWaitGroup != nil {
log.Debug("Waiting for housekeeping tasks to exit.")
d.housekeepingWaitGroup.Wait()
}
d.initialized = false
}
// Validate the driver configuration and execution environment
func (d *NASQtreeStorageDriver) validate() error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{"Method": "validate", "Type": "NASQtreeStorageDriver"}
log.WithFields(fields).Debug(">>>> validate")
defer log.WithFields(fields).Debug("<<<< validate")
}
err := ValidateNASDriver(d.API, &d.Config)
if err != nil {
return fmt.Errorf("driver validation failed: %v", err)
}
// Make sure we have an export policy for all the Flexvols we create
err = d.ensureDefaultExportPolicy()
if err != nil {
return fmt.Errorf("error configuring export policy: %v", err)
}
return nil
}
// Create a qtree-backed volume with the specified options
func (d *NASQtreeStorageDriver) Create(
volConfig *storage.VolumeConfig, storagePool *storage.Pool, volAttributes map[string]sa.Request,
) error {
name := volConfig.InternalName
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "Create",
"Type": "NASQtreeStorageDriver",
"name": name,
"attrs": volAttributes,
}
log.WithFields(fields).Debug(">>>> Create")
defer log.WithFields(fields).Debug("<<<< Create")
}
// Ensure any Flexvol we create won't be pruned before we place a qtree on it
utils.Lock("create", d.sharedLockID)
defer utils.Unlock("create", d.sharedLockID)
// Generic user-facing message
createError := errors.New("volume creation failed")
// Ensure volume doesn't already exist
exists, existsInFlexvol, err := d.API.QtreeExists(name, d.FlexvolNamePrefix())
if err != nil {
log.Errorf("Error checking for existing volume: %v.", err)
return createError
}
if exists {
log.WithFields(log.Fields{"qtree": name, "flexvol": existsInFlexvol}).Debug("Qtree already exists.")
return drivers.NewVolumeExistsError(name)
}
// Determine volume size in bytes
requestedSize, err := utils.ConvertSizeToBytes(volConfig.Size)
if err != nil {
return fmt.Errorf("could not convert volume size %s: %v", volConfig.Size, err)
}
sizeBytes, err := strconv.ParseUint(requestedSize, 10, 64)
if err != nil {
return fmt.Errorf("%v is an invalid volume size: %v", volConfig.Size, err)
}
sizeBytes, err = GetVolumeSize(sizeBytes, d.Config)
if err != nil {
return err
}
// Ensure qtree name isn't too long
if len(name) > maxQtreeNameLength {
return fmt.Errorf("volume %s name exceeds the limit of %d characters", name, maxQtreeNameLength)
}
// Get options
opts, err := d.GetVolumeOpts(volConfig, storagePool, volAttributes)
if err != nil {
return err
}
// Get Flexvol options with default fallback values
// see also: ontap_common.go#PopulateConfigurationDefaults
aggregate := utils.GetV(opts, "aggregate", d.Config.Aggregate)
spaceReserve := utils.GetV(opts, "spaceReserve", d.Config.SpaceReserve)
snapshotPolicy := utils.GetV(opts, "snapshotPolicy", d.Config.SnapshotPolicy)
snapshotDir := utils.GetV(opts, "snapshotDir", d.Config.SnapshotDir)
encryption := utils.GetV(opts, "encryption", d.Config.Encryption)
if aggrLimitsErr := checkAggregateLimits(aggregate, spaceReserve, sizeBytes, d.Config, d.GetAPI()); aggrLimitsErr != nil {
return aggrLimitsErr
}
enableSnapshotDir, err := strconv.ParseBool(snapshotDir)
if err != nil {
return fmt.Errorf("invalid boolean value for snapshotDir: %v", err)
}
enableEncryption, err := strconv.ParseBool(encryption)
if err != nil {
return fmt.Errorf("invalid boolean value for encryption: %v", err)
}
// Make sure we have a Flexvol for the new qtree
flexvol, err := d.ensureFlexvolForQtree(
aggregate, spaceReserve, snapshotPolicy, enableSnapshotDir, enableEncryption, sizeBytes, opts, d.Config)
if err != nil {
log.Errorf("Flexvol location/creation failed. %v", err)
return createError
}
// Grow or shrink the Flexvol as needed
err = d.resizeFlexvol(flexvol, sizeBytes)
if err != nil {
return createError
}
// Get qtree options with default fallback values
unixPermissions := utils.GetV(opts, "unixPermissions", d.Config.UnixPermissions)
exportPolicy := utils.GetV(opts, "exportPolicy", d.Config.ExportPolicy)
securityStyle := utils.GetV(opts, "securityStyle", d.Config.SecurityStyle)
// Create the qtree
qtreeResponse, err := d.API.QtreeCreate(name, flexvol, unixPermissions, exportPolicy, securityStyle)
if err = api.GetError(qtreeResponse, err); err != nil {
log.Errorf("Qtree creation failed. %v", err)
return createError
}
// Add the quota
err = d.setQuotaForQtree(name, flexvol, sizeBytes)
if err != nil {
log.Errorf("Qtree quota definition failed. %v", err)
return createError
}
return nil
}
// Create a volume clone
func (d *NASQtreeStorageDriver) CreateClone(volConfig *storage.VolumeConfig) error {
name := volConfig.InternalName
source := volConfig.CloneSourceVolumeInternal
snapshot := volConfig.CloneSourceSnapshot
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "CreateClone",
"Type": "NASQtreeStorageDriver",
"name": name,
"source": source,
"snapshot": snapshot,
}
log.WithFields(fields).Debug(">>>> CreateClone")
defer log.WithFields(fields).Debug("<<<< CreateClone")
}
return fmt.Errorf("cloning is not supported by backend type %s", d.Name())
}
func (d *NASQtreeStorageDriver) Import(volConfig *storage.VolumeConfig, originalName string) error {
return errors.New("import is not implemented")
}
func (d *NASQtreeStorageDriver) Rename(name string, newName string) error {
return errors.New("rename is not implemented")
}
// Destroy the volume
func (d *NASQtreeStorageDriver) Destroy(name string) error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "Destroy",
"Type": "NASQtreeStorageDriver",
"name": name,
}
log.WithFields(fields).Debug(">>>> Destroy")
defer log.WithFields(fields).Debug("<<<< Destroy")
}
// Ensure the deleted qtree reaping job doesn't interfere with this workflow
utils.Lock("destroy", d.sharedLockID)
defer utils.Unlock("destroy", d.sharedLockID)
// Generic user-facing message
deleteError := errors.New("volume deletion failed")
exists, flexvol, err := d.API.QtreeExists(name, d.FlexvolNamePrefix())
if err != nil {
log.Errorf("Error checking for existing qtree. %v", err)
return deleteError
}
if !exists {
log.WithField("qtree", name).Warn("Qtree not found.")
return nil
}
// Rename qtree so it doesn't show up in lists while ONTAP is deleting it in the background.
// Ensure the deleted name doesn't exceed the qtree name length limit of 64 characters.
path := fmt.Sprintf("/vol/%s/%s", flexvol, name)
deletedName := deletedQtreeNamePrefix + name + "_" + utils.RandomString(5)
if len(deletedName) > maxQtreeNameLength {
trimLength := len(deletedQtreeNamePrefix) + 10
deletedName = deletedQtreeNamePrefix + name[trimLength:] + "_" + utils.RandomString(5)
}
deletedPath := fmt.Sprintf("/vol/%s/%s", flexvol, deletedName)
renameResponse, err := d.API.QtreeRename(path, deletedPath)
if err = api.GetError(renameResponse, err); err != nil {
log.Errorf("Qtree rename failed. %v", err)
return deleteError
}
// Destroy the qtree in the background. If this fails, try to restore the original qtree name.
destroyResponse, err := d.API.QtreeDestroyAsync(deletedPath, true)
if err = api.GetError(destroyResponse, err); err != nil {
log.Errorf("Qtree async delete failed. %v", err)
defer d.API.QtreeRename(deletedPath, path)
return deleteError
}
return nil
}
// Publish the volume to the host specified in publishInfo. This method may or may not be running on the host
// where the volume will be mounted, so it should limit itself to updating access rules, initiator groups, etc.
// that require some host identity (but not locality) as well as storage controller API access.
func (d *NASQtreeStorageDriver) Publish(name string, publishInfo *utils.VolumePublishInfo) error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "Publish",
"Type": "NASQtreeStorageDriver",
"name": name,
}
log.WithFields(fields).Debug(">>>> Publish")
defer log.WithFields(fields).Debug("<<<< Publish")
}
// Check if qtree exists, and find its Flexvol so we can build the export location
exists, flexvol, err := d.API.QtreeExists(name, d.FlexvolNamePrefix())
if err != nil {
log.Errorf("Error checking for existing qtree. %v", err)
return errors.New("volume mount failed")
}
if !exists {
log.WithField("qtree", name).Debug("Qtree not found.")
return fmt.Errorf("volume %s not found", name)
}
// Add fields needed by Attach
publishInfo.NfsPath = fmt.Sprintf("/%s/%s", flexvol, name)
publishInfo.NfsServerIP = d.Config.DataLIF
publishInfo.FilesystemType = "nfs"
publishInfo.MountOptions = d.Config.NfsMountOptions
return nil
}
// GetSnapshot returns a snapshot of a volume, or an error if it does not exist.
func (d *NASQtreeStorageDriver) GetSnapshot(snapConfig *storage.SnapshotConfig) (*storage.Snapshot, error) {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "GetSnapshot",
"Type": "NASQtreeStorageDriver",
"snapshotName": snapConfig.InternalName,
"volumeName": snapConfig.VolumeInternalName,
}
log.WithFields(fields).Debug(">>>> GetSnapshot")
defer log.WithFields(fields).Debug("<<<< GetSnapshot")
}
return nil, drivers.NewSnapshotsNotSupportedError(d.Name())
}
// Return the list of snapshots associated with the specified volume
func (d *NASQtreeStorageDriver) GetSnapshots(volConfig *storage.VolumeConfig) ([]*storage.Snapshot, error) {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "GetSnapshots",
"Type": "NASQtreeStorageDriver",
"volumeName": volConfig.InternalName,
}
log.WithFields(fields).Debug(">>>> GetSnapshots")
defer log.WithFields(fields).Debug("<<<< GetSnapshots")
}
// Qtrees can't have snapshots, so return an empty list
return []*storage.Snapshot{}, nil
}
// CreateSnapshot creates a snapshot for the given volume
func (d *NASQtreeStorageDriver) CreateSnapshot(snapConfig *storage.SnapshotConfig) (*storage.Snapshot, error) {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "CreateSnapshot",
"Type": "NASQtreeStorageDriver",
"snapshotName": snapConfig.InternalName,
"sourceVolume": snapConfig.VolumeInternalName,
}
log.WithFields(fields).Debug(">>>> CreateSnapshot")
defer log.WithFields(fields).Debug("<<<< CreateSnapshot")
}
return nil, drivers.NewSnapshotsNotSupportedError(d.Name())
}
// RestoreSnapshot restores a volume (in place) from a snapshot.
func (d *NASQtreeStorageDriver) RestoreSnapshot(snapConfig *storage.SnapshotConfig) error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "RestoreSnapshot",
"Type": "NASQtreeStorageDriver",
"snapshotName": snapConfig.InternalName,
"sourceVolume": snapConfig.VolumeInternalName,
}
log.WithFields(fields).Debug(">>>> RestoreSnapshot")
defer log.WithFields(fields).Debug("<<<< RestoreSnapshot")
}
return drivers.NewSnapshotsNotSupportedError(d.Name())
}
// DeleteSnapshot creates a snapshot of a volume.
func (d *NASQtreeStorageDriver) DeleteSnapshot(snapConfig *storage.SnapshotConfig) error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{
"Method": "DeleteSnapshot",
"Type": "NASQtreeStorageDriver",
"snapshotName": snapConfig.InternalName,
"volumeName": snapConfig.VolumeInternalName,
}
log.WithFields(fields).Debug(">>>> DeleteSnapshot")
defer log.WithFields(fields).Debug("<<<< DeleteSnapshot")
}
return drivers.NewSnapshotsNotSupportedError(d.Name())
}
// Test for the existence of a volume
func (d *NASQtreeStorageDriver) Get(name string) error {
if d.Config.DebugTraceFlags["method"] {
fields := log.Fields{"Method": "Get", "Type": "NASQtreeStorageDriver"}
log.WithFields(fields).Debug(">>>> Get")
defer log.WithFields(fields).Debug("<<<< Get")
}
// Generic user-facing message
getError := fmt.Errorf("volume %s not found", name)
exists, flexvol, err := d.API.QtreeExists(name, d.FlexvolNamePrefix())
if err != nil {
log.Errorf("Error checking for existing qtree. %v", err)
return getError
}
if !exists {
log.WithField("qtree", name).Debug("Qtree not found.")
return getError
}
log.WithFields(log.Fields{"qtree": name, "flexvol": flexvol}).Debug("Qtree found.")
return nil
}
// ensureFlexvolForQtree accepts a set of Flexvol characteristics and either finds one to contain a new
// qtree or it creates a new Flexvol with the needed attributes.
func (d *NASQtreeStorageDriver) ensureFlexvolForQtree(
aggregate, spaceReserve, snapshotPolicy string, enableSnapshotDir bool, enableEncryption bool,
sizeBytes uint64, opts map[string]string, config drivers.OntapStorageDriverConfig,
) (string, error) {
shouldLimitVolumeSize, flexvolQuotaSizeLimit, checkVolumeSizeLimitsError := drivers.CheckVolumeSizeLimits(
sizeBytes, config.CommonStorageDriverConfig)
if checkVolumeSizeLimitsError != nil {
return "", checkVolumeSizeLimitsError
}
// Check if a suitable Flexvol already exists
flexvol, err := d.getFlexvolForQtree(aggregate, spaceReserve, snapshotPolicy, enableSnapshotDir,
enableEncryption, sizeBytes, shouldLimitVolumeSize, flexvolQuotaSizeLimit)
if err != nil {
return "", fmt.Errorf("error finding Flexvol for qtree: %v", err)
}
// Found one!
if flexvol != "" {
return flexvol, nil
}
// Nothing found, so create a suitable Flexvol
flexvol, err = d.createFlexvolForQtree(
aggregate, spaceReserve, snapshotPolicy, enableSnapshotDir, enableEncryption)
if err != nil {
return "", fmt.Errorf("error creating Flexvol for qtree: %v", err)
}
return flexvol, nil
}
// createFlexvolForQtree creates a new Flexvol matching the specified attributes for
// the purpose of containing qtrees supplied as container volumes by this driver.
// Once this method returns, the Flexvol exists, is mounted, and has a default tree
// quota.
func (d *NASQtreeStorageDriver) createFlexvolForQtree(
aggregate, spaceReserve, snapshotPolicy string, enableSnapshotDir bool, enableEncryption bool,
) (string, error) {
flexvol := d.FlexvolNamePrefix() + utils.RandomString(10)
size := "1g"
unixPermissions := "0711"
exportPolicy := d.flexvolExportPolicy
securityStyle := "unix"
snapshotReserveInt, err := GetSnapshotReserve(snapshotPolicy, d.Config.SnapshotReserve)
if err != nil {
return "", fmt.Errorf("invalid value for snapshotReserve: %v", err)
}
log.WithFields(log.Fields{
"name": flexvol,
"aggregate": aggregate,
"size": size,
"spaceReserve": spaceReserve,
"snapshotPolicy": snapshotPolicy,
"snapshotReserve": snapshotReserveInt,
"unixPermissions": unixPermissions,
"snapshotDir": enableSnapshotDir,
"exportPolicy": exportPolicy,
"securityStyle": securityStyle,
"encryption": enableEncryption,
}).Debug("Creating Flexvol for qtrees.")
// Create the Flexvol
createResponse, err := d.API.VolumeCreate(
flexvol, aggregate, size, spaceReserve, snapshotPolicy, unixPermissions,
exportPolicy, securityStyle, enableEncryption, snapshotReserveInt)
if err = api.GetError(createResponse, err); err != nil {
return "", fmt.Errorf("error creating Flexvol: %v", err)
}
// Disable '.snapshot' as needed
if !enableSnapshotDir {
snapDirResponse, err := d.API.VolumeDisableSnapshotDirectoryAccess(flexvol)
if err = api.GetError(snapDirResponse, err); err != nil {
defer d.API.VolumeDestroy(flexvol, true)
return "", fmt.Errorf("error disabling snapshot directory access: %v", err)
}
}
// Mount the volume at the specified junction
mountResponse, err := d.API.VolumeMount(flexvol, "/"+flexvol)
if err = api.GetError(mountResponse, err); err != nil {
defer d.API.VolumeDestroy(flexvol, true)
return "", fmt.Errorf("error mounting Flexvol: %v", err)
}
// Create the default quota rule so we can use quota-resize for new qtrees
err = d.addDefaultQuotaForFlexvol(flexvol)
if err != nil {
defer d.API.VolumeDestroy(flexvol, true)
return "", fmt.Errorf("error adding default quota to Flexvol: %v", err)
}
return flexvol, nil
}
// getFlexvolForQtree returns a Flexvol (from the set of existing Flexvols) that
// matches the specified Flexvol attributes and does not already contain more
// than the maximum configured number of qtrees. No matching Flexvols is not
// considered an error. If more than one matching Flexvol is found, one of those
// is returned at random.
func (d *NASQtreeStorageDriver) getFlexvolForQtree(
aggregate, spaceReserve, snapshotPolicy string, enableSnapshotDir bool, enableEncryption bool,
sizeBytes uint64, shouldLimitFlexvolQuotaSize bool, flexvolQuotaSizeLimit uint64,
) (string, error) {
// Get all volumes matching the specified attributes
volListResponse, err := d.API.VolumeListByAttrs(
d.FlexvolNamePrefix(), aggregate, spaceReserve, snapshotPolicy, enableSnapshotDir, enableEncryption)
if err = api.GetError(volListResponse, err); err != nil {
return "", fmt.Errorf("error enumerating Flexvols: %v", err)
}
// Weed out the Flexvols:
// 1) already having too many qtrees
// 2) exceeding size limits
var volumes []string
if volListResponse.Result.AttributesListPtr != nil {
for _, volAttrs := range volListResponse.Result.AttributesListPtr.VolumeAttributesPtr {
volIDAttrs := volAttrs.VolumeIdAttributes()
volName := string(volIDAttrs.Name())
// skip flexvols over the size limit
if shouldLimitFlexvolQuotaSize {
sizeWithRequest, err := d.getOptimalSizeForFlexvol(volName, sizeBytes)
if err != nil {
log.Errorf("Error checking size for existing qtree. %v %v", volName, err)
continue
}
if sizeWithRequest > flexvolQuotaSizeLimit {
log.Debugf("Flexvol quota size for %v is over the limit of %v", volName, flexvolQuotaSizeLimit)
continue
}
}
count, err := d.API.QtreeCount(volName)
if err != nil {
return "", fmt.Errorf("error enumerating qtrees: %v", err)
}
if count < maxQtreesPerFlexvol {
volumes = append(volumes, volName)
}
}
}
// Pick a Flexvol. If there are multiple matches, pick one at random.
switch len(volumes) {
case 0:
return "", nil
case 1:
return volumes[0], nil
default:
return volumes[rand.Intn(len(volumes))], nil
}
}
// getOptimalSizeForFlexvol sums up all the disk limit quota rules on a Flexvol and adds the size of
// the new qtree being added as well as the current Flexvol snapshot reserve. This value may be used
// to grow (or shrink) the Flexvol as new qtrees are being added.
func (d *NASQtreeStorageDriver) getOptimalSizeForFlexvol(
flexvol string, newQtreeSizeBytes uint64,
) (uint64, error) {
// Get more info about the Flexvol
volAttrs, err := d.API.VolumeGet(flexvol)
if err != nil {
return 0, err
}
volSpaceAttrs := volAttrs.VolumeSpaceAttributes()
snapReserveDivisor := 1.0 - (float64(volSpaceAttrs.PercentageSnapshotReserve()) / 100.0)
totalDiskLimitBytes, err := d.getTotalHardDiskLimitQuota(flexvol)
if err != nil {
return 0, err
}
usableSpaceBytes := float64(newQtreeSizeBytes + totalDiskLimitBytes)
flexvolSizeBytes := uint64(usableSpaceBytes / snapReserveDivisor)
log.WithFields(log.Fields{
"flexvol": flexvol,
"snapReserveDivisor": snapReserveDivisor,
"totalDiskLimitBytes": totalDiskLimitBytes,
"newQtreeSizeBytes": newQtreeSizeBytes,
"flexvolSizeBytes": flexvolSizeBytes,
}).Debug("Calculated optimal size for Flexvol with new qtree.")
return flexvolSizeBytes, nil
}
// addDefaultQuotaForFlexvol adds a default quota rule to a Flexvol so that quotas for
// new qtrees may be added on demand with simple quota resize instead of a heavyweight
// quota reinitialization.
func (d *NASQtreeStorageDriver) addDefaultQuotaForFlexvol(flexvol string) error {
response, err := d.API.QuotaSetEntry("", flexvol, "", "tree", "-")
if err = api.GetError(response, err); err != nil {
return fmt.Errorf("error adding default quota: %v", err)
}
if err := d.disableQuotas(flexvol, true); err != nil {
log.Warningf("Could not disable quotas after adding a default quota: %v", err)
}
if err := d.enableQuotas(flexvol, true); err != nil {
log.Warningf("Could not enable quotas after adding a default quota: %v", err)
}
return nil
}
// setQuotaForQtree adds a tree quota to a Flexvol/qtree with a hard disk size limit if it doesn't exist.
// If the quota already exists the hard disk size limit is updated.
func (d *NASQtreeStorageDriver) setQuotaForQtree(qtree, flexvol string, sizeBytes uint64) error {
target := fmt.Sprintf("/vol/%s/%s", flexvol, qtree)
sizeKB := strconv.FormatUint(sizeBytes/1024, 10)
response, err := d.API.QuotaSetEntry("", flexvol, target, "tree", sizeKB)
if err = api.GetError(response, err); err != nil {
return fmt.Errorf("error adding qtree quota: %v", err)
}
// Mark this Flexvol as needing a quota resize
d.quotaResizeMap[flexvol] = true
return nil
}
// getQuotaDiskLimitSize returns the disk limit size for the specified quota.
func (d *NASQtreeStorageDriver) getQuotaDiskLimitSize(name string, flexvol string) (uint64, error) {
quotaTarget := fmt.Sprintf("/vol/%s/%s", flexvol, name)
quota, err := d.API.QuotaGetEntry(quotaTarget)
if err != nil {
return 0, err
}
quotaSize := uint64(convertDiskLimitToBytes(quota.DiskLimit()))
if quotaSize == 0 {
return 0, fmt.Errorf("unable to determine quota size")
}
return quotaSize, nil
}
// enableQuotas disables quotas on a Flexvol, optionally waiting for the operation to finish.
func (d *NASQtreeStorageDriver) disableQuotas(flexvol string, wait bool) error {
status, err := d.getQuotaStatus(flexvol)
if err != nil {
return fmt.Errorf("error disabling quotas: %v", err)
}
if status == "corrupt" {
return fmt.Errorf("error disabling quotas: quotas are corrupt on Flexvol %s", flexvol)
}
if status != "off" {
offResponse, err := d.API.QuotaOff(flexvol)
if err = api.GetError(offResponse, err); err != nil {
return fmt.Errorf("error disabling quotas: %v", err)
}
}
if wait {
for status != "off" {
time.Sleep(1 * time.Second)
status, err = d.getQuotaStatus(flexvol)
if err != nil {
return fmt.Errorf("error disabling quotas: %v", err)
}
if status == "corrupt" {
return fmt.Errorf("error disabling quotas: quotas are corrupt on flexvol %s", flexvol)
}
}
}
return nil
}
// enableQuotas enables quotas on a Flexvol, optionally waiting for the operation to finish.
func (d *NASQtreeStorageDriver) enableQuotas(flexvol string, wait bool) error {
status, err := d.getQuotaStatus(flexvol)
if err != nil {
return fmt.Errorf("error enabling quotas: %v", err)
}
if status == "corrupt" {
return fmt.Errorf("error enabling quotas: quotas are corrupt on flexvol %s", flexvol)
}
if status == "off" {
onResponse, err := d.API.QuotaOn(flexvol)
if err = api.GetError(onResponse, err); err != nil {
return fmt.Errorf("error enabling quotas: %v", err)
}
}
if wait {
for status != "on" {
time.Sleep(1 * time.Second)
status, err = d.getQuotaStatus(flexvol)
if err != nil {
return fmt.Errorf("error enabling quotas: %v", err)
}
if status == "corrupt" {
return fmt.Errorf("error enabling quotas: quotas are corrupt on flexvol %s", flexvol)
}
}
}
return nil
}
// queueAllFlexvolsForQuotaResize flags every Flexvol managed by this driver as
// needing a quota resize. This is called once on driver startup to handle the
// case where the driver was shut down with pending quota resize operations.
func (d *NASQtreeStorageDriver) queueAllFlexvolsForQuotaResize() {
// Get list of Flexvols managed by this driver
volumeListResponse, err := d.API.VolumeList(d.FlexvolNamePrefix())
if err = api.GetError(volumeListResponse, err); err != nil {
log.Errorf("Error listing Flexvols: %v", err)
}
if volumeListResponse.Result.AttributesListPtr != nil {
for _, volAttrs := range volumeListResponse.Result.AttributesListPtr.VolumeAttributesPtr {
volIDAttrs := volAttrs.VolumeIdAttributes()
flexvol := string(volIDAttrs.Name())
d.quotaResizeMap[flexvol] = true
}
}
}
// resizeQuotas may be called by a background task, or by a method that changed
// the qtree population on a Flexvol. Flexvols needing an update must be flagged
// in quotaResizeMap. Any failures that occur are simply logged, and the resize
// operation will be attempted each time this method is called until it succeeds.
func (d *NASQtreeStorageDriver) resizeQuotas() {
// Ensure we don't forget any Flexvol that is involved in a qtree provisioning workflow
utils.Lock("resize", d.sharedLockID)
defer utils.Unlock("resize", d.sharedLockID)
log.Debug("Housekeeping, resizing quotas.")
for flexvol, resize := range d.quotaResizeMap {
if resize {
resizeResponse, err := d.API.QuotaResize(flexvol)
if err != nil {
log.WithFields(log.Fields{"flexvol": flexvol, "error": err}).Debug("Error resizing quotas.")
continue
}
if zerr := api.NewZapiError(resizeResponse); !zerr.IsPassed() {
if zerr.Code() == azgo.EVOLUMEDOESNOTEXIST {
// Volume gone, so no need to try again
log.WithField("flexvol", flexvol).Debug("Volume does not exist.")
delete(d.quotaResizeMap, flexvol)
} else {
log.WithFields(log.Fields{"flexvol": flexvol, "error": zerr}).Debug("Error resizing quotas.")
}
continue
}
log.WithField("flexvol", flexvol).Debug("Started quota resize.")
// Resize start succeeded, so no need to try again
delete(d.quotaResizeMap, flexvol)
}
}
}
// getQuotaStatus returns the status of the quotas on a Flexvol
func (d *NASQtreeStorageDriver) getQuotaStatus(flexvol string) (string, error) {
statusResponse, err := d.API.QuotaStatus(flexvol)
if err = api.GetError(statusResponse, err); err != nil {
return "", fmt.Errorf("error getting quota status for Flexvol %s: %v", flexvol, err)
}
return statusResponse.Result.Status(), nil
}
// getTotalHardDiskLimitQuota returns the sum of all disk limit quota rules on a Flexvol
func (d *NASQtreeStorageDriver) getTotalHardDiskLimitQuota(flexvol string) (uint64, error) {
listResponse, err := d.API.QuotaEntryList(flexvol)
if err != nil {
return 0, err
}
var totalDiskLimitKB uint64
if listResponse.Result.AttributesListPtr != nil {
for _, rule := range listResponse.Result.AttributesListPtr.QuotaEntryPtr {
diskLimitKB, err := strconv.ParseUint(rule.DiskLimit(), 10, 64)
if err != nil {
continue
}
totalDiskLimitKB += diskLimitKB
}
}
return totalDiskLimitKB * 1024, nil
}
// pruneUnusedFlexvols is called periodically by a background task. Any Flexvols
// that are managed by this driver (discovered by virtue of having a well-known
// hardcoded prefix on their names) that have no qtrees are deleted.
func (d *NASQtreeStorageDriver) pruneUnusedFlexvols() {
// Ensure we don't prune any Flexvol that is involved in a qtree provisioning workflow
utils.Lock("prune", d.sharedLockID)
defer utils.Unlock("prune", d.sharedLockID)
log.Debug("Housekeeping, checking for managed Flexvols with no qtrees.")
// Get list of Flexvols managed by this driver
volumeListResponse, err := d.API.VolumeList(d.FlexvolNamePrefix())
if err = api.GetError(volumeListResponse, err); err != nil {
log.WithField("error", err).Error("Could not list Flexvols.")
return
}
var flexvols []string
if volumeListResponse.Result.AttributesListPtr != nil {
for _, volAttrs := range volumeListResponse.Result.AttributesListPtr.VolumeAttributesPtr {
volIDAttrs := volAttrs.VolumeIdAttributes()
volName := string(volIDAttrs.Name())
flexvols = append(flexvols, volName)
}