kie-issues#2789: [sonataflow-operator] Implement DB Migrator Changes into SonataFlow Operator

packages/sonataflow-operator/api/v1alpha08/sonataflow_persistence_types.go

@@ -17,6 +17,14 @@
 
 package v1alpha08
 
+type DBMigrationStrategyType string
+
+const (
+	DBMigrationStrategyService DBMigrationStrategyType = "service"
+	DBMigrationStrategyJob     DBMigrationStrategyType = "job"
+	DBMigrationStrategyNone    DBMigrationStrategyType = "none"
+)
+
 // 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
@@ -54,10 +62,13 @@ type PersistenceOptionsSpec struct {
 	// +optional
 	PostgreSQL *PersistencePostgreSQL `json:"postgresql,omitempty"`
 
-	// Whether to migrate database on service startup?
+	// DB Migration approach for service?
+	// job: use job based approach
+	// service: service itself shall migrate the db
+	// none: no db migration needed
 	// +optional
-	// +default: false
-	MigrateDBOnStartUp bool `json:"migrateDBOnStartUp"`
+	// +kubebuilder:default:=service
+	DBMigrationStrategy string `json:"dbMigrationStrategy,omitempty"`
 }
 
 // PersistencePostgreSQL configure postgresql connection for service(s).

packages/sonataflow-operator/api/v1alpha08/sonataflowplatform_types.go

@@ -104,6 +104,31 @@ const (
 	PlatformDuplicatedReason = "Duplicated"
 )
 
+type DBMigrationStatus string
+
+const (
+	DBMigrationStatusStarted    DBMigrationStatus = "Started"
+	DBMigrationStatusInProgress DBMigrationStatus = "In-Progress"
+	DBMigrationStatusSucceeded  DBMigrationStatus = "Succeeded"
+	DBMigrationStatusFailed     DBMigrationStatus = "Failed"
+
+	MessageDBMigrationStatusStarted    string = "Started the database migrations for the services"
+	MessageDBMigrationStatusInProgress string = "The database migrations for the services are in-progress"
+	MessageDBMigrationStatusSucceeded  string = "The database migrations for the services are successful"
+	MessageDBMigrationStatusFailed     string = "The database migrations for the services have failed"
+
+	ReasonDBMigrationStatusStarted    string = "Started by SonataFlow operator"
+	ReasonDBMigrationStatusInProgress string = "The database migration job is in-progress"
+	ReasonDBMigrationStatusSucceeded  string = "The database migration job completed as expected"
+	ReasonDBMigrationStatusFailed     string = "The database may be unreachable, invalid credentials supplied or flyway migration failed. Please check logs for further details."
+)
+
+type SonataFlowPlatformDBMigrationPhase struct {
+	Status  DBMigrationStatus `json:"dbMigrationStatus,omitempty"`
+	Message string            `json:"message,omitempty"`
+	Reason  string            `json:"reason,omitempty"`
+}
+
 // SonataFlowPlatformStatus defines the observed state of SonataFlowPlatform
 // +k8s:openapi-gen=true
 type SonataFlowPlatformStatus struct {
@@ -123,6 +148,8 @@ type SonataFlowPlatformStatus struct {
 	// Triggers list of triggers created for the SonataFlowPlatform
 	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="triggers"
 	Triggers []SonataFlowPlatformTriggerRef `json:"triggers,omitempty"`
+	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="dbMigrationStatus"
+	SonataFlowPlatformDBMigrationPhase *SonataFlowPlatformDBMigrationPhase `json:"sonataFlowPlatformDBMigrationPhase,omitempty"`
 }
 
 // SonataFlowPlatformTriggerRef defines a trigger created for the SonataFlowPlatform.

packages/sonataflow-operator/config/manager/controllers_cfg.yaml

@@ -30,6 +30,8 @@ jobsServiceEphemeralImageTag: "docker.io/apache/incubator-kie-kogito-jobs-servic
 # The Data Index image to use, if empty the operator will use the default Apache Community one based on the current operator's version
 dataIndexPostgreSQLImageTag: "docker.io/apache/incubator-kie-kogito-data-index-postgresql:main"
 dataIndexEphemeralImageTag: "docker.io/apache/incubator-kie-kogito-data-index-ephemeral:main"
+# The Kogito PostgreSQL DB Migrator image to use (TBD: to replace with apache image)
+kogitoDBMigratorToolImageTag: "quay.io/rhkp/incubator-kie-kogito-service-db-migration-postgresql:latest"
 # SonataFlow base builder image used in the internal Dockerfile to build workflow applications in preview profile
 # Order of precedence is:
 # 1. SonataFlowPlatform in the given namespace

packages/sonataflow-operator/config/manifests/bases/sonataflow-operator.clusterserviceversion.yaml

@@ -181,6 +181,8 @@ spec:
           - description: Info generic information related to the Platform
             displayName: info
             path: info
+          - displayName: dbMigrationStatus
+            path: sonataFlowPlatformDBMigrationPhase
           - description: Triggers list of triggers created for the SonataFlowPlatform
             displayName: triggers
             path: triggers

packages/sonataflow-operator/config/rbac/role.yaml

@@ -21,6 +21,18 @@ kind: ClusterRole
 metadata:
   name: manager-role
 rules:
+  - apiGroups:
+      - batch
+    resources:
+      - jobs
+    verbs:
+      - create
+      - delete
+      - get
+      - list
+      - patch
+      - update
+      - watch
   - apiGroups:
       - monitoring.coreos.com
     resources:

packages/sonataflow-operator/internal/controller/cfg/controllers_cfg.go

@@ -63,6 +63,7 @@ type ControllersCfg struct {
 	JobsServiceEphemeralImageTag    string            `yaml:"jobsServiceEphemeralImageTag,omitempty"`
 	DataIndexPostgreSQLImageTag     string            `yaml:"dataIndexPostgreSQLImageTag,omitempty"`
 	DataIndexEphemeralImageTag      string            `yaml:"dataIndexEphemeralImageTag,omitempty"`
+	KogitoDBMigratorToolImageTag    string            `yaml:"kogitoDBMigratorToolImageTag,omitempty"`
 	SonataFlowBaseBuilderImageTag   string            `yaml:"sonataFlowBaseBuilderImageTag,omitempty"`
 	SonataFlowDevModeImageTag       string            `yaml:"sonataFlowDevModeImageTag,omitempty"`
 	BuilderConfigMapName            string            `yaml:"builderConfigMapName,omitempty"`