-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathdatabaseclaim.go
1337 lines (1134 loc) · 47.6 KB
/
databaseclaim.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package databaseclaim
import (
"context"
"fmt"
"strings"
"time"
crossplaneaws "github.com/crossplane-contrib/provider-aws/apis/rds/v1alpha1"
xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
"github.com/go-logr/logr"
_ "github.com/lib/pq"
gopassword "github.com/sethvargo/go-password/password"
"github.com/spf13/viper"
crossplanegcp "github.com/upbound/provider-gcp/apis/alloydb/v1beta2"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/log"
v1 "github.com/infobloxopen/db-controller/api/v1"
"github.com/infobloxopen/db-controller/pkg/auth"
basefun "github.com/infobloxopen/db-controller/pkg/basefunctions"
"github.com/infobloxopen/db-controller/pkg/dbclient"
"github.com/infobloxopen/db-controller/pkg/dbuser"
"github.com/infobloxopen/db-controller/pkg/hostparams"
"github.com/infobloxopen/db-controller/pkg/kctlutils"
"github.com/infobloxopen/db-controller/pkg/metrics"
"github.com/infobloxopen/db-controller/pkg/pgctl"
exporter "github.com/infobloxopen/db-controller/pkg/postgres-exporter"
"github.com/infobloxopen/db-controller/pkg/rdsauth"
"k8s.io/apimachinery/pkg/api/errors"
)
var (
maxNameLen = 44 // max length of dbclaim name
serviceNamespaceEnvVar = "SERVICE_NAMESPACE"
defaultRestoreFromSource = "Snapshot"
defaultBackupPolicyKey = "Backup"
tempTargetPassword = "targetPassword"
tempSourceDsn = "sourceDsn"
tempTargetDsn = "targetDsn"
cachedMasterPasswdForExistingDB = "cachedMasterPasswdForExistingDB"
masterSecretSuffix = "-master"
masterPasswordKey = "password"
// debugLevel is used to set V level to 1 as suggested by official docs
// https://github.com/kubernetes-sigs/controller-runtime/blob/main/TMP-LOGGING.md
debugLevel = 1
// FIXME: remove references to private variables
OperationalStatusTagKey string = "operational-status"
OperationalStatusInactiveValue string = "inactive"
OperationalStatusActiveValue string = "active"
)
var (
ErrMaxNameLen = fmt.Errorf("dbclaim name is too long. max length is 44 characters")
ErrInvalidDSNName = fmt.Errorf("dsn name must be: %s", v1.DSNKey)
)
// DatabaseClaimConfig is the configuration for the DatabaseClaimReconciler.
type DatabaseClaimConfig struct {
Viper *viper.Viper
MasterAuth *rdsauth.MasterAuth
Class string
Namespace string
MetricsEnabled bool
MetricsDepYamlPath string
MetricsConfigYamlPath string
}
// DatabaseClaimReconciler reconciles a DatabaseClaim object
type DatabaseClaimReconciler struct {
client.Client
Config *DatabaseClaimConfig
kctl *kctlutils.Client
statusManager *StatusManager
}
// New returns a configured databaseclaim reconciler
func New(cli client.Client, cfg *DatabaseClaimConfig) *DatabaseClaimReconciler {
return &DatabaseClaimReconciler{
Client: cli,
Config: cfg,
kctl: kctlutils.New(cli, cfg.Viper.GetString("SERVICE_NAMESPACE")),
statusManager: NewStatusManager(cli, cfg.Viper),
}
}
// isClassPermitted can not modify the claim class as it can
// cause k8s updates in cluster
func isClassPermitted(ctrlClass string, ptrClaimClass *string) bool {
var claimClass string
if ptrClaimClass == nil {
claimClass = "default"
} else {
claimClass = *ptrClaimClass
}
return claimClass == ctrlClass
}
// validateDBClaim should validate deprecated and or unsupported values in a claim object
func validateDBClaim(dbClaim *v1.DatabaseClaim) error {
// envtest will send default values as empty strings, provide an in-process
// update to ensure downstream code works
if dbClaim.Spec.DSNName == "" {
dbClaim.Spec.DSNName = v1.DSNKey
}
if dbClaim.Spec.DSNName != v1.DSNKey {
return ErrInvalidDSNName
}
return nil
}
// Reconcile is the main reconciliation function for the DatabaseClaimReconciler.
func (r *DatabaseClaimReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logr := log.FromContext(ctx)
var dbClaim v1.DatabaseClaim
if err := r.Get(ctx, req.NamespacedName, &dbClaim); err != nil {
if client.IgnoreNotFound(err) != nil {
logr.Error(err, "unable to fetch DatabaseClaim")
return ctrl.Result{}, err
} else {
logr.Info("DatabaseClaim not found. Ignoring since object might have been deleted")
return ctrl.Result{}, nil
}
}
// Avoid updates to the claim until we know we should be looking at it
if !isClassPermitted(r.Config.Class, dbClaim.Spec.Class) {
logr.V(debugLevel).Info("class_not_owned", "class", dbClaim.Spec.Class, "expected", r.Config.Class)
return ctrl.Result{}, nil
}
if err := validateDBClaim(&dbClaim); err != nil {
// Validation is weak until all apps are moved to new API
logr.Error(err, "dbclaim_failed_validation")
// FIXME: mark the claim status as error
}
if dbClaim.Spec.Class == nil {
dbClaim.Spec.Class = ptr.To("default")
}
logr.Info("reconcile")
if dbClaim.Status.ActiveDB.ConnectionInfo == nil {
dbClaim.Status.ActiveDB.ConnectionInfo = new(v1.DatabaseClaimConnectionInfo)
}
if dbClaim.Status.NewDB.ConnectionInfo == nil {
dbClaim.Status.NewDB.ConnectionInfo = new(v1.DatabaseClaimConnectionInfo)
}
reqInfo, err := NewRequestInfo(ctx, r.Config.Viper, &dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, &dbClaim, err)
}
// name of our custom finalizer
dbFinalizerName := "databaseclaims.persistance.atlas.infoblox.com/finalizer"
if !dbClaim.ObjectMeta.DeletionTimestamp.IsZero() {
// The object is being deleted
if controllerutil.ContainsFinalizer(&dbClaim, dbFinalizerName) {
logr.Info("clean_up_finalizer")
err_ := r.statusManager.SetConditionAndUpdateStatus(ctx, &dbClaim, v1.DeletingCondition())
if err_ != nil {
return ctrl.Result{}, err_
}
// check if the claim is in the middle of rds migration, if so, wait for it to complete
if dbClaim.Status.MigrationState != "" && dbClaim.Status.MigrationState != pgctl.S_Completed.String() {
logr.Info("migration is in progress. object cannot be deleted")
dbClaim.Status.Error = "dbc cannot be deleted while migration is in progress"
err := r.Client.Status().Update(ctx, &dbClaim)
if err != nil {
logr.Error(err, "unable to update status. ignoring this error")
}
//ignore delete request, continue to process rds migration
return r.executeDbClaimRequest(ctx, &reqInfo, &dbClaim)
}
if basefun.GetCloud(r.Config.Viper) == "aws" {
// our finalizer is present, so lets handle any external dependency
if err := r.deleteExternalResourcesAWS(ctx, &reqInfo, &dbClaim); err != nil {
// if fail to delete the external dependency here, return with error
// so that it can be retried
return ctrl.Result{}, err
}
} else {
// our finalizer is present, so lets handle any external dependency
if err := r.deleteExternalResourcesGCP(ctx, &reqInfo, &dbClaim); err != nil {
// if fail to delete the external dependency here, return with error
// so that it can be retried
return ctrl.Result{}, err
}
}
// remove our finalizer from the list and update it.
controllerutil.RemoveFinalizer(&dbClaim, dbFinalizerName)
if err := r.Update(ctx, &dbClaim); err != nil {
return ctrl.Result{}, err
}
}
// Stop reconciliation as the item is being deleted
return ctrl.Result{}, nil
}
// The object is not being deleted, so if it does not have our finalizer,
// then lets add the finalizer and update the object. This is equivalent
// registering our finalizer.
if !controllerutil.ContainsFinalizer(&dbClaim, dbFinalizerName) {
controllerutil.AddFinalizer(&dbClaim, dbFinalizerName)
if err := r.Update(ctx, &dbClaim); err != nil {
return ctrl.Result{}, err
}
}
if r.Config.MetricsEnabled {
if err := r.createMetricsDeployment(ctx, dbClaim); err != nil {
return ctrl.Result{}, err
}
}
res, err := r.executeDbClaimRequest(ctx, &reqInfo, &dbClaim)
if err != nil {
return res, err
}
return res, nil
}
func (r *DatabaseClaimReconciler) createMetricsDeployment(ctx context.Context, dbClaim v1.DatabaseClaim) error {
cfg := exporter.NewConfig()
cfg.Name = dbClaim.ObjectMeta.Name
cfg.Namespace = dbClaim.ObjectMeta.Namespace
cfg.DBClaimOwnerRef = string(dbClaim.ObjectMeta.UID)
cfg.DepYamlPath = r.Config.MetricsDepYamlPath
cfg.ConfigYamlPath = r.Config.MetricsConfigYamlPath
cfg.DatasourceSecretName = dbClaim.Spec.SecretName
cfg.DatasourceFileName = v1.DSNURIKey
cfg.DatabaseName = dbClaim.Spec.DatabaseName
cfg.Class = r.Config.Class
return exporter.Apply(ctx, r.Client, cfg)
}
func (r *DatabaseClaimReconciler) postMigrationInProgress(ctx context.Context, dbClaim *v1.DatabaseClaim) (ctrl.Result, error) {
logger := log.FromContext(ctx).WithValues("databaseclaim", dbClaim.Namespace+"/"+dbClaim.Name)
logger.Info("Post migration is in progress")
dbInstanceName := strings.Split(dbClaim.Status.OldDB.ConnectionInfo.Host, ".")[0]
isAurora := dbClaim.Status.OldDB.Type == v1.AuroraPostgres
dbVersionPrefix := strings.Split(dbClaim.Status.OldDB.DBVersion, ".")[0]
var dbParamGroupName string
if isAurora {
dbParamGroupName = dbInstanceName + "-a-" + dbVersionPrefix
} else {
dbParamGroupName = dbInstanceName + "-" + dbVersionPrefix
}
tagsVerified, taggingErr := r.manageOperationalTagging(ctx, logger, dbInstanceName, dbParamGroupName, isAurora)
shouldDelete := taggingErr != nil || tagsVerified ||
time.Since(dbClaim.Status.OldDB.PostMigrationActionStartedAt.Time).Minutes() > 10
if taggingErr != nil {
logger.Error(taggingErr, "Failed updating or verifying operational tags")
}
if shouldDelete {
if taggingErr != nil && !tagsVerified {
logger.Info("Defined wait time is over to verify operational tags on AWS resources. Moving ahead to delete associated crossplane resources anyway")
}
if err := r.deleteParameterGroupAWS(ctx, dbParamGroupName); err != nil {
logger.Error(err, "Could not delete crossplane DBParamGroup")
}
if err := r.deleteCloudDatabaseAWS(dbInstanceName, ctx); err != nil {
logger.Error(err, "Could not delete crossplane DBInstance")
}
logger.Info("Deleted Crossplane DB custom resources", "dbParamGroupName", dbParamGroupName, "dbInstanceName", dbInstanceName)
dbClaim.Status.OldDB = v1.StatusForOldDB{}
}
if err := r.statusManager.ClearError(ctx, dbClaim); err != nil {
return ctrl.Result{}, err
}
if err := r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
return ctrl.Result{}, err
}
if !dbClaim.ObjectMeta.DeletionTimestamp.IsZero() {
return ctrl.Result{Requeue: true}, nil
}
return ctrl.Result{RequeueAfter: time.Minute}, nil
}
// Create, migrate or upgrade database
func (r *DatabaseClaimReconciler) executeDbClaimRequest(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim) (ctrl.Result, error) {
logr := log.FromContext(ctx).WithValues("databaseclaim", dbClaim.Namespace+"/"+dbClaim.Name)
operationMode := r.getMode(ctx, reqInfo, dbClaim)
if operationMode == M_NotSupported {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("unsupported operation requested"))
}
err := r.statusManager.UpdateStatus(ctx, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
if operationMode == M_PostMigrationInProgress {
result, err := r.postMigrationInProgress(ctx, dbClaim)
if err != nil {
r.statusManager.SetError(ctx, dbClaim, err)
}
return result, err
}
//when using an existing db, this is the first status, then it moves to M_MigrateExistingToNewDB and falls into the condition below
if operationMode == M_UseExistingDB {
logr.Info("existing db reconcile started")
err := r.reconcileUseExistingDB(ctx, reqInfo, dbClaim, operationMode)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
newDBCopy := dbClaim.Status.NewDB.DeepCopy()
dbClaim.Status.ActiveDB = *newDBCopy
dbClaim.Status.NewDB = v1.Status{}
if dbClaim.Status.ActiveDB.ConnectionInfo == nil {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("invalid new db connection"))
}
return r.statusManager.SuccessAndUpdateCondition(ctx, dbClaim)
}
if operationMode == M_MigrateExistingToNewDB {
logr.Info("migrate to new db reconcile started")
//check if existingDB has been already reconciled, else reconcileUseExistingDB
existingDbConn, err := v1.ParseUri(dbClaim.Spec.SourceDataFrom.Database.DSN)
logr.V(debugLevel).Info("M_MigrateExistingToNewDB", "dsn", basefun.SanitizeDsn(dbClaim.Spec.SourceDataFrom.Database.DSN))
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
activeConn := dbClaim.Status.ActiveDB.ConnectionInfo
if (activeConn.DatabaseName != existingDbConn.DatabaseName) ||
(activeConn.Host != existingDbConn.Host && activeConn.Port != existingDbConn.Port) {
logr.Info("existing db was not reconciled, calling reconcileUseExistingDB before reconcileMigrateToNewDB")
err := r.reconcileUseExistingDB(ctx, reqInfo, dbClaim, operationMode)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
dbClaim.Status.ActiveDB = *dbClaim.Status.NewDB.DeepCopy()
dbClaim.Status.NewDB = v1.Status{ConnectionInfo: &v1.DatabaseClaimConnectionInfo{}}
}
return r.reconcileMigrateToNewDB(ctx, reqInfo, dbClaim, operationMode)
}
if operationMode == M_InitiateDBUpgrade {
logr.Info("upgrade db initiated")
return r.reconcileMigrateToNewDB(ctx, reqInfo, dbClaim, operationMode)
}
if operationMode == M_MigrationInProgress || operationMode == M_UpgradeDBInProgress {
return r.reconcileMigrationInProgress(ctx, reqInfo, dbClaim, operationMode)
}
if operationMode == M_UseNewDB {
result, err := r.reconcileNewDB(ctx, reqInfo, dbClaim, operationMode)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
if result.RequeueAfter > 0 {
return result, nil
}
if reqInfo.TempSecret != "" {
newDBConnInfo := dbClaim.Status.NewDB.ConnectionInfo.DeepCopy()
newDBConnInfo.Password = reqInfo.TempSecret
if err := r.createOrUpdateSecret(ctx, dbClaim, newDBConnInfo, basefun.GetCloud(r.Config.Viper)); err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
}
dbClaim.Status.ActiveDB = *dbClaim.Status.NewDB.DeepCopy()
if reqInfo.SharedDBHost {
dbClaim.Status.ActiveDB.DbState = v1.UsingSharedHost
} else {
dbClaim.Status.ActiveDB.DbState = v1.Ready
}
dbClaim.Status.NewDB = v1.Status{}
return r.statusManager.ActiveDBSuccessReconcile(ctx, dbClaim)
}
logr.Error(fmt.Errorf("unhandled mode: %v", operationMode), "unhandled mode")
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("unhandled mode"))
}
// reconcileUseExistingDB reconciles the existing db
// bool indicates that object status should be updated
func (r *DatabaseClaimReconciler) reconcileUseExistingDB(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim, operationalMode ModeEnum) error {
logr := log.FromContext(ctx).WithValues("databaseclaim", dbClaim.Namespace+"/"+dbClaim.Name)
activeDB := dbClaim.Status.ActiveDB
// Exit immediately if we have nothing to do
if activeDB.UserUpdatedAt != nil {
lastUpdateSince := time.Since(activeDB.UserUpdatedAt.Time)
if lastUpdateSince < r.getPasswordRotationTime() {
logr.Info("user updated recently, skipping reconcile", "elapsed", lastUpdateSince)
return ErrDoNotUpdateStatus
}
}
logr.Info("status_block", "status", dbClaim.Status)
sourceDSN, err := auth.GetSourceDataFromDSN(ctx, r.Client, dbClaim)
if err != nil {
logr.Error(err, "unable to populate creds")
return err
}
// Existing source creds that become master creds
existingDBConnInfo, err := v1.ParseUri(sourceDSN)
if err != nil {
logr.Error(err, "unable to parse source dsn")
return err
}
if dbClaim.Status.ActiveDB.DbState == v1.UsingExistingDB {
// Verify These databases are not the same
if dbClaim.Status.ActiveDB.ConnectionInfo.Host == existingDBConnInfo.Host &&
dbClaim.Status.ActiveDB.ConnectionInfo.Port == existingDBConnInfo.Port {
dbClaim.Status.NewDB = *dbClaim.Status.ActiveDB.DeepCopy()
}
}
dbClaim.Status.NewDB.DbState = v1.UsingExistingDB
dbClaim.Status.NewDB.SourceDataFrom = dbClaim.Spec.SourceDataFrom.DeepCopy()
masterPassword := existingDBConnInfo.Password
//cache master password for existing db
err = r.setMasterPasswordInTempSecret(ctx, masterPassword, dbClaim)
if err != nil {
logr.Error(err, "cache master password error")
return err
}
dbClient, err := r.getClientForExistingDB(ctx, dbClaim, existingDBConnInfo)
if err != nil {
logr.Error(err, "creating database client error")
return err
}
defer dbClient.Close()
logr.Info(fmt.Sprintf("processing DBClaim: %s namespace: %s AppID: %s", dbClaim.Name, dbClaim.Namespace, dbClaim.Spec.AppID))
dbName := existingDBConnInfo.DatabaseName
r.statusManager.UpdateDBStatus(&dbClaim.Status.NewDB, dbName)
err = r.manageUserAndExtensions(ctx, reqInfo, logr, dbClient, &dbClaim.Status.NewDB, &dbClaim.Status.ActiveDB, dbName, dbClaim.Spec.Username, operationalMode)
if err != nil {
logr.Error(err, "unable to update users, user credentials not persisted to status object")
return err
}
if err = r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
return err
}
if reqInfo.TempSecret != "" {
newDBConnInfo := dbClaim.Status.NewDB.ConnectionInfo.DeepCopy()
newDBConnInfo.Password = reqInfo.TempSecret
if err := r.createOrUpdateSecret(ctx, dbClaim, newDBConnInfo, basefun.GetCloud(r.Config.Viper)); err != nil {
return err
}
logr.V(1).Info("password reset, created secret", "secret", dbClaim.Spec.SecretName)
}
logr.V(1).Info("creating default extensions", "database", dbClaim.Spec.DatabaseName)
err = dbClient.CreateDefaultExtensions(dbName)
if err != nil {
msg := fmt.Sprintf("error creating default extensions for %s", dbName)
logr.Error(err, msg)
return err
}
err = dbClient.ManageSystemFunctions(dbName, basefun.GetSystemFunctions(r.Config.Viper))
if err != nil {
return err
}
return nil
}
func (r *DatabaseClaimReconciler) reconcileNewDB(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim, operationalMode ModeEnum) (ctrl.Result, error) {
logr := log.FromContext(ctx).WithValues("databaseclaim", dbClaim.Namespace+"/"+dbClaim.Name, "func", "reconcileNewDB")
logr.Info("reconcileNewDB", "r.Input", reqInfo)
err_ := r.statusManager.SetConditionAndUpdateStatus(ctx, dbClaim, v1.ProvisioningCondition())
if err_ != nil {
return ctrl.Result{}, err_
}
cloud := basefun.GetCloud(r.Config.Viper)
isReady := false
var err error
if cloud == "aws" {
isReady, err = r.manageCloudHostAWS(ctx, reqInfo, dbClaim, operationalMode)
if err != nil {
logr.Error(err, "manage_cloud_host_AWS")
return ctrl.Result{}, err
}
} else if cloud == "gcp" {
isReady, err = r.manageCloudHostGCP(ctx, reqInfo, dbClaim)
if err != nil {
logr.Error(err, "manage_cloud_host_GCP")
return ctrl.Result{}, err
}
} else {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("cloud not supported, check .Values.cloud"))
}
if err := r.statusManager.ClearError(ctx, dbClaim); err != nil {
logr.Error(err, "Error updating DatabaseClaim status")
return ctrl.Result{}, err
}
dbHostIdentifier := r.getDynamicHostName(reqInfo.HostParams.Hash(), dbClaim)
if !isReady {
logr.Info("cloud instance provisioning is in progress", "instance name", dbHostIdentifier, "next-step", "requeueing")
return ctrl.Result{RequeueAfter: basefun.GetDynamicHostWaitTime(r.Config.Viper)}, nil
}
logr.V(1).Info("cloud instance ready. reading generated master secret", "instance", dbHostIdentifier)
connInfo, err := r.kctl.GetMasterCredsDeprecated(ctx, dbHostIdentifier, dbClaim.Spec.DatabaseName, basefun.GetDefaultSSLMode(r.Config.Viper))
if err != nil {
logr.Error(err, "error retrieving master credentials", "operationMode", operationalMode)
return ctrl.Result{RequeueAfter: basefun.GetDynamicHostWaitTime(r.Config.Viper)}, nil
}
reqInfo.MasterConnInfo.Host = connInfo.Host
reqInfo.MasterConnInfo.Password = connInfo.Password
reqInfo.MasterConnInfo.Port = connInfo.Port
reqInfo.MasterConnInfo.Username = connInfo.Username
reqInfo.MasterConnInfo.DatabaseName = connInfo.DatabaseName
reqInfo.MasterConnInfo.SSLMode = connInfo.SSLMode
dbClient, err := dbclient.New(dbclient.Config{
Log: log.FromContext(ctx).WithValues("caller", "reconcileNewDB"),
DBType: "postgres",
DSN: connInfo.Uri(),
})
if err != nil {
logr.Error(err, "unable_dbclient")
return ctrl.Result{}, err
}
defer dbClient.Close()
// Series of partial updates to the status newb, get ready
// Update connection info to object
r.statusManager.UpdateHostPortStatus(&dbClaim.Status.NewDB, connInfo.Host, connInfo.Port, connInfo.SSLMode)
// Setup status.NewDB object with desired hostparams used to create it
r.statusManager.UpdateClusterStatus(&dbClaim.Status.NewDB, &reqInfo.HostParams)
// Updates the database name
logr.V(1).Info("creating database and extensions", "database", dbClaim.Spec.DatabaseName)
if err := r.createDatabaseAndExtensions(ctx, dbClient, dbClaim, operationalMode); err != nil {
logr.Error(err, "unable to create database and extensions")
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Updates the connection info username
err = r.manageUserAndExtensions(ctx, reqInfo, logr, dbClient, &dbClaim.Status.NewDB, &dbClaim.Status.ActiveDB, dbClaim.Spec.DatabaseName, dbClaim.Spec.Username, operationalMode)
if err != nil {
logr.Error(err, "unable to update users, user credentials not persisted to status object")
return r.statusManager.SetError(ctx, dbClaim, err)
}
// TODO: I don't know what purpose these serve
// ref: https://github.com/infobloxopen/db-controller/pull/193
err = dbClient.ManageSystemFunctions(dbClaim.Spec.DatabaseName, basefun.GetSystemFunctions(r.Config.Viper))
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
logr.V(debugLevel).Info("populated_newdb_information", "newdb", dbClaim.Status.NewDB)
return ctrl.Result{}, nil
}
func crExists(ctx context.Context, cli client.Reader, crName string, obj client.Object) bool {
var exists bool
var err error
err = cli.Get(ctx, client.ObjectKey{Name: crName}, obj)
if err == nil {
exists = true
} else if !errors.IsNotFound(err) {
return false // Unexpected error, assume failure
}
return exists
}
func (r *DatabaseClaimReconciler) providerCRAlreadyExists(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim) (bool, error) {
dbHostIdentifier := r.getDynamicHostName(reqInfo.HostParams.Hash(), dbClaim)
var (
instance client.Object
cluster client.Object
)
switch cloudProvider := basefun.GetCloud(r.Config.Viper); cloudProvider {
case "aws":
instance, cluster = &crossplaneaws.DBInstance{}, &crossplaneaws.DBCluster{}
case "gcp":
instance, cluster = &crossplanegcp.Instance{}, &crossplanegcp.Cluster{}
default:
return false, fmt.Errorf("unsupported cloud provider: %s", cloudProvider)
}
exists := crExists(ctx, r.Client, dbHostIdentifier, cluster) && crExists(ctx, r.Client, dbHostIdentifier, instance)
return exists, nil
}
func (r *DatabaseClaimReconciler) reconcileMigrateToNewDB(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim, operationalMode ModeEnum) (ctrl.Result, error) {
logr := log.FromContext(ctx)
if dbClaim.Status.MigrationState == "" {
dbClaim.Status.MigrationState = pgctl.S_Initial.String()
if err := r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
logr.Error(err, "could not update db claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
}
result, err := r.reconcileNewDB(ctx, reqInfo, dbClaim, operationalMode)
if err != nil {
logr.Error(err, "reconcile_new_db")
return r.statusManager.SetError(ctx, dbClaim, err)
}
if result.RequeueAfter > 0 {
return result, nil
}
// store a temp secret to be used by migration process
// removing the practice of storing the secret in status
if reqInfo.TempSecret != "" {
if err := r.setTargetPasswordInTempSecret(ctx, reqInfo.TempSecret, dbClaim); err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
}
// Store the source DSN, otherwise it will be lost
sourceDSN, err := r.getSrcAppDsnFromSecret(ctx, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Preserve credentials to temp secret or less we risk losing state
err = r.setSourceDsnInTempSecret(ctx, sourceDSN, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Update migration state to one of these
// M_MigrationInProgress, M_UpgradeDBInProgress
return r.statusManager.MigrationInProgressStatus(ctx, dbClaim)
}
func (r *DatabaseClaimReconciler) reconcileMigrationInProgress(ctx context.Context, reqInfo *requestInfo, dbClaim *v1.DatabaseClaim, operationalMode ModeEnum) (ctrl.Result, error) {
logr := log.FromContext(ctx).WithValues("databaseclaim", dbClaim.Namespace+"/"+dbClaim.Name, "func", "reconcileMigrationInProgress")
migrationState := dbClaim.Status.MigrationState
if dbClaim.Status.NewDB.ConnectionInfo == nil ||
dbClaim.Status.NewDB.ConnectionInfo.Host == "" {
err := fmt.Errorf("status.newdb is empty")
logr.Error(err, "unable_to_migrate_no_newdb")
return r.statusManager.SetError(ctx, dbClaim, err)
}
logr.Info("Migration in progress", "state", migrationState)
dbHostIdentifier := r.getDynamicHostName(reqInfo.HostParams.Hash(), dbClaim)
connInfo, err := r.kctl.GetMasterCredsDeprecated(ctx, dbHostIdentifier, dbClaim.Spec.DatabaseName, basefun.GetDefaultSSLMode(r.Config.Viper))
if err != nil {
logr.Error(err, "unable to read the complete secret. requeueing")
return ctrl.Result{RequeueAfter: basefun.GetDynamicHostWaitTime(r.Config.Viper)}, nil
}
logr.Info("cloud instance ready", "newdb", dbClaim.Status.NewDB)
// FIXME: this is terrible logic, why is this even a thing?
reqInfo.MasterConnInfo = *connInfo.DeepCopy()
targetMasterDsn := reqInfo.MasterConnInfo.Uri()
logr.Info("Status", "status", dbClaim.Status)
newInfo := dbClaim.Status.NewDB.ConnectionInfo
activeInfo := dbClaim.Status.ActiveDB.ConnectionInfo
// FIXME: remove this
if newInfo.Host == activeInfo.Host && newInfo.Port == activeInfo.Port {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("active and new database can not be the same"))
}
targetAppConn := dbClaim.Status.NewDB.ConnectionInfo.DeepCopy()
targetAppConn.Password, err = r.getTargetPasswordFromTempSecret(ctx, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
if err := targetAppConn.Validate(); err != nil {
logr.Error(err, "target_user_connection_is_invalid")
return r.statusManager.SetError(ctx, dbClaim, err)
}
sourceAppDsn, err := r.getSrcAppDsnFromSecret(ctx, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Maybe the credentials are in a temp secret
if sourceAppDsn == "" {
sourceAppDsn, err = r.getSourceDsnFromTempSecret(ctx, dbClaim)
if err != nil {
logr.Error(err, "unable to retrieve source dsn")
return r.statusManager.SetError(ctx, dbClaim, err)
}
}
if sourceAppDsn == "" {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("unable_to_find_source_user_dsn"))
}
// FIXME: replace misc auth fetching with PopulateCreds
if _, err := auth.PopulateCreds(ctx, r.Client, dbClaim, r.Config.Viper.GetString("SERVICE_NAMESPACE")); err != nil {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("unable to populate credentials"))
}
var sourceMasterConn *v1.DatabaseClaimConnectionInfo
// Parsing source database credentials
if operationalMode == M_MigrationInProgress || operationalMode == M_MigrateExistingToNewDB {
if dbClaim.Spec.SourceDataFrom == nil {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("sourceDataFrom is nil"))
}
if dbClaim.Spec.SourceDataFrom.Database == nil {
return r.statusManager.SetError(ctx, dbClaim, fmt.Errorf("sourceDataFrom.Database is nil"))
}
dsn, err := auth.GetSourceDataFromDSN(ctx, r.Client, dbClaim)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
sourceMasterConn, err = v1.ParseUri(dsn)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
} else if operationalMode == M_UpgradeDBInProgress || operationalMode == M_InitiateDBUpgrade {
activeHost, _, _ := strings.Cut(dbClaim.Status.ActiveDB.ConnectionInfo.Host, ".")
activeConnInfo, err := r.kctl.GetMasterCredsDeprecated(ctx, activeHost, dbClaim.Spec.DatabaseName, dbClaim.Status.ActiveDB.ConnectionInfo.SSLMode)
if err != nil {
logr.Error(err, "error retrieving master credentials", "operationMode", operationalMode)
return r.statusManager.SetError(ctx, dbClaim, err)
}
//copy over source app connection and replace userid and password with master userid and password
sourceMasterConn, err = v1.ParseUri(sourceAppDsn)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
sourceMasterConn.Username = activeConnInfo.Username
sourceMasterConn.Password = activeConnInfo.Password
} else {
err := fmt.Errorf("unsupported operational mode %v", operationalMode)
return r.statusManager.SetError(ctx, dbClaim, err)
}
config := pgctl.Config{
Cloud: basefun.GetCloud(r.Config.Viper),
Log: log.FromContext(ctx),
SourceDBAdminDsn: sourceMasterConn.Uri(),
SourceDBUserDsn: sourceAppDsn,
TargetDBUserDsn: targetAppConn.Uri(),
TargetDBAdminDsn: targetMasterDsn,
ExportFilePath: basefun.GetPgTempFolder(r.Config.Viper),
}
s, err := pgctl.GetReplicatorState(migrationState, config)
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Check source user creds and update
if err := validateAndUpdateCredsDSN(ctx, config.SourceDBAdminDsn, config.SourceDBUserDsn); err != nil {
logr.Error(err, "source_dsn_validate_failed")
return r.statusManager.SetError(ctx, dbClaim, err)
}
// Check Target user creds and update
if err := validateAndUpdateCredsDSN(ctx, config.TargetDBAdminDsn, config.TargetDBUserDsn); err != nil {
logr.Error(err, "target_dsn_validate_failed")
return r.statusManager.SetError(ctx, dbClaim, err)
}
loop:
for {
next, err := s.Execute()
if err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
switch next.Id() {
case pgctl.S_Completed:
logr.Info("completed migration")
//PTEUDO1051: if migration was successfull, get the list of DBRoleClaims attached to the old DBClaim and recreate
// them pointing to the new DBClaim
dbRoleClaims := &v1.DbRoleClaimList{}
if err := r.Client.List(ctx, dbRoleClaims, client.InNamespace(dbClaim.Namespace)); err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
logr.Info("copying dbroleclaims to new dbclaim")
for _, dbrc := range dbRoleClaims.Items {
if strings.HasSuffix(dbrc.Name, "-"+dbClaim.Name) {
continue
}
err = r.Client.Get(ctx, client.ObjectKey{
Name: dbrc.Name + "-" + dbClaim.Name,
Namespace: dbrc.Namespace,
}, &v1.DbRoleClaim{})
if errors.IsNotFound(err) {
dbrc.Name = dbrc.Name + "-" + dbClaim.Name
dbrc.Spec.SecretName = dbrc.Spec.SecretName + "-" + dbClaim.Name
dbrc.Spec.SourceDatabaseClaim.Name = dbClaim.Name
dbrc.Status = v1.DbRoleClaimStatus{}
dbrc.ResourceVersion = ""
dbrc.Generation = 0
if err = r.Client.Create(ctx, &dbrc); err != nil {
logr.Error(err, "could not update db role claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
logr.Info("dbroleclaim copied: " + dbrc.Name)
} else {
logr.Info("dbroleclaim [" + dbrc.Name + "] already exists.")
}
}
break loop
case pgctl.S_Retry:
logr.Info("retry called")
return ctrl.Result{RequeueAfter: 60 * time.Second}, nil
case pgctl.S_WaitToDisableSource:
s = next
dbClaim.Status.MigrationState = s.String()
if err = r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
logr.Error(err, "could not update db claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
logr.Info("Requeue, waiting to disable source")
// TODO: alter this for tests
return ctrl.Result{RequeueAfter: 60 * time.Second}, nil
case pgctl.S_RerouteTargetSecret:
// FIXME: this is no longer called and should be removed
logr.Info("reroute target secret")
if err = r.rerouteTargetSecret(ctx, sourceAppDsn, targetAppConn, dbClaim); err != nil {
return r.statusManager.SetError(ctx, dbClaim, err)
}
s = next
dbClaim.Status.MigrationState = s.String()
if err = r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
logr.Error(err, "could not update db claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
default:
s = next
dbClaim.Status.MigrationState = s.String()
if err = r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
logr.Error(err, "could not update db claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
}
}
dbClaim.Status.MigrationState = pgctl.S_Completed.String()
if dbClaim.Status.ActiveDB.DbState != v1.UsingExistingDB {
timenow := metav1.Now()
dbClaim.Status.OldDB = v1.StatusForOldDB{ConnectionInfo: &v1.DatabaseClaimConnectionInfo{}}
MakeDeepCopyToOldDB(&dbClaim.Status.OldDB, &dbClaim.Status.ActiveDB)
dbClaim.Status.OldDB.DbState = v1.PostMigrationInProgress
dbClaim.Status.OldDB.PostMigrationActionStartedAt = &timenow
}
//done with migration- switch active server to newDB
logr.V(debugLevel).Info("migration complete updating activedb")
dbClaim.Status.ActiveDB = *dbClaim.Status.NewDB.DeepCopy()
dbClaim.Status.ActiveDB.DbState = v1.Ready
dbClaim.Status.NewDB = v1.Status{ConnectionInfo: &v1.DatabaseClaimConnectionInfo{}}
if err = r.statusManager.UpdateStatus(ctx, dbClaim); err != nil {
logr.Error(err, "could not update db claim")
return r.statusManager.SetError(ctx, dbClaim, err)
}
err = r.deleteTempSecret(ctx, dbClaim)
if err != nil {
logr.Error(err, "ignoring delete temp secret error")
}
//create connection info secret
logr.Info("migration complete")
return r.statusManager.SuccessAndUpdateCondition(ctx, dbClaim)
}
func MakeDeepCopyToOldDB(to *v1.StatusForOldDB, from *v1.Status) {
to.ConnectionInfo = from.ConnectionInfo.DeepCopy()
to.DBVersion = from.DBVersion
to.Shape = from.Shape
to.Type = from.Type
}
// ManageOperationalTagging: Will update operational tags on old DBInstance, DBCluster, DBClusterParamGroup and DBParamGroup.
// It does not return error for DBCluster, DBClusterParamGroup and DBParamGroup if they fail to update tags. Such error is only logged, but not returned.
// In case of successful updation, It does not to verify whether those tags got updated.
//
// Unlike other resources,
// It returns error just for DBinstance failling to update tags.
// It also verifies whether DBinstance got updated with the tag, and return the signal as boolean.
//
// true: operational tag is updated and verfied.
// false: operational tag is updated but could not be verified yet.
func (r *DatabaseClaimReconciler) ManageOperationalTagging(ctx context.Context, logr logr.Logger, dbInstanceName, dbParamGroupName string, isAurora bool) (bool, error) {
return r.manageOperationalTagging(ctx, logr, dbInstanceName, dbParamGroupName, isAurora)
}
func (r *DatabaseClaimReconciler) manageOperationalTagging(ctx context.Context, logr logr.Logger,
dbInstanceName, dbParamGroupName string, isAurora bool) (bool, error) {
// For Aurora PostgreSQL, manage tagging for both cluster and instance resources
if isAurora {
if err := r.operationalTaggingForDbClusterParamGroup(ctx, logr, dbParamGroupName); err != nil {
return false, fmt.Errorf("failed to tag cluster parameter group: %w", err)
}
if err := r.operationalTaggingForDbCluster(ctx, logr, dbInstanceName); err != nil {
return false, fmt.Errorf("failed to tag cluster: %w", err)
}
}
if err := r.operationalTaggingForDbParamGroup(ctx, logr, dbParamGroupName); err != nil {
return false, fmt.Errorf("failed to tag parameter group: %w", err)
}
isVerified, err := r.operationalTaggingForDbInstance(ctx, logr, dbInstanceName)
if err != nil {
return false, fmt.Errorf("failed to tag primary instance: %w", err)
}
if basefun.GetMultiAZEnabled(r.Config.Viper) && isAurora {
secondaryInstanceName := dbInstanceName + "-2"
isVerifiedSecondary, errSecondary := r.operationalTaggingForDbInstance(ctx, logr, secondaryInstanceName)
if errSecondary != nil {
return false, fmt.Errorf("failed to tag secondary instance: %w", errSecondary)
}
return isVerified && isVerifiedSecondary, nil
}
return isVerified, nil
}
func (r *DatabaseClaimReconciler) getClientForExistingDB(ctx context.Context, dbClaim *v1.DatabaseClaim, connInfo *v1.DatabaseClaimConnectionInfo) (dbclient.Clienter, error) {
if connInfo == nil {
return nil, fmt.Errorf("invalid connection info")
}
if connInfo.Host == "" {
return nil, fmt.Errorf("invalid host name")
}
if connInfo.Port == "" {