[KOGITO-9980] Add persistence to SonataflowPlatform CRD

.github/workflows/e2e.yml

@@ -77,6 +77,12 @@ jobs:
         run: |
           make test-e2e
 
+      - name: Retrieve cluster events and list pods
+        if: failure()
+        run: |
+          kubectl get events
+          kubectl get pod -A
+
       - name: Export kind logs
         if: always()
         run: |

api/v1alpha08/sonataflow_persistence_types.go

@@ -0,0 +1,102 @@
+// Copyright 2024 Apache Software Foundation (ASF)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha08
+
+// PlatformPersistenceOptionsSpec configures the DataBase in the platform spec. This specification can
+// be used by workflows and platform services when they don't provide one of their own.
+// +optional
+// +kubebuilder:validation:MaxProperties=1
+type PlatformPersistenceOptionsSpec struct {
+	// Connect configured services to a postgresql database.
+	// +optional
+	PostgreSQL *PlatformPersistencePostgreSQL `json:"postgresql,omitempty"`
+}
+
+// PlatformPersistencePostgreSQL configure postgresql connection in a platform to be shared
+// by platform services and workflows when required.
+// +kubebuilder:validation:MinProperties=2
+// +kubebuilder:validation:MaxProperties=2
+type PlatformPersistencePostgreSQL struct {
+	// Secret reference to the database user credentials
+	SecretRef PostgreSQLSecretOptions `json:"secretRef"`
+	// Service reference to postgresql datasource. Mutually exclusive to jdbcUrl.
+	// +optional
+	ServiceRef *SQLServiceOptions `json:"serviceRef,omitempty"`
+	// PostgreSql JDBC URL. Mutually exclusive to serviceRef.
+	// e.g. "jdbc:postgresql://host:port/database?currentSchema=data-index-service"
+	// +optional
+	JdbcUrl string `json:"jdbcUrl,omitempty"`
+}
+
+// PersistenceOptionsSpec 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 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
+// +kubebuilder:validation:MaxProperties=1
+type PersistenceOptionsSpec struct {
+	// Connect configured services to a postgresql database.
+	// +optional
+	PostgreSQL *PersistencePostgreSQL `json:"postgresql,omitempty"`
+}
+
+// PersistencePostgreSQL configure postgresql connection for service(s).
+// +kubebuilder:validation:MinProperties=2
+// +kubebuilder:validation:MaxProperties=2
+type PersistencePostgreSQL struct {
+	// Secret reference to the database user credentials
+	SecretRef PostgreSQLSecretOptions `json:"secretRef"`
+	// Service reference to postgresql datasource. Mutually exclusive to jdbcUrl.
+	// +optional
+	ServiceRef *PostgreSQLServiceOptions `json:"serviceRef,omitempty"`
+	// PostgreSql JDBC URL. Mutually exclusive to serviceRef.
+	// e.g. "jdbc:postgresql://host:port/database?currentSchema=data-index-service"
+	// +optional
+	JdbcUrl string `json:"jdbcUrl,omitempty"`
+}
+
+// PostgreSQLSecretOptions use credential secret for postgresql connection.
+type PostgreSQLSecretOptions struct {
+	// Name of the postgresql credentials secret.
+	Name string `json:"name"`
+	// Defaults to POSTGRESQL_USER
+	// +optional
+	UserKey string `json:"userKey,omitempty"`
+	// Defaults to POSTGRESQL_PASSWORD
+	// +optional
+	PasswordKey string `json:"passwordKey,omitempty"`
+}
+
+type SQLServiceOptions struct {
+	// Name of the postgresql k8s service.
+	Name string `json:"name"`
+	// Namespace of the postgresql k8s service. Defaults to the SonataFlowPlatform's local namespace.
+	// +optional
+	Namespace string `json:"namespace,omitempty"`
+	// Port to use when connecting to the postgresql k8s service. Defaults to 5432.
+	// +optional
+	Port *int `json:"port,omitempty"`
+	// Name of postgresql database to be used. Defaults to "sonataflow"
+	// +optional
+	DatabaseName string `json:"databaseName,omitempty"`
+}
+
+// PostgreSQLServiceOptions use k8s service to configure postgresql jdbc url.
+type PostgreSQLServiceOptions struct {
+	*SQLServiceOptions `json:",inline"`
+	// Schema of postgresql database to be used. Defaults to "data-index-service"
+	// +optional
+	DatabaseSchema string `json:"databaseSchema,omitempty"`
+}

api/v1alpha08/sonataflow_types.go

@@ -657,9 +657,8 @@ type SonataFlowSpec struct {
 	// PodTemplate describes the deployment details of this SonataFlow instance.
 	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="podTemplate"
 	PodTemplate PodTemplateSpec `json:"podTemplate,omitempty"`
-	// Persists service to a datasource of choice. Ephemeral by default.
-	// +optional
-	Persistence *PersistenceOptions `json:"persistence,omitempty"`
+	// Persistence defines the database persistence configuration for the workflow
+	Persistence *PersistenceOptionsSpec `json:"persistence,omitempty"`
 }
 
 // SonataFlowStatus defines the observed state of SonataFlow

api/v1alpha08/sonataflowplatform_services_types.go

@@ -32,61 +32,8 @@ type ServiceSpec struct {
 	Enabled *bool `json:"enabled,omitempty"`
 	// Persists service to a datasource of choice. Ephemeral by default.
 	// +optional
-	Persistence *PersistenceOptions `json:"persistence,omitempty"`
+	Persistence *PersistenceOptionsSpec `json:"persistence,omitempty"`
 	// PodTemplate describes the deployment details of this platform service instance.
 	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="podTemplate"
 	PodTemplate PodTemplateSpec `json:"podTemplate,omitempty"`
 }
-
-// PersistenceOptions configure the services to persist to a datasource of choice
-// +kubebuilder:validation:MaxProperties=1
-type PersistenceOptions struct {
-	// Connect configured services to a postgresql database.
-	// +optional
-	PostgreSql *PersistencePostgreSql `json:"postgresql,omitempty"`
-}
-
-// PersistencePostgreSql configure postgresql connection for service(s).
-// +kubebuilder:validation:MinProperties=2
-// +kubebuilder:validation:MaxProperties=2
-type PersistencePostgreSql struct {
-	// Secret reference to the database user credentials
-	SecretRef PostgreSqlSecretOptions `json:"secretRef"`
-	// Service reference to postgresql datasource. Mutually exclusive to jdbcUrl.
-	// +optional
-	ServiceRef *PostgreSqlServiceOptions `json:"serviceRef,omitempty"`
-	// PostgreSql JDBC URL. Mutually exclusive to serviceRef.
-	// e.g. "jdbc:postgresql://host:port/database?currentSchema=data-index-service"
-	// +optional
-	JdbcUrl string `json:"jdbcUrl,omitempty"`
-}
-
-// PostgreSqlSecretOptions use credential secret for postgresql connection.
-type PostgreSqlSecretOptions struct {
-	// Name of the postgresql credentials secret.
-	Name string `json:"name"`
-	// Defaults to POSTGRESQL_USER
-	// +optional
-	UserKey string `json:"userKey,omitempty"`
-	// Defaults to POSTGRESQL_PASSWORD
-	// +optional
-	PasswordKey string `json:"passwordKey,omitempty"`
-}
-
-// PostgreSqlServiceOptions use k8s service to configure postgresql jdbc url.
-type PostgreSqlServiceOptions struct {
-	// Name of the postgresql k8s service.
-	Name string `json:"name"`
-	// Namespace of the postgresql k8s service. Defaults to the SonataFlowPlatform's local namespace.
-	// +optional
-	Namespace string `json:"namespace,omitempty"`
-	// Port to use when connecting to the postgresql k8s service. Defaults to 5432.
-	// +optional
-	Port *int `json:"port,omitempty"`
-	// Name of postgresql database to be used. Defaults to "sonataflow"
-	// +optional
-	DatabaseName string `json:"databaseName,omitempty"`
-	// Schema of postgresql database to be used. Defaults to "data-index-service"
-	// +optional
-	DatabaseSchema string `json:"databaseSchema,omitempty"`
-}

api/v1alpha08/sonataflowplatform_types.go

@@ -47,6 +47,11 @@ type SonataFlowPlatformSpec struct {
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Services"
 	Services *ServicesPlatformSpec `json:"services,omitempty"`
+	// Persistence defines the platform persistence configuration. When this field is set,
+	// the configuration is used as the persistence for platform services and sonataflow instances
+	// that don't provide one of their own.
+	// +optional
+	Persistence *PlatformPersistenceOptionsSpec `json:"persistence,omitempty"`
 }
 
 // PlatformCluster is the kind of orchestration cluster the platform is installed into