feat: add yugabytedb module

docs/modules/yugabytedb.md

@@ -49,6 +49,18 @@ E.g. `Run(context.Background(), "yugabytedb/yugabyte")`.
 
 {% include "../features/common_functional_options.md" %}
 
+#### Initial Database
+
+By default the yugabyteDB container will start with a database named `yugabyte` and the default credentials `yugabyte` and `yugabyte`.
+
+If you need to set a different database, and its credentials, you can use the `WithDatabaseName(dbName string)`, `WithDatabaseUser(dbUser string)` and `WithDatabasePassword(dbPassword string)` options.
+
+#### Initial Cluster Configuration
+
+By default the yugabyteDB container will start with a cluster keyspace named `yugabyte` and the default credentials `yugabyte` and `yugabyte`.
+
+If you need to set a different cluster keyspace, and its credentials, you can use the `WithKeyspace(keyspace string)`, `WithUser(user string)` and `WithPassword(password string)` options.
+
 ### Container Methods
 
 The yugabyteDB container exposes the following methods:

modules/yugabytedb/options.go

@@ -5,25 +5,25 @@ import (
 )
 
 // WithDatabaseName sets the initial database name for the yugabyteDB container.
-func WithDatabaseName(ysqlDBName string) testcontainers.CustomizeRequestOption {
+func WithDatabaseName(dbName string) testcontainers.CustomizeRequestOption {
 	return func(req *testcontainers.GenericContainerRequest) error {
-		req.Env[ysqlDatabaseNameEnv] = ysqlDBName
+		req.Env[ysqlDatabaseNameEnv] = dbName
 		return nil
 	}
 }
 
 // WithDatabaseUser sets the initial database user for the yugabyteDB container.
-func WithDatabaseUser(ysqlDBUser string) testcontainers.CustomizeRequestOption {
+func WithDatabaseUser(dbUser string) testcontainers.CustomizeRequestOption {
 	return func(req *testcontainers.GenericContainerRequest) error {
-		req.Env[ysqlDatabaseUserEnv] = ysqlDBUser
+		req.Env[ysqlDatabaseUserEnv] = dbUser
 		return nil
 	}
 }
 
 // WithDatabasePassword sets the initial database password for the yugabyteDB container.
-func WithDatabasePassword(ysqlDBPassword string) testcontainers.CustomizeRequestOption {
+func WithDatabasePassword(dbPassword string) testcontainers.CustomizeRequestOption {
 	return func(req *testcontainers.GenericContainerRequest) error {
-		req.Env[ysqlDatabasePasswordEnv] = ysqlDBPassword
+		req.Env[ysqlDatabasePasswordEnv] = dbPassword
 		return nil
 	}
 }