refactor!: Change Database configuration to be single instance (#4308)

* refactor!: Change Database configuration to be single instance BREAKING CHANGE: Database configuration for services has changed from a Map to a single instance closes #4131 Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
edgexfoundry · Jan 26, 2023 · a37026e · a37026e
1 parent 228e514
commit a37026e
Show file tree

Hide file tree

Showing 19 changed files with 89 additions and 102 deletions.
diff --git a/cmd/core-common-config-bootstrapper/res/configuration.yaml b/cmd/core-common-config-bootstrapper/res/configuration.yaml
@@ -43,11 +43,10 @@ all-services:
     Type: "consul"
 
   Databases:
-    Primary:
-      Host: "localhost"
-      Port: 6379
-      Timeout: 5000
-      Type: "redisdb"
+    Host: "localhost"
+    Port: 6379
+    Timeout: 5000
+    Type: "redisdb"
 
   MessageBus:
     Protocol: "redis"

diff --git a/cmd/core-data/res/configuration.toml b/cmd/core-data/res/configuration.toml
@@ -48,13 +48,12 @@ Type = "consul"
 
 [Clients] # Core data no longer dependent on "Client" services
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = "coredata"
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = "coredata"
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [MessageBus]
 Protocol = "redis"

diff --git a/cmd/core-metadata/res/configuration.toml b/cmd/core-metadata/res/configuration.toml
@@ -55,15 +55,12 @@ Type = "consul"
   Host = "localhost"
   Port = 59860
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = "metadata"
-  Password = "password"
-  Username = "meta"
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = "metadata"
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [Notifications]
 PostDeviceChanges = false

diff --git a/cmd/security-bootstrapper/res-bootstrap-redis/configuration.toml b/cmd/security-bootstrapper/res-bootstrap-redis/configuration.toml
@@ -15,15 +15,14 @@
 
 LogLevel = "INFO"
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = ""           ## Unused
-  Password = ""       ## Will be set from value in Vault
-  Username = ""       ## Will be set from value in Vault
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = ""           ## Unused
+Password = ""       ## Will be set from value in Vault
+Username = ""       ## Will be set from value in Vault
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [DatabaseConfig]
   Path = "/path/to/redis/conf/dir"

diff --git a/cmd/security-bootstrapper/res/configuration.toml b/cmd/security-bootstrapper/res/configuration.toml
@@ -11,7 +11,7 @@ LogLevel = "INFO"
     [StageGate.SecretStoreSetup.Tokens]
       ReadyPort = 54322
   [StageGate.Database]
-    # this is intended to be the same as Database.Primary.Host/.Port for other services
+    # this is intended to be the same as Database.Host/.Port for other services
     Host = "edgex-redis"
     Port = 6379
     ReadyPort = 54323

diff --git a/cmd/security-spiffe-token-provider/res/configuration.toml b/cmd/security-spiffe-token-provider/res/configuration.toml
@@ -31,14 +31,13 @@ Host = "localhost"
 Port = 8500
 Type = "consul"
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = "coredata"
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = "coredata"
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [SPIFFE]
-  EndpointSocket = "/tmp/edgex/secrets/spiffe/public/api.sock"
-  TrustDomain = "edgexfoundry.org"
+EndpointSocket = "/tmp/edgex/secrets/spiffe/public/api.sock"
+TrustDomain = "edgexfoundry.org"
diff --git a/cmd/support-notifications/res/configuration.toml b/cmd/support-notifications/res/configuration.toml
@@ -48,13 +48,12 @@ Host = "localhost"
 Port = 8500
 Type = "consul"
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = "notifications"
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = "notifications"
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [Smtp]
   Host = "smtp.gmail.com"

diff --git a/cmd/support-scheduler/res/configuration.toml b/cmd/support-scheduler/res/configuration.toml
@@ -48,13 +48,12 @@ Host = "localhost"
 Port = 8500
 Type = "consul"
 
-[Databases]
-  [Databases.Primary]
-  Host = "localhost"
-  Name = "scheduler"
-  Port = 6379
-  Timeout = 5000
-  Type = "redisdb"
+[Database]
+Host = "localhost"
+Name = "scheduler"
+Port = 6379
+Timeout = 5000
+Type = "redisdb"
 
 [Intervals]
     [Intervals.Midnight]

diff --git a/internal/core/data/config/config.go b/internal/core/data/config/config.go
@@ -22,7 +22,7 @@ type ConfigurationStruct struct {
 	Writable     WritableInfo
 	MessageBus   bootstrapConfig.MessageBusInfo
 	Clients      map[string]bootstrapConfig.ClientInfo
-	Databases    map[string]bootstrapConfig.Database
+	Database     bootstrapConfig.Database
 	Registry     bootstrapConfig.RegistryInfo
 	Service      bootstrapConfig.ServiceInfo
 	MaxEventSize int64
@@ -89,9 +89,9 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 	return c.Registry
 }
 
-// GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+// GetDatabaseInfo returns a database information.
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets.

diff --git a/internal/core/metadata/config/config.go b/internal/core/metadata/config/config.go
@@ -22,7 +22,7 @@ import (
 type ConfigurationStruct struct {
 	Writable      WritableInfo
 	Clients       map[string]bootstrapConfig.ClientInfo
-	Databases     map[string]bootstrapConfig.Database
+	Database      bootstrapConfig.Database
 	Notifications NotificationInfo
 	Registry      bootstrapConfig.RegistryInfo
 	Service       bootstrapConfig.ServiceInfo
@@ -115,9 +115,9 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 	return c.Registry
 }
 
-// GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+// GetDatabaseInfo returns a database information.
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets.

diff --git a/internal/pkg/bootstrap/handlers/database.go b/internal/pkg/bootstrap/handlers/database.go
@@ -21,7 +21,6 @@ import (
 	bootstrapConfig "github.com/edgexfoundry/go-mod-bootstrap/v3/config"
 	"github.com/edgexfoundry/go-mod-bootstrap/v3/di"
 	"github.com/edgexfoundry/go-mod-core-contracts/v3/clients/logger"
-	"github.com/edgexfoundry/go-mod-core-contracts/v3/common"
 )
 
 // httpServer defines the contract used to determine whether or not the http httpServer is running.
@@ -49,7 +48,7 @@ func NewDatabase(httpServer httpServer, database bootstrapInterfaces.Database, d
 func (d Database) newDBClient(
 	lc logger.LoggingClient,
 	credentials bootstrapConfig.Credentials) (interfaces.DBClient, error) {
-	databaseInfo := d.database.GetDatabaseInfo()[common.Primary]
+	databaseInfo := d.database.GetDatabaseInfo()
 	switch databaseInfo.Type {
 	case "redisdb":
 		return redis.NewClient(
@@ -79,7 +78,7 @@ func (d Database) BootstrapHandler(
 	for startupTimer.HasNotElapsed() {
 		var err error
 
-		secrets, err := secretProvider.GetSecret(d.database.GetDatabaseInfo()[common.Primary].Type)
+		secrets, err := secretProvider.GetSecret(d.database.GetDatabaseInfo().Type)
 		if err == nil {
 			credentials = bootstrapConfig.Credentials{
 				Username: secrets[secret.UsernameKey],

diff --git a/internal/pkg/bootstrap/interfaces/database.go b/internal/pkg/bootstrap/interfaces/database.go
@@ -18,6 +18,6 @@ import "github.com/edgexfoundry/go-mod-bootstrap/v3/config"
 
 // Database interface provides an abstraction for obtaining the database configuration information.
 type Database interface {
-	// GetDatabaseInfo returns a database information map.
-	GetDatabaseInfo() map[string]config.Database
+	// GetDatabaseInfo returns a database information.
+	GetDatabaseInfo() config.Database
 }
diff --git a/internal/security/bootstrapper/redis/config/config.go b/internal/security/bootstrapper/redis/config/config.go
@@ -23,7 +23,7 @@ import (
 // the runtime extension of the static configuration.
 type ConfigurationStruct struct {
 	LogLevel       string
-	Databases      map[string]bootstrapConfig.Database
+	Database       bootstrapConfig.Database
 	DatabaseConfig DatabaseBootstrapConfigInfo
 }
 
@@ -74,9 +74,9 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 	return bootstrapConfig.RegistryInfo{}
 }
 
-// GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+// GetDatabaseInfo returns a database information.
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets which this service doesn't support

diff --git a/internal/security/bootstrapper/redis/handlers/handlers.go b/internal/security/bootstrapper/redis/handlers/handlers.go
@@ -33,7 +33,6 @@ import (
 	bootstrapConfig "github.com/edgexfoundry/go-mod-bootstrap/v3/config"
 	"github.com/edgexfoundry/go-mod-bootstrap/v3/di"
 	"github.com/edgexfoundry/go-mod-core-contracts/v3/clients/logger"
-	"github.com/edgexfoundry/go-mod-core-contracts/v3/common"
 )
 
 const (
@@ -68,7 +67,7 @@ func (handler *Handler) GetCredentials(ctx context.Context, _ *sync.WaitGroup, s
 
 	for startupTimer.HasNotElapsed() {
 		// retrieve database credentials from secretstore
-		secrets, err := secretProvider.GetSecret(config.Databases[common.Primary].Type)
+		secrets, err := secretProvider.GetSecret(config.Database.Type)
 		if err == nil {
 			credentials.Username = secrets[secret.UsernameKey]
 			credentials.Password = secrets[secret.PasswordKey]

diff --git a/internal/security/spiffetokenprovider/config/config.go b/internal/security/spiffetokenprovider/config/config.go
@@ -31,7 +31,7 @@ type ConfigurationStruct struct {
 	Writable   WritableInfo
 	MessageBus bootstrapConfig.MessageBusInfo
 	Clients    map[string]bootstrapConfig.ClientInfo
-	Databases  map[string]bootstrapConfig.Database
+	Database   bootstrapConfig.Database
 	Registry   bootstrapConfig.RegistryInfo
 	Service    bootstrapConfig.ServiceInfo
 	Spiffe     SpiffeInfo
@@ -96,9 +96,9 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 	return c.Registry
 }
 
-// GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+// GetDatabaseInfo returns a database information.
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets.

diff --git a/internal/support/notifications/config/config.go b/internal/support/notifications/config/config.go
@@ -22,7 +22,7 @@ import (
 type ConfigurationStruct struct {
 	Writable   WritableInfo
 	Clients    map[string]bootstrapConfig.ClientInfo
-	Databases  map[string]bootstrapConfig.Database
+	Database   bootstrapConfig.Database
 	Registry   bootstrapConfig.RegistryInfo
 	Service    bootstrapConfig.ServiceInfo
 	MessageBus bootstrapConfig.MessageBusInfo
@@ -118,9 +118,9 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 	return c.Registry
 }
 
-// GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+// GetDatabaseInfo returns a database information.
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets.

diff --git a/internal/support/scheduler/config/config.go b/internal/support/scheduler/config/config.go
@@ -24,7 +24,7 @@ import (
 type ConfigurationStruct struct {
 	Writable        WritableInfo
 	Clients         map[string]bootstrapConfig.ClientInfo
-	Databases       map[string]bootstrapConfig.Database
+	Database        bootstrapConfig.Database
 	Registry        bootstrapConfig.RegistryInfo
 	Service         bootstrapConfig.ServiceInfo
 	MessageBus      bootstrapConfig.MessageBusInfo
@@ -143,8 +143,8 @@ func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo {
 }
 
 // GetDatabaseInfo returns a database information map.
-func (c *ConfigurationStruct) GetDatabaseInfo() map[string]bootstrapConfig.Database {
-	return c.Databases
+func (c *ConfigurationStruct) GetDatabaseInfo() bootstrapConfig.Database {
+	return c.Database
 }
 
 // GetInsecureSecrets returns the service's InsecureSecrets.

diff --git a/openapi/v2/core-data.yaml b/openapi/v2/core-data.yaml
@@ -1852,15 +1852,14 @@ paths:
                       Host: "edgex-core-metadata"
                       Port: 59881
                       Protocol: "http"
-                  Databases:
-                    Primary:
-                      Username: "core"
-                      Password: "password"
-                      Type: "redisdb"
-                      Timeout: 5000
-                      Host: "edgex-redis"
-                      Port: 6379
-                      Name: "coredata"
+                  Database:
+                    Username: "core"
+                    Password: "password"
+                    Type: "redisdb"
+                    Timeout: 5000
+                    Host: "edgex-redis"
+                    Port: 6379
+                    Name: "coredata"
                   Logging:
                     EnableRemote: false
                     File: ""

diff --git a/openapi/v2/core-metadata.yaml b/openapi/v2/core-metadata.yaml
@@ -3886,15 +3886,14 @@ paths:
                       Host: "edgex-support-notifications"
                       Port: 59860
                       Protocol: "http"
-                  Databases:
-                    Primary:
-                      Username: "meta"
-                      Password: "password"
-                      Type: "redisdb"
-                      Timeout: 5000
-                      Host: "edgex-redis"
-                      Port: 6379
-                      Name: "metadata"
+                  Database:
+                    Username: "meta"
+                    Password: "password"
+                    Type: "redisdb"
+                    Timeout: 5000
+                    Host: "edgex-redis"
+                    Port: 6379
+                    Name: "metadata"
                   Notifications:
                     Content: "Device update: "
                     Description: "Metadata device notice"