feat: prepare for multiple database types (#4068)

BREAKING CHANGE: the database and admin user config has changed.

cmd/defaults.yaml

@@ -45,30 +45,30 @@ HTTP1HostHeader: "host"
 WebAuthNName: ZITADEL
 
 Database:
-  Host: localhost
-  Port: 26257
-  Database: zitadel
-  MaxOpenConns: 20
-  MaxConnLifetime: 30m
-  MaxConnIdleTime: 30m
-  Options: ""
-  User:
-    Username: zitadel
-    Password: ""
-    SSL:
-      Mode: disable
-      RootCert: ""
-      Cert: ""
-      Key: ""
-
-AdminUser:
-  Username: root
-  Password: ""
-  SSL:
-    Mode: disable
-    RootCert: ""
-    Cert: ""
-    Key: ""
+  cockroach:
+    Host: localhost
+    Port: 26257
+    Database: zitadel
+    MaxOpenConns: 20
+    MaxConnLifetime: 30m
+    MaxConnIdleTime: 30m
+    Options: ""
+    User:
+      Username: zitadel
+      Password: ""
+      SSL:
+        Mode: disable
+        RootCert: ""
+        Cert: ""
+        Key: ""
+    Admin:
+      Username: root
+      Password: ""
+      SSL:
+        Mode: disable
+        RootCert: ""
+        Cert: ""
+        Key: ""
 
 Machine:
   # Cloud hosted VMs need to specify their metadata endpoint so that the machine can be uniquely identified.

cmd/initialise/config.go

@@ -9,15 +9,16 @@ import (
 )
 
 type Config struct {
-	Database  database.Config
-	AdminUser database.User
-	Machine   *id.Config
-	Log       *logging.Config
+	Database database.Config
+	Machine  *id.Config
+	Log      *logging.Config
 }
 
 func MustNewConfig(v *viper.Viper) *Config {
 	config := new(Config)
-	err := v.Unmarshal(config)
+	err := v.Unmarshal(config,
+		viper.DecodeHook(database.DecodeHook),
+	)
 	logging.OnError(err).Fatal("unable to read config")
 
 	err = config.Log.SetLogger()
@@ -25,21 +26,3 @@ func MustNewConfig(v *viper.Viper) *Config {
 
 	return config
 }
-
-func adminConfig(config *Config) database.Config {
-	adminConfig := config.Database
-	adminConfig.Username = config.AdminUser.Username
-	adminConfig.Password = config.AdminUser.Password
-	adminConfig.SSL.Cert = config.AdminUser.SSL.Cert
-	adminConfig.SSL.Key = config.AdminUser.SSL.Key
-	if config.AdminUser.SSL.RootCert != "" {
-		adminConfig.SSL.RootCert = config.AdminUser.SSL.RootCert
-	}
-	if config.AdminUser.SSL.Mode != "" {
-		adminConfig.SSL.Mode = config.AdminUser.SSL.Mode
-	}
-	//use default database because the zitadel database might not exist
-	adminConfig.Database = ""
-
-	return adminConfig
-}

cmd/initialise/init.go

@@ -39,10 +39,10 @@ The user provided by flags needs privileges to
 
 func InitAll(config *Config) {
 	id.Configure(config.Machine)
-	err := initialise(config,
-		VerifyUser(config.Database.Username, config.Database.Password),
-		VerifyDatabase(config.Database.Database),
-		VerifyGrant(config.Database.Database, config.Database.Username),
+	err := initialise(config.Database,
+		VerifyUser(config.Database.Username(), config.Database.Password()),
+		VerifyDatabase(config.Database.Database()),
+		VerifyGrant(config.Database.Database(), config.Database.Username()),
 	)
 	logging.OnError(err).Fatal("unable to initialize the database")
 
@@ -50,10 +50,10 @@ func InitAll(config *Config) {
 	logging.OnError(err).Fatal("unable to initialize ZITADEL")
 }
 
-func initialise(config *Config, steps ...func(*sql.DB) error) error {
+func initialise(config database.Config, steps ...func(*sql.DB) error) error {
 	logging.Info("initialization started")
 
-	db, err := database.Connect(adminConfig(config))
+	db, err := database.Connect(config, true)
 	if err != nil {
 		return err
 	}

cmd/initialise/verify_database.go

@@ -34,7 +34,7 @@ The user provided by flags needs priviledge to
 		Run: func(cmd *cobra.Command, args []string) {
 			config := MustNewConfig(viper.New())
 
-			err := initialise(config, VerifyDatabase(config.Database.Database))
+			err := initialise(config.Database, VerifyDatabase(config.Database.Database()))
 			logging.OnError(err).Fatal("unable to initialize the database")
 		},
 	}

cmd/initialise/verify_grant.go

@@ -28,7 +28,7 @@ Prereqesits:
 		Run: func(cmd *cobra.Command, args []string) {
 			config := MustNewConfig(viper.New())
 
-			err := initialise(config, VerifyGrant(config.Database.Database, config.Database.Username))
+			err := initialise(config.Database, VerifyGrant(config.Database.Database(), config.Database.Username()))
 			logging.OnError(err).Fatal("unable to set grant")
 		},
 	}

cmd/initialise/verify_user.go

@@ -33,7 +33,7 @@ The user provided by flags needs priviledge to
 		Run: func(cmd *cobra.Command, args []string) {
 			config := MustNewConfig(viper.New())
 
-			err := initialise(config, VerifyUser(config.Database.Username, config.Database.Password))
+			err := initialise(config.Database, VerifyUser(config.Database.Username(), config.Database.Password()))
 			logging.OnError(err).Fatal("unable to init user")
 		},
 	}

cmd/initialise/verify_zitadel.go

@@ -95,7 +95,7 @@ func VerifyZitadel(db *sql.DB) error {
 
 func verifyZitadel(config database.Config) error {
 	logging.WithFields("database", config.Database).Info("verify zitadel")
-	db, err := database.Connect(config)
+	db, err := database.Connect(config, false)
 	if err != nil {
 		return err
 	}

cmd/key/key.go

@@ -124,7 +124,7 @@ func openFile(fileName string) (io.Reader, error) {
 }
 
 func keyStorage(config database.Config, masterKey string) (crypto.KeyStorage, error) {
-	db, err := database.Connect(config)
+	db, err := database.Connect(config, false)
 	if err != nil {
 		return nil, err
 	}

cmd/setup/config.go

@@ -36,6 +36,7 @@ func MustNewConfig(v *viper.Viper) *Config {
 			hook.TagToLanguageHookFunc(),
 			mapstructure.StringToTimeDurationHookFunc(),
 			mapstructure.StringToSliceHookFunc(","),
+			database.DecodeHook,
 		)),
 	)
 	logging.OnError(err).Fatal("unable to read default config")

cmd/setup/setup.go

@@ -56,7 +56,7 @@ func Flags(cmd *cobra.Command) {
 func Setup(config *Config, steps *Steps, masterKey string) {
 	logging.Info("setup started")
 
-	dbClient, err := database.Connect(config.Database)
+	dbClient, err := database.Connect(config.Database, false)
 	logging.OnError(err).Fatal("unable to connect to database")
 
 	eventstoreClient, err := eventstore.Start(dbClient)

cmd/start/config.go

@@ -65,6 +65,7 @@ func MustNewConfig(v *viper.Viper) *Config {
 			hook.TagToLanguageHookFunc(),
 			mapstructure.StringToTimeDurationHookFunc(),
 			mapstructure.StringToSliceHookFunc(","),
+			database.DecodeHook,
 		)),
 	)
 	logging.OnError(err).Fatal("unable to read config")

cmd/start/start.go

@@ -81,7 +81,7 @@ Requirements:
 func startZitadel(config *Config, masterKey string) error {
 	ctx := context.Background()
 
-	dbClient, err := database.Connect(config.Database)
+	dbClient, err := database.Connect(config.Database, false)
 	if err != nil {
 		return fmt.Errorf("cannot start client for projection: %w", err)
 	}
@@ -175,10 +175,10 @@ func startAPIs(ctx context.Context, router *mux.Router, commands *command.Comman
 	if err != nil {
 		return fmt.Errorf("error starting admin repo: %w", err)
 	}
-	if err := apis.RegisterServer(ctx, system.CreateServer(commands, queries, adminRepo, config.Database.Database, config.DefaultInstance)); err != nil {
+	if err := apis.RegisterServer(ctx, system.CreateServer(commands, queries, adminRepo, config.Database.Database(), config.DefaultInstance)); err != nil {
 		return err
 	}
-	if err := apis.RegisterServer(ctx, admin.CreateServer(config.Database.Database, commands, queries, config.SystemDefaults, adminRepo, config.ExternalSecure, keys.User)); err != nil {
+	if err := apis.RegisterServer(ctx, admin.CreateServer(config.Database.Database(), commands, queries, config.SystemDefaults, adminRepo, config.ExternalSecure, keys.User)); err != nil {
 		return err
 	}
 	if err := apis.RegisterServer(ctx, management.CreateServer(commands, queries, config.SystemDefaults, keys.User, config.ExternalSecure, config.AuditLogRetention)); err != nil {