-
Notifications
You must be signed in to change notification settings - Fork 219
/
orchestrator_core.go
5365 lines (4638 loc) · 183 KB
/
orchestrator_core.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 2022 NetApp, Inc. All Rights Reserved.
package core
import (
"context"
"errors"
"fmt"
"os"
"path"
"path/filepath"
"sort"
"strconv"
"strings"
"sync"
"time"
"github.com/google/uuid"
log "github.com/sirupsen/logrus"
"go.uber.org/multierr"
"github.com/netapp/trident/config"
"github.com/netapp/trident/core/cache"
"github.com/netapp/trident/frontend"
controllerhelpers "github.com/netapp/trident/frontend/csi/controller_helpers"
. "github.com/netapp/trident/logger"
persistentstore "github.com/netapp/trident/persistent_store"
"github.com/netapp/trident/storage"
"github.com/netapp/trident/storage/factory"
sa "github.com/netapp/trident/storage_attribute"
storageclass "github.com/netapp/trident/storage_class"
drivers "github.com/netapp/trident/storage_drivers"
"github.com/netapp/trident/storage_drivers/fake"
"github.com/netapp/trident/utils"
)
const (
NodeAccessReconcilePeriod = time.Second * 30
NodeRegistrationCooldownPeriod = time.Second * 30
AttachISCSIVolumeTimeoutLong = time.Second * 90
)
// recordTiming is used to record in Prometheus the total time taken for an operation as follows:
//
// defer recordTiming("backend_add")()
//
// see also: https://play.golang.org/p/6xRXlhFdqBd
func recordTiming(operation string, err *error) func() {
startTime := time.Now()
return func() {
endTime := time.Since(startTime)
endTimeMS := float64(endTime.Milliseconds())
success := "true"
if *err != nil {
success = "false"
}
operationDurationInMsSummary.WithLabelValues(operation, success).Observe(endTimeMS)
}
}
func recordTransactionTiming(txn *storage.VolumeTransaction, err *error) {
if txn == nil || txn.VolumeCreatingConfig == nil {
// for unit tests, there will be no txn to record
return
}
operation := "transaction_volume_finish"
startTime := txn.VolumeCreatingConfig.StartTime
endTime := time.Since(startTime)
endTimeMS := float64(endTime.Milliseconds())
success := "true"
if *err != nil {
success = "false"
}
operationDurationInMsSummary.WithLabelValues(operation, success).Observe(endTimeMS)
}
type TridentOrchestrator struct {
backends map[string]storage.Backend // key is UUID, not name
volumes map[string]*storage.Volume
subordinateVolumes map[string]*storage.Volume
frontends map[string]frontend.Plugin
mutex *sync.Mutex
storageClasses map[string]*storageclass.StorageClass
nodes map[string]*utils.Node
volumePublications *cache.VolumePublicationCache
snapshots map[string]*storage.Snapshot
storeClient persistentstore.Client
bootstrapped bool
bootstrapError error
txnMonitorTicker *time.Ticker
txnMonitorChannel chan struct{}
txnMonitorStopped bool
lastNodeRegistration time.Time
lastVolumePublication time.Time
volumePublicationsSynced bool
stopNodeAccessLoop chan bool
uuid string
}
// NewTridentOrchestrator returns a storage orchestrator instance
func NewTridentOrchestrator(client persistentstore.Client) *TridentOrchestrator {
return &TridentOrchestrator{
backends: make(map[string]storage.Backend), // key is UUID, not name
volumes: make(map[string]*storage.Volume),
subordinateVolumes: make(map[string]*storage.Volume),
frontends: make(map[string]frontend.Plugin),
storageClasses: make(map[string]*storageclass.StorageClass),
nodes: make(map[string]*utils.Node),
volumePublications: cache.NewVolumePublicationCache(),
snapshots: make(map[string]*storage.Snapshot), // key is ID, not name
mutex: &sync.Mutex{},
storeClient: client,
bootstrapped: false,
bootstrapError: utils.NotReadyError(),
}
}
func (o *TridentOrchestrator) transformPersistentState(ctx context.Context) error {
version, err := o.storeClient.GetVersion(ctx)
if err != nil && persistentstore.MatchKeyNotFoundErr(err) {
// Persistent store and Trident API versions should be crdv1 and v1 respectively.
version = &config.PersistentStateVersion{
PersistentStoreVersion: string(persistentstore.CRDV1Store),
OrchestratorAPIVersion: config.OrchestratorAPIVersion,
PublicationsSynced: o.volumePublicationsSynced,
}
Logc(ctx).WithFields(log.Fields{
"PersistentStoreVersion": version.PersistentStoreVersion,
"OrchestratorAPIVersion": version.OrchestratorAPIVersion,
}).Warning("Persistent state version not found, creating.")
} else if err != nil {
return fmt.Errorf("couldn't determine the orchestrator persistent state version: %v", err)
}
if config.OrchestratorAPIVersion != version.OrchestratorAPIVersion {
Logc(ctx).WithFields(log.Fields{
"current_api_version": version.OrchestratorAPIVersion,
"desired_api_version": config.OrchestratorAPIVersion,
}).Info("Transforming Trident API objects on the persistent store.")
// TODO: transform Trident API objects
}
// Store the persistent store and API versions
version.PersistentStoreVersion = string(o.storeClient.GetType())
version.OrchestratorAPIVersion = config.OrchestratorAPIVersion
if err = o.storeClient.SetVersion(ctx, version); err != nil {
return fmt.Errorf("failed to set the persistent state version after migration: %v", err)
}
return nil
}
func (o *TridentOrchestrator) Bootstrap(monitorTransactions bool) error {
ctx := GenerateRequestContext(context.Background(), "", ContextSourceInternal)
var err error
if len(o.frontends) == 0 {
log.Warning("Trident is bootstrapping with no frontend.")
}
// Transform persistent state, if necessary
if err = o.transformPersistentState(ctx); err != nil {
o.bootstrapError = utils.BootstrapError(err)
return o.bootstrapError
}
// Set UUID
o.uuid, err = o.storeClient.GetTridentUUID(ctx)
if err != nil {
o.bootstrapError = utils.BootstrapError(err)
return o.bootstrapError
}
// Bootstrap state from persistent store
if err = o.bootstrap(ctx); err != nil {
o.bootstrapError = utils.BootstrapError(err)
return o.bootstrapError
}
if monitorTransactions {
// Start transaction monitor
o.StartTransactionMonitor(ctx, txnMonitorPeriod, txnMonitorMaxAge)
}
o.bootstrapped = true
o.bootstrapError = nil
log.Infof("%s bootstrapped successfully.", utils.Title(config.OrchestratorName))
return nil
}
func (o *TridentOrchestrator) bootstrapBackends(ctx context.Context) error {
persistentBackends, err := o.storeClient.GetBackends(ctx)
if err != nil {
return err
}
for _, b := range persistentBackends {
Logc(ctx).WithFields(log.Fields{
"persistentBackend.Name": b.Name,
"persistentBackend.BackendUUID": b.BackendUUID,
"persistentBackend.online": b.Online,
"persistentBackend.state": b.State,
"persistentBackend.configRef": b.ConfigRef,
"handler": "Bootstrap",
}).Debug("Processing backend.")
// TODO: If the API evolves, check the Version field here.
serializedConfig, err := b.MarshalConfig()
if err != nil {
return err
}
newBackendExternal, backendErr := o.addBackend(ctx, serializedConfig, b.BackendUUID, b.ConfigRef)
if backendErr == nil {
newBackendExternal.BackendUUID = b.BackendUUID
} else {
errorLogFields := log.Fields{
"handler": "Bootstrap",
"newBackendExternal": newBackendExternal,
"backendErr": backendErr.Error(),
}
// Trident for Docker supports one backend at a time, and the Docker volume plugin
// should not start if the backend fails to initialize, so return any error here.
if config.CurrentDriverContext == config.ContextDocker {
Logc(ctx).WithFields(errorLogFields).Error("Problem adding backend.")
return backendErr
}
Logc(ctx).WithFields(errorLogFields).Warn("Problem adding backend.")
if newBackendExternal != nil {
newBackend, _ := o.validateAndCreateBackendFromConfig(ctx, serializedConfig, b.ConfigRef, b.BackendUUID)
newBackend.SetName(b.Name)
newBackendExternal.Name = b.Name // have to set it explicitly, so it's not ""
o.backends[newBackendExternal.BackendUUID] = newBackend
Logc(ctx).WithFields(log.Fields{
"newBackendExternal": newBackendExternal,
"newBackendExternal.Name": newBackendExternal.Name,
"newBackendExternal.State": newBackendExternal.State.String(),
"newBackendExternal.BackendUUID": newBackendExternal.BackendUUID,
"persistentBackend.Name": b.Name,
"persistentBackend.State": b.State.String(),
"persistentBackend.BackendUUID": b.BackendUUID,
}).Debug("Backend information.")
}
}
// Note that addBackend returns an external copy of the newly
// added backend, so we have to go fetch it manually.
newBackend, found := o.backends[b.BackendUUID]
if found {
newBackend.SetOnline(b.Online)
if backendErr != nil {
newBackend.SetState(storage.Failed)
} else {
if b.State == storage.Deleting {
newBackend.SetState(storage.Deleting)
}
}
Logc(ctx).WithFields(log.Fields{
"backend": newBackend.Name(),
"backendUUID": newBackend.BackendUUID(),
"configRef": newBackend.ConfigRef(),
"persistentBackends.BackendUUID": b.BackendUUID,
"online": newBackend.Online(),
"state": newBackend.State(),
"handler": "Bootstrap",
}).Info("Added an existing backend.")
} else {
Logc(ctx).WithFields(log.Fields{
"b.BackendUUID": b.BackendUUID,
}).Warn("Could not find backend.")
continue
}
}
return nil
}
func (o *TridentOrchestrator) bootstrapStorageClasses(ctx context.Context) error {
persistentStorageClasses, err := o.storeClient.GetStorageClasses(ctx)
if err != nil {
return err
}
for _, psc := range persistentStorageClasses {
// TODO: If the API evolves, check the Version field here.
sc := storageclass.NewFromPersistent(psc)
Logc(ctx).WithFields(log.Fields{
"storageClass": sc.GetName(),
"handler": "Bootstrap",
}).Info("Added an existing storage class.")
o.storageClasses[sc.GetName()] = sc
for _, b := range o.backends {
sc.CheckAndAddBackend(ctx, b)
}
}
return nil
}
// Updates the o.volumes cache with the latest backend data. This function should only edit o.volumes in place to avoid
// briefly losing track of volumes that do exist.
func (o *TridentOrchestrator) bootstrapVolumes(ctx context.Context) error {
volumes, err := o.storeClient.GetVolumes(ctx)
if err != nil {
return err
}
// Remove extra volumes in list
volNames := make([]string, 0)
for _, v := range volumes {
volNames = append(volNames, v.Config.Name)
}
for k := range o.volumes {
if !utils.SliceContainsString(volNames, k) {
delete(o.volumes, k)
}
}
volCount := 0
for _, v := range volumes {
// TODO: If the API evolves, check the Version field here.
var backend storage.Backend
var ok bool
vol := storage.NewVolume(v.Config, v.BackendUUID, v.Pool, v.Orphaned, v.State)
if vol.IsSubordinate() {
o.subordinateVolumes[vol.Config.Name] = vol
} else {
o.volumes[vol.Config.Name] = vol
if backend, ok = o.backends[v.BackendUUID]; !ok {
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
"backendUUID": v.BackendUUID,
}).Warning("Couldn't find backend. Setting state to MissingBackend.")
vol.State = storage.VolumeStateMissingBackend
} else {
backend.Volumes()[vol.Config.Name] = vol
if fakeDriver, ok := backend.Driver().(*fake.StorageDriver); ok {
fakeDriver.BootstrapVolume(ctx, vol)
}
}
}
Logc(ctx).WithFields(log.Fields{
"volume": vol.Config.Name,
"internalName": vol.Config.InternalName,
"size": vol.Config.Size,
"backendUUID": vol.BackendUUID,
"pool": vol.Pool,
"orphaned": vol.Orphaned,
"state": vol.State,
"handler": "Bootstrap",
}).Trace("Added an existing volume.")
volCount++
}
Logc(ctx).Infof("Added %v existing volume(s)", volCount)
return nil
}
func (o *TridentOrchestrator) bootstrapSnapshots(ctx context.Context) error {
snapshots, err := o.storeClient.GetSnapshots(ctx)
if err != nil {
return err
}
for _, s := range snapshots {
// TODO: If the API evolves, check the Version field here.
snapshot := storage.NewSnapshot(s.Config, s.Created, s.SizeBytes, s.State)
o.snapshots[snapshot.ID()] = snapshot
volume, ok := o.volumes[s.Config.VolumeName]
if !ok {
Logc(ctx).Warnf("Couldn't find volume %s for snapshot %s. Setting snapshot state to MissingVolume.",
s.Config.VolumeName, s.Config.Name)
snapshot.State = storage.SnapshotStateMissingVolume
} else {
backend, ok := o.backends[volume.BackendUUID]
if !ok {
snapshot.State = storage.SnapshotStateMissingBackend
} else {
if fakeDriver, ok := backend.Driver().(*fake.StorageDriver); ok {
fakeDriver.BootstrapSnapshot(ctx, snapshot, volume.Config)
}
}
}
Logc(ctx).WithFields(log.Fields{
"snapshot": snapshot.Config.Name,
"volume": snapshot.Config.VolumeName,
"handler": "Bootstrap",
}).Info("Added an existing snapshot.")
}
return nil
}
func (o *TridentOrchestrator) bootstrapVolTxns(ctx context.Context) error {
volTxns, err := o.storeClient.GetVolumeTransactions(ctx)
if err != nil && !persistentstore.MatchKeyNotFoundErr(err) {
Logc(ctx).Warnf("Couldn't retrieve volume transaction logs: %s", err.Error())
}
for _, v := range volTxns {
o.mutex.Lock()
err = o.handleFailedTransaction(ctx, v)
o.mutex.Unlock()
if err != nil {
return err
}
}
return nil
}
func (o *TridentOrchestrator) bootstrapNodes(ctx context.Context) error {
// Don't bootstrap nodes if we're not CSI
if config.CurrentDriverContext != config.ContextCSI {
return nil
}
nodes, err := o.storeClient.GetNodes(ctx)
if err != nil {
return err
}
for _, n := range nodes {
Logc(ctx).WithFields(log.Fields{
"node": n.Name,
"handler": "Bootstrap",
}).Info("Added an existing node.")
o.nodes[n.Name] = n
}
err = o.reconcileNodeAccessOnAllBackends(ctx)
if err != nil {
Logc(ctx).Warningf("%v", err)
}
return nil
}
func (o *TridentOrchestrator) bootstrapVolumePublications(ctx context.Context) error {
// Don't bootstrap volume publications if we're not CSI
if config.CurrentDriverContext != config.ContextCSI {
return nil
}
bootstrapErrors := make([]error, 0)
volumePublications, err := o.storeClient.GetVolumePublications(ctx)
if err != nil {
return err
}
for _, vp := range volumePublications {
fields := log.Fields{
"volume": vp.VolumeName,
"node": vp.NodeName,
"handler": "Bootstrap",
}
Logc(ctx).WithFields(fields).Debug("Added an existing volume publication.")
err = o.volumePublications.Set(vp.VolumeName, vp.NodeName, vp)
if err != nil {
bootstrapErr := fmt.Errorf("unable to bootstrap volume publication %s; %v", vp.Name, err)
bootstrapErrors = append(bootstrapErrors, bootstrapErr)
Logc(ctx).WithFields(fields).WithError(bootstrapErr).Error("Unable to add an existing volume publication.")
}
}
return multierr.Combine(bootstrapErrors...)
}
// bootstrapSubordinateVolumes updates the source volumes to point to their subordinates. Updating the
// super->sub references here allows us to persist only the scalar sub->super references.
func (o *TridentOrchestrator) bootstrapSubordinateVolumes(ctx context.Context) error {
for volumeName, volume := range o.subordinateVolumes {
// Get the source volume
sourceVolume, ok := o.volumes[volume.Config.ShareSourceVolume]
if !ok {
Logc(ctx).WithFields(log.Fields{
"subordinateVolume": volumeName,
"sourceVolume": volume.Config.ShareSourceVolume,
"handler": "Bootstrap",
}).Warning("Source volume for subordinate volume not found.")
continue
}
// Make the source volume point to the subordinate
if sourceVolume.Config.SubordinateVolumes == nil {
sourceVolume.Config.SubordinateVolumes = make(map[string]interface{})
}
sourceVolume.Config.SubordinateVolumes[volumeName] = nil
}
return nil
}
func (o *TridentOrchestrator) bootstrap(ctx context.Context) error {
// Fetching backend information
type bootstrapFunc func(context.Context) error
for _, f := range []bootstrapFunc{
o.bootstrapBackends, o.bootstrapStorageClasses, o.bootstrapVolumes, o.bootstrapSnapshots,
o.bootstrapVolTxns, o.bootstrapNodes, o.bootstrapVolumePublications, o.bootstrapSubordinateVolumes,
} {
err := f(ctx)
if err != nil {
if persistentstore.MatchKeyNotFoundErr(err) {
keyError, ok := err.(*persistentstore.Error)
if !ok {
return utils.TypeAssertionError("err.(*persistentstore.Error)")
}
Logc(ctx).Warnf("Unable to find key %s. Continuing bootstrap, but "+
"consider checking integrity if Trident installation is not new.", keyError.Key)
} else {
return err
}
}
}
// Clean up any offline backends that lack volumes. This can happen if
// a connection to the store fails when attempting to delete a backend.
for backendUUID, backend := range o.backends {
if backend.State().IsFailed() {
continue
}
if !backend.HasVolumes() && (backend.State().IsDeleting() || o.storeClient.IsBackendDeleting(ctx, backend)) {
backend.Terminate(ctx)
delete(o.backends, backendUUID)
err := o.storeClient.DeleteBackend(ctx, backend)
if err != nil {
return fmt.Errorf("failed to delete empty offline/deleting backend %s: %v", backendUUID, err)
}
}
}
// If nothing failed during bootstrapping, initialize the core metrics
o.updateMetrics()
return nil
}
// Stop stops the orchestrator core.
func (o *TridentOrchestrator) Stop() {
// Stop the node access reconciliation background task
if o.stopNodeAccessLoop != nil {
o.stopNodeAccessLoop <- true
}
// Stop transaction monitor
o.StopTransactionMonitor()
}
// updateMetrics updates the metrics that track the core objects.
// The caller should hold the orchestrator lock.
func (o *TridentOrchestrator) updateMetrics() {
tridentBuildInfo.WithLabelValues(config.BuildHash,
config.OrchestratorVersion.ShortString(),
config.BuildType).Set(float64(1))
backendsGauge.Reset()
tridentBackendInfo.Reset()
for _, backend := range o.backends {
if backend == nil {
continue
}
backendsGauge.WithLabelValues(backend.GetDriverName(), backend.State().String()).Inc()
tridentBackendInfo.WithLabelValues(backend.GetDriverName(), backend.Name(),
backend.BackendUUID()).Set(float64(1))
}
volumesGauge.Reset()
volumesTotalBytes := float64(0)
volumeAllocatedBytesGauge.Reset()
for _, volume := range o.volumes {
if volume == nil {
continue
}
bytes, _ := strconv.ParseFloat(volume.Config.Size, 64)
volumesTotalBytes += bytes
if backend, err := o.getBackendByBackendUUID(volume.BackendUUID); err == nil {
driverName := backend.GetDriverName()
volumesGauge.WithLabelValues(driverName,
volume.BackendUUID,
string(volume.State),
string(volume.Config.VolumeMode)).Inc()
volumeAllocatedBytesGauge.WithLabelValues(driverName, backend.BackendUUID(), string(volume.State),
string(volume.Config.VolumeMode)).Add(bytes)
}
}
volumesTotalBytesGauge.Set(volumesTotalBytes)
scGauge.Set(float64(len(o.storageClasses)))
nodeGauge.Set(float64(len(o.nodes)))
snapshotGauge.Reset()
snapshotAllocatedBytesGauge.Reset()
for _, snapshot := range o.snapshots {
vol := o.volumes[snapshot.Config.VolumeName]
if vol != nil {
if backend, err := o.getBackendByBackendUUID(vol.BackendUUID); err == nil {
driverName := backend.GetDriverName()
snapshotGauge.WithLabelValues(
driverName,
vol.BackendUUID).Inc()
snapshotAllocatedBytesGauge.WithLabelValues(driverName, backend.BackendUUID()).
Add(float64(snapshot.SizeBytes))
}
}
}
}
func (o *TridentOrchestrator) handleFailedTransaction(ctx context.Context, v *storage.VolumeTransaction) error {
switch v.Op {
case storage.AddVolume, storage.DeleteVolume,
storage.ImportVolume, storage.ResizeVolume:
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
"size": v.Config.Size,
"storageClass": v.Config.StorageClass,
"op": v.Op,
}).Info("Processed volume transaction log.")
case storage.AddSnapshot, storage.DeleteSnapshot:
Logc(ctx).WithFields(log.Fields{
"volume": v.SnapshotConfig.VolumeName,
"snapshot": v.SnapshotConfig.Name,
"op": v.Op,
}).Info("Processed snapshot transaction log.")
case storage.UpgradeVolume:
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
"PVC": v.PVUpgradeConfig.PVCConfig.Name,
"PV": v.PVUpgradeConfig.PVConfig.Name,
"op": v.Op,
}).Info("Processed volume upgrade transaction log.")
case storage.VolumeCreating:
Logc(ctx).WithFields(log.Fields{
"volume": v.VolumeCreatingConfig.Name,
"backendUUID": v.VolumeCreatingConfig.BackendUUID,
"op": v.Op,
}).Info("Processed volume creating transaction log.")
}
switch v.Op {
case storage.AddVolume:
// Regardless of whether the transaction succeeded or not, we need
// to roll it back. There are three possible states:
// 1) Volume transaction created only
// 2) Volume created on backend
// 3) Volume created in the store.
if _, ok := o.volumes[v.Config.Name]; ok {
// If the volume was added to the store, we will have loaded the
// volume into memory, and we can just delete it normally.
// Handles case 3)
err := o.deleteVolume(ctx, v.Config.Name)
if err != nil {
return fmt.Errorf("unable to clean up volume %s: %v", v.Config.Name, err)
}
} else {
// If the volume wasn't added into the store, we attempt to delete
// it at each backend, since we don't know where it might have
// landed. We're guaranteed that the volume name will be
// unique across backends, thanks to the StoragePrefix field,
// so this should be idempotent.
// Handles case 2)
for _, backend := range o.backends {
// Backend offlining is serialized with volume creation,
// so we can safely skip offline backends.
if !backend.State().IsOnline() && !backend.State().IsDeleting() {
continue
}
// Volume deletion is an idempotent operation, so it's safe to
// delete an already deleted volume.
if err := backend.RemoveVolume(ctx, v.Config); err != nil {
return fmt.Errorf("error attempting to clean up volume %s from backend %s: %v", v.Config.Name,
backend.Name(), err)
}
}
}
// Finally, we need to clean up the volume transaction.
// Necessary for all cases.
if err := o.DeleteVolumeTransaction(ctx, v); err != nil {
return fmt.Errorf("failed to clean up volume addition transaction: %v", err)
}
case storage.DeleteVolume:
// Because we remove the volume from persistent store after we remove
// it from the backend, we need to take any special measures only when
// the volume is still in the persistent store. In this case, the
// volume should have been loaded into memory when we bootstrapped.
if _, ok := o.volumes[v.Config.Name]; ok {
err := o.deleteVolume(ctx, v.Config.Name)
if err != nil {
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
"error": err,
}).Errorf("Unable to finalize deletion of the volume! Repeat deleting the volume using %s.",
config.OrchestratorClientName)
}
} else {
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
}).Info("Volume for the delete transaction wasn't found.")
}
if err := o.DeleteVolumeTransaction(ctx, v); err != nil {
return fmt.Errorf("failed to clean up volume deletion transaction: %v", err)
}
case storage.AddSnapshot:
// Regardless of whether the transaction succeeded or not, we need
// to roll it back. There are three possible states:
// 1) Snapshot transaction created only
// 2) Snapshot created on backend
// 3) Snapshot created in persistent store
if _, ok := o.snapshots[v.SnapshotConfig.ID()]; ok {
// If the snapshot was added to the store, we will have loaded the
// snapshot into memory, and we can just delete it normally.
// Handles case 3)
if err := o.deleteSnapshot(ctx, v.SnapshotConfig); err != nil {
return fmt.Errorf("unable to clean up snapshot %s: %v", v.SnapshotConfig.Name, err)
}
} else {
// If the snapshot wasn't added into the store, we attempt to delete
// it at each backend, since we don't know where it might have landed.
// We're guaranteed that the volume name will be unique across backends,
// thanks to the StoragePrefix field, so this should be idempotent.
// Handles case 2)
for _, backend := range o.backends {
// Skip backends that aren't ready to accept a snapshot delete operation
if !backend.State().IsOnline() && !backend.State().IsDeleting() {
continue
}
// Snapshot deletion is an idempotent operation, so it's safe to
// delete an already deleted snapshot.
err := backend.DeleteSnapshot(ctx, v.SnapshotConfig, v.Config)
if err != nil && !utils.IsUnsupportedError(err) {
return fmt.Errorf("error attempting to clean up snapshot %s from backend %s: %v",
v.SnapshotConfig.Name, backend.Name(), err)
}
}
}
// Finally, we need to clean up the snapshot transaction. Necessary for all cases.
if err := o.DeleteVolumeTransaction(ctx, v); err != nil {
return fmt.Errorf("failed to clean up snapshot addition transaction: %v", err)
}
case storage.DeleteSnapshot:
// Because we remove the snapshot from persistent store after we remove
// it from the backend, we need to take any special measures only when
// the snapshot is still in the persistent store. In this case, the
// snapshot, volume, and backend should all have been loaded into memory
// when we bootstrapped and we can retry the snapshot deletion.
logFields := log.Fields{"volume": v.SnapshotConfig.VolumeName, "snapshot": v.SnapshotConfig.Name}
if err := o.deleteSnapshot(ctx, v.SnapshotConfig); err != nil {
if utils.IsNotFoundError(err) {
Logc(ctx).WithFields(logFields).Info("Snapshot for the delete transaction wasn't found.")
} else {
Logc(ctx).WithFields(logFields).Errorf("Unable to finalize deletion of the snapshot! "+
"Repeat deleting the snapshot using %s.", config.OrchestratorClientName)
}
}
if err := o.DeleteVolumeTransaction(ctx, v); err != nil {
return fmt.Errorf("failed to clean up snapshot deletion transaction: %v", err)
}
case storage.ResizeVolume:
// There are a few possible states:
// 1) We failed to resize the volume on the backend.
// 2) We successfully resized the volume on the backend.
// 2a) We couldn't update the volume size in persistent store.
// 2b) Persistent store was updated, but we couldn't delete the
// transaction object.
var err error
vol, ok := o.volumes[v.Config.Name]
if ok {
err = o.resizeVolume(ctx, vol, v.Config.Size)
if err != nil {
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
"error": err,
}).Error("Unable to resize the volume! Repeat resizing the volume.")
} else {
Logc(ctx).WithFields(log.Fields{
"volume": vol.Config.Name,
"volume_size": v.Config.Size,
}).Info("Orchestrator resized the volume on the storage backend.")
}
} else {
Logc(ctx).WithFields(log.Fields{
"volume": v.Config.Name,
}).Error("Volume for the resize transaction wasn't found.")
}
return o.resizeVolumeCleanup(ctx, err, vol, v)
case storage.ImportVolume:
/*
There are a few possible states:
1) We created a PVC.
2) We created a PVC and renamed the volume on the backend.
3) We created a PVC, renamed the volume, and persisted the volume.
4) We created a PVC, renamed the vol, persisted the vol, and created a PV
To handle these states:
1) Do nothing. If the PVC is still needed,
k8s will trigger us to try and perform the import again; if not,
it is up to the user to remove the unwanted PVC.
2) We will rename the volume on the backend back to its original name,
to allow for future retries to find it; or if the user aborts the import by removing the PVC,
then the volume is back in its original state.
3) Same is (2) but now we also remove the volume from Trident's persistent store.
4) Same as (3).
If the import failed the PVC and PV should be cleaned up by the K8S frontend code.
There is a situation where the PVC/PV bind operation may fail after the import operation is complete.
In this case the end user needs to delete the PVC and PV via kubectl.
The volume import process sets the reclaim policy to "retain" by default,
for legacy imports. In the case where notManaged is true then the volume is not renamed,
and in the legacy import case it is also not persisted.
*/
if volume, ok := o.volumes[v.Config.Name]; ok {
if err := o.deleteVolumeFromPersistentStoreIgnoreError(ctx, volume); err != nil {
return err
}
delete(o.volumes, v.Config.Name)
}
if !v.Config.ImportNotManaged {
if err := o.resetImportedVolumeName(ctx, v.Config); err != nil {
return err
}
}
// Finally, we need to clean up the volume transactions
if err := o.DeleteVolumeTransaction(ctx, v); err != nil {
return fmt.Errorf("failed to clean up volume addition transaction: %v", err)
}
case storage.UpgradeVolume, storage.VolumeCreating:
// Do nothing
}
return nil
}
func (o *TridentOrchestrator) resetImportedVolumeName(ctx context.Context, volume *storage.VolumeConfig) error {
// The volume could be renamed (notManaged = false) without being persisted.
// If the volume wasn't added to the persistent store, we attempt to rename
// it at each backend, since we don't know where it might have
// landed. We're guaranteed that the volume name will be
// unique across backends, thanks to the StoragePrefix field,
// so this should be idempotent.
for _, backend := range o.backends {
if err := backend.RenameVolume(ctx, volume, volume.ImportOriginalName); err == nil {
return nil
}
}
Logc(ctx).Debugf("could not find volume %s to reset the volume name", volume.InternalName)
return nil
}
func (o *TridentOrchestrator) AddFrontend(f frontend.Plugin) {
name := f.GetName()
if _, ok := o.frontends[name]; ok {
log.WithField("name", name).Warn("Adding frontend already present.")
return
}
log.WithField("name", name).Info("Added frontend.")
o.frontends[name] = f
}
func (o *TridentOrchestrator) GetFrontend(ctx context.Context, name string) (frontend.Plugin, error) {
if fe, ok := o.frontends[name]; !ok {
err := fmt.Errorf("requested frontend %s does not exist", name)
return nil, err
} else {
Logc(ctx).WithField("name", name).Debug("Found requested frontend.")
return fe, nil
}
}
func (o *TridentOrchestrator) validateBackendUpdate(oldBackend, newBackend storage.Backend) error {
// Validate that backend type isn't being changed as backend type has
// implications for the internal volume names.
if oldBackend.GetDriverName() != newBackend.GetDriverName() {
return fmt.Errorf(
"cannot update the backend as the old backend is of type %s and the new backend is of type %s",
oldBackend.GetDriverName(), newBackend.GetDriverName())
}
return nil
}
func (o *TridentOrchestrator) GetVersion(context.Context) (string, error) {
return config.OrchestratorVersion.String(), o.bootstrapError
}
// AddBackend handles creation of a new storage backend
func (o *TridentOrchestrator) AddBackend(
ctx context.Context, configJSON, configRef string,
) (backendExternal *storage.BackendExternal, err error) {
if o.bootstrapError != nil {
return nil, o.bootstrapError
}
defer recordTiming("backend_add", &err)()
o.mutex.Lock()
defer o.mutex.Unlock()
defer o.updateMetrics()
backend, err := o.addBackend(ctx, configJSON, uuid.New().String(), configRef)
if err != nil {
return backend, err
}
b, err := o.getBackendByBackendUUID(backend.BackendUUID)
if err != nil {
return backend, err
}
err = o.reconcileNodeAccessOnBackend(ctx, b)
if err != nil {
return backend, err
}
return backend, nil
}
// addBackend creates a new storage backend. It assumes the mutex lock is
// already held or not required (e.g., during bootstrapping).
func (o *TridentOrchestrator) addBackend(
ctx context.Context, configJSON, backendUUID, configRef string,
) (backendExternal *storage.BackendExternal, err error) {
var (
newBackend = true
backend storage.Backend
)
defer func() {
if backend != nil {
if err != nil || !newBackend {
backend.Terminate(ctx)
}
}
}()
backend, err = o.validateAndCreateBackendFromConfig(ctx, configJSON, configRef, backendUUID)
if err != nil {
Logc(ctx).WithFields(log.Fields{
"err": err.Error(),
"backend": backend,
"backendUUID": backendUUID,
"configRef": configRef,
}).Debug("NewStorageBackendForConfig failed.")
if backend != nil && backend.State().IsFailed() {
return backend.ConstructExternal(ctx), err
}
return nil, err
}
// can we find this backend by UUID? (if so, it's an update)
foundBackend := o.backends[backend.BackendUUID()]
if foundBackend != nil {
// Let the updateBackend method handle an existing backend
newBackend = false
return o.updateBackend(ctx, backend.Name(), configJSON, configRef)
}
// can we find this backend by name instead of UUID? (if so, it's also an update)
foundBackend, _ = o.getBackendByBackendName(backend.Name())
if foundBackend != nil {
// Let the updateBackend method handle an existing backend
newBackend = false
return o.updateBackend(ctx, backend.Name(), configJSON, configRef)
}
if configRef != "" {
// can we find this backend by configRef (if so, then something is wrong)
foundBackend, _ := o.getBackendByConfigRef(configRef)
if foundBackend != nil {
// IDEALLY WE SHOULD NOT BE HERE:
// If we are here it means that there already exists a backend with the
// given configRef but the backendName and backendUUID of that backend
// do not match backend.Name() or the backend.BackendUUID(), this can only
// happen with a newly created tbc which failed to updated status
// on success and had a name change in the next reconcile loop.
Logc(ctx).WithFields(log.Fields{
"backendName": foundBackend.Name(),
"backendUUID": foundBackend.BackendUUID(),
"newBackendName": backend.Name(),
"newbackendUUID": backend.BackendUUID(),
}).Debug("Backend found by configRef.")
// Let the updateBackend method handle an existing backend
newBackend = false
return o.updateBackend(ctx, foundBackend.Name(), configJSON, configRef)
}
}