postgresconfig: Add support for custom secret keys.

Author: yjwong

api/v1alpha1/postgresconfig_types.go

@@ -78,6 +78,14 @@ type PostgresConfigStatus struct {
 type SecretRef struct {
 	// SecretName is the name of the secret.
 	SecretName string `json:"secretName,omitempty"`
+
+	// UsernameKey is the name of the key in the secret storing the username.
+	// The default value is POSTGRES_USER.
+	UsernameKey string `json:"usernameKey,omitempty"`
+
+	// PasswordKey is the name of the key in the secret storing the password.
+	// The default value is POSTGRES_PASSWORD.
+	PasswordKey string `json:"passwordKey,omitempty"`
 }
 
 //+kubebuilder:object:root=true

config/crd/bases/postgres.glints.com_postgresconfigs.yaml

@@ -53,9 +53,17 @@ spec:
                       namespace that contains credentials to authenticate against
                       the PostgreSQL server
                     properties:
+                      passwordKey:
+                        description: PasswordKey is the name of the key in the secret
+                          storing the password. The default value is POSTGRES_PASSWORD.
+                        type: string
                       secretName:
                         description: SecretName is the name of the secret.
                         type: string
+                      usernameKey:
+                        description: UsernameKey is the name of the key in the secret
+                          storing the username. The default value is POSTGRES_USER.
+                        type: string
                     type: object
                   variant:
                     description: 'Variant is for specific database-as-a-service providers.

config/crd/bases/postgres.glints.com_postgresgrants.yaml

@@ -90,9 +90,17 @@ spec:
                       namespace that contains credentials to authenticate against
                       the PostgreSQL server
                     properties:
+                      passwordKey:
+                        description: PasswordKey is the name of the key in the secret
+                          storing the password. The default value is POSTGRES_PASSWORD.
+                        type: string
                       secretName:
                         description: SecretName is the name of the secret.
                         type: string
+                      usernameKey:
+                        description: UsernameKey is the name of the key in the secret
+                          storing the username. The default value is POSTGRES_USER.
+                        type: string
                     type: object
                   variant:
                     description: 'Variant is for specific database-as-a-service providers.

config/crd/bases/postgres.glints.com_postgrespublications.yaml

@@ -65,9 +65,17 @@ spec:
                       namespace that contains credentials to authenticate against
                       the PostgreSQL server
                     properties:
+                      passwordKey:
+                        description: PasswordKey is the name of the key in the secret
+                          storing the password. The default value is POSTGRES_PASSWORD.
+                        type: string
                       secretName:
                         description: SecretName is the name of the secret.
                         type: string
+                      usernameKey:
+                        description: UsernameKey is the name of the key in the secret
+                          storing the username. The default value is POSTGRES_USER.
+                        type: string
                     type: object
                   variant:
                     description: 'Variant is for specific database-as-a-service providers.

config/crd/bases/postgres.glints.com_postgrestables.yaml

@@ -82,9 +82,17 @@ spec:
                       namespace that contains credentials to authenticate against
                       the PostgreSQL server
                     properties:
+                      passwordKey:
+                        description: PasswordKey is the name of the key in the secret
+                          storing the password. The default value is POSTGRES_PASSWORD.
+                        type: string
                       secretName:
                         description: SecretName is the name of the secret.
                         type: string
+                      usernameKey:
+                        description: UsernameKey is the name of the key in the secret
+                          storing the username. The default value is POSTGRES_USER.
+                        type: string
                     type: object
                   variant:
                     description: 'Variant is for specific database-as-a-service providers.

controllers/suite_test.go

@@ -139,7 +139,7 @@ func SetupPostgresContainer(ctx context.Context) {
 	BeforeEach(func() {
 		const port = "5432/tcp"
 		req := testcontainers.ContainerRequest{
-			Image: "postgres:12-alpine",
+			Image: "postgres:14-alpine",
 			Env: map[string]string{
 				"POSTGRES_USER":     postgresUser,
 				"POSTGRES_PASSWORD": postgresPassword,

controllers/utils/utils.go

@@ -40,11 +40,21 @@ func SetupPostgresConnection(
 		return nil, &ErrGetSecret{Err: err}
 	}
 
+	usernameKey := "POSTGRES_USER"
+	if len(ref.SecretRef.UsernameKey) > 0 {
+		usernameKey = ref.SecretRef.UsernameKey
+	}
+
+	passwordKey := "POSTGRES_PASSWORD"
+	if len(ref.SecretRef.PasswordKey) > 0 {
+		passwordKey = ref.SecretRef.PasswordKey
+	}
+
 	connURL := url.URL{
 		Scheme: "postgres",
 		User: url.UserPassword(
-			string(secretRef.Data["POSTGRES_USER"]),
-			string(secretRef.Data["POSTGRES_PASSWORD"]),
+			string(secretRef.Data[usernameKey]),
+			string(secretRef.Data[passwordKey]),
 		),
 		Host:    fmt.Sprintf("%s:%d", ref.Host, ref.Port),
 		Path:    fmt.Sprintf("/%s", ref.Database),