Changes based on latest feedback from Ricardo

Signed-off-by: Jordi Gil <[email protected]>
apache · Jan 29, 2024 · 7b43534 · 7b43534
1 parent 577f9f0
commit 7b43534
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 40 deletions.
diff --git a/api/v1alpha08/sonataflowplatform_types.go b/api/v1alpha08/sonataflowplatform_types.go
@@ -54,11 +54,9 @@ type SonataFlowPlatformSpec struct {
 }
 
 // PlatformPersistenceSpec configures the DataBase support for both platform services and workflows. For services, it allows
-// configuring a generic database connectivity if the service does not come with its own configured. In case of the workflow
-// the configuration is defined by the image name of the supported database. When the workflow is configured to require
-// a database backend type supported by the platform (that is, the platform CR contains an image name for that database type)
-// , the workflow pod is configured to contain a sidecar container running the database image defined here, and the workflow
-// JDBC connectivity is setup to point to the DB container.
+// configuring a generic database connectivity if the service does not come with its own configured. In case of workflows,
+// the operator will add the necessary JDBC properties to in the workflow's application.properties so that it can communicate
+// with the persistence service based on the spec provided here.
 // +optional
 type PlatformPersistenceSpec struct {
 	// Connect configured services to a postgresql database.
@@ -69,7 +67,7 @@ type PlatformPersistenceSpec struct {
 // PostgreSQLPlatformSpec provides the generic configuration details to configure the JDBC URL and establish a connection for each managed services when they don't provide their own configuration.
 type PostgreSQLPlatformSpec struct {
 	// SecretRef contains the database user credentials
-	SecretRef SecretReference `json:"secretRef"`
+	SecretRef PostgreSqlSecretOptions `json:"secretRef"`
 	// ServiceRef contains the K8s service name and namespace location of the PostgreSQL service.
 	ServiceRef ServiceReference `json:"serviceRef,omitempty"`
 	// Name of postgresql database to be used. Defaults to "sonataflow"
@@ -89,16 +87,6 @@ type ServiceReference struct {
 	Port int `json:"port,omitempty"`
 }
 
-// SecretReference use of a secret to store the credentials to authenticate in the JDBC connection.
-type SecretReference struct {
-	// Name of the postgresql credentials secret. This field is mandatory.
-	Name string `json:"name"`
-	// +optional
-	UserKey string `json:"userKey,omitempty"`
-	// +optional
-	PasswordKey string `json:"passwordKey,omitempty"`
-}
-
 // PlatformCluster is the kind of orchestration cluster the platform is installed into
 // +kubebuilder:validation:Enum=kubernetes;openshift
 type PlatformCluster string

diff --git a/api/v1alpha08/zz_generated.deepcopy.go b/api/v1alpha08/zz_generated.deepcopy.go
diff --git a/bundle/manifests/sonataflow.org_sonataflowplatforms.yaml b/bundle/manifests/sonataflow.org_sonataflowplatforms.yaml
@@ -439,11 +439,12 @@ spec:
                         properties:
                           name:
                             description: Name of the postgresql credentials secret.
-                              This field is mandatory.
                             type: string
                           passwordKey:
+                            description: Defaults to POSTGRESQL_PASSWORD
                             type: string
                           userKey:
+                            description: Defaults to POSTGRESQL_USER
                             type: string
                         required:
                         - name

diff --git a/config/crd/bases/sonataflow.org_sonataflowplatforms.yaml b/config/crd/bases/sonataflow.org_sonataflowplatforms.yaml
@@ -440,11 +440,12 @@ spec:
                         properties:
                           name:
                             description: Name of the postgresql credentials secret.
-                              This field is mandatory.
                             type: string
                           passwordKey:
+                            description: Defaults to POSTGRESQL_PASSWORD
                             type: string
                           userKey:
+                            description: Defaults to POSTGRESQL_USER
                             type: string
                         required:
                         - name

diff --git a/controllers/platform/services/services.go b/controllers/platform/services/services.go
@@ -156,7 +156,7 @@ func (d DataIndexHandler) ConfigurePersistence(containerSpec *corev1.Container)
 			c.Env = append(c.Env, persistence.ConfigurePostgreSQLEnvFromPlatformSpec(d.platform.Spec.Persistence.PostgreSQL, d.GetServiceName())...)
 		}
 		// specific to DataIndex
-		c.Env = append(c.Env, corev1.EnvVar{Name: "QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION", Value: "update"}, corev1.EnvVar{Name: "QUARKUS_FLYWAY_MIGRATE_AT_START", Value: "true"})
+		c.Env = append(c.Env, corev1.EnvVar{Name: quarkusHibernateORMDatabaseGeneration, Value: "update"}, corev1.EnvVar{Name: quarkusFlywayMigrateAtStart, Value: "true"})
 		return c
 	}
 	return containerSpec

diff --git a/controllers/profiles/common/object_creators_test.go b/controllers/profiles/common/object_creators_test.go
@@ -368,7 +368,7 @@ func TestMergePodSpec_WithServicedPostgreSQL_In_Platform_CR_And_Worflow_Requesti
 		&v1alpha08.PlatformPersistenceSpec{
 			PostgreSQL: &v1alpha08.PostgreSQLPlatformSpec{
 				DatabaseName: "foo",
-				SecretRef: v1alpha08.SecretReference{
+				SecretRef: v1alpha08.PostgreSqlSecretOptions{
 					Name:        "foo_secret",
 					UserKey:     "username",
 					PasswordKey: "password",
@@ -439,7 +439,7 @@ func TestMergePodSpec_WithServicedPostgreSQL_In_Platform_And_In_Workflow_CR(t *t
 		&v1alpha08.PlatformPersistenceSpec{
 			PostgreSQL: &v1alpha08.PostgreSQLPlatformSpec{
 				DatabaseName: "foo",
-				SecretRef: v1alpha08.SecretReference{
+				SecretRef: v1alpha08.PostgreSqlSecretOptions{
 					Name:        "foo_secret",
 					UserKey:     "username",
 					PasswordKey: "password",
@@ -537,7 +537,7 @@ func TestMergePodSpec_WithServicedPostgreSQL_In_Platform_But_Workflow_CR_Not_Req
 		&v1alpha08.PlatformPersistenceSpec{
 			PostgreSQL: &v1alpha08.PostgreSQLPlatformSpec{
 				DatabaseName: "foo",
-				SecretRef: v1alpha08.SecretReference{
+				SecretRef: v1alpha08.PostgreSqlSecretOptions{
 					Name:        "foo_secret",
 					UserKey:     "username",
 					PasswordKey: "password",

diff --git a/controllers/sonataflowplatform_controller_test.go b/controllers/sonataflowplatform_controller_test.go
@@ -264,7 +264,7 @@ func TestSonataFlowPlatformController(t *testing.T) {
 			},
 			Persistence: &v1alpha08.PlatformPersistenceSpec{
 				PostgreSQL: &v1alpha08.PostgreSQLPlatformSpec{
-					SecretRef:    v1alpha08.SecretReference{Name: "generic", UserKey: "POSTGRESQL_USER", PasswordKey: "POSTGRESQL_PASSWORD"},
+					SecretRef:    v1alpha08.PostgreSqlSecretOptions{Name: "generic", UserKey: "POSTGRESQL_USER", PasswordKey: "POSTGRESQL_PASSWORD"},
 					ServiceRef:   v1alpha08.ServiceReference{Name: "postgresql", Namespace: "default", Port: 5432},
 					DatabaseName: "sonataflow",
 				},
@@ -369,7 +369,7 @@ func TestSonataFlowPlatformController(t *testing.T) {
 			},
 			Persistence: &v1alpha08.PlatformPersistenceSpec{
 				PostgreSQL: &v1alpha08.PostgreSQLPlatformSpec{
-					SecretRef:    v1alpha08.SecretReference{Name: "generic", UserKey: "POSTGRESQL_USER", PasswordKey: "POSTGRESQL_PASSWORD"},
+					SecretRef:    v1alpha08.PostgreSqlSecretOptions{Name: "generic", UserKey: "POSTGRESQL_USER", PasswordKey: "POSTGRESQL_PASSWORD"},
 					ServiceRef:   v1alpha08.ServiceReference{Name: "postgresql", Namespace: "default", Port: 5432},
 					DatabaseName: "sonataflow",
 				},

diff --git a/operator.yaml b/operator.yaml
@@ -803,11 +803,12 @@ spec:
                         properties:
                           name:
                             description: Name of the postgresql credentials secret.
-                              This field is mandatory.
                             type: string
                           passwordKey:
+                            description: Defaults to POSTGRESQL_PASSWORD
                             type: string
                           userKey:
+                            description: Defaults to POSTGRESQL_USER
                             type: string
                         required:
                         - name