Chapter 8. Managing upgrades

Procedure

1. Ensure you have a backup of all necessary Kubernetes resources, including SonataFlow custom resource definitions (CRDs), ConfigMaps, or any other related custom configurations.

2. Delete the workflow by executing the following command:

   $ oc delete -f <my-workflow.yaml> -n <target_namespace>

Procedure

1. If you are using persistence, back up the workflow database and ensure the backup includes both database objects and table data.
2. Ensure you have a backup of all necessary Kubernetes resources, including SonataFlow CRDs, ConfigMaps, or any other related custom configurations.

3. Delete the workflow by executing the following command:

   $ oc delete -f <my-workflow.yaml> -n <target_namespace>

4. If you are using persistence, you must execute the following database migration script:

   ALTER TABLE flyway_schema_history
       RENAME CONSTRAINT flyway_schema_history_pk TO kie_flyway_history_runtime_persistence_pk;
   
   ALTER INDEX flyway_schema_history_s_idx
     RENAME TO kie_flyway_history_runtime_persistence_s_idx;
   
   ALTER TABLE flyway_schema_history RENAME TO kie_flyway_history_runtime_persistence;

Procedure

1. Modify the my-workflow.yaml CRD and scale down each workflow to zero before upgrading as shown in the following example:

   spec:
     podTemplate:
       replicas: 0

2. Apply the updated CRD by running the following command:

   $ oc apply -f <my-workflow.yaml> -n <target_namespace>

3. (Optional) Scale the workflow to 0 by running the following command:

   $ oc patch sonataflow <my-workflow> -n <target_namespace> --type=merge -p '{"spec": {"podTemplate": {"replicas": 0}}}'

Procedure

1. Verify the new ReplicaSet exists by listing all ReplicaSets by running the following command:

   $ oc get replicasets -n <target_namespace> -o custom-columns=Name:metadata.name,Image:spec.template.spec.containers[*].image

2. Identify the old Data Index ReplicaSet (with version 1.34.0) and delete it:

   $ oc delete replicaset <old_replicaset_name> -n <target_namespace>

Procedure

1. Delete the old Jobs Service deployment by running the following command:

   $ oc delete deployment <jobs-service-deployment-name> -n <target_namespace>

   This will trigger automatic cleanup of the older Pods and ReplicaSets and initiate a fresh deployment using version 1.35.0.

Procedure

1. Ensure all required resources are restored, including SonataFlow CRDs, ConfigMaps, or any other related custom configurations.

2. Redeploy the workflow by running the following command:

   $ oc apply -f <my-workflow.yaml> -n <target_namespace>

Procedure

1. If the workflow uses persistence, add the following property to the ConfigMap associated with the workflow:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     labels:
       app: my-workflow
     name: my-workflow-props
   data:
     application.properties: |
       kie.flyway.enabled=true

2. Ensure all required resources are recreated, including SonataFlow CRDs, ConfigMaps, or any other related custom configurations.

3. Redeploy the workflow by running the following command:

   $ oc apply -f <my-workflow.yaml> -n <target_namespace>

Procedure

1. Modify the my-workflow.yaml CRD and scale up each workflow to one before upgrading as shown in the following example:

   spec:
     podTemplate:
       replicas: 1

2. Apply the updated CRD by running the following command:

   $ oc apply -f <my-workflow.yaml> -n <target_namespace>

3. (Optional) Scale the workflow back to 1 by running the following command:

   $ oc patch sonataflow <my-workflow> -n <target_namespace> --type=merge -p '{"spec": {"podTemplate": {"replicas": 1}}}'

Procedure

1. Check if all workflows and services are running by entering the following command:

   $ oc get pods -n <target_namespace>

   Ensure that all pods related to workflows, Data Index, and Jobs Service are in a Running or Completed state.

2. Verify that the OpenShift Serverless Logic Operator is running correctly by entering the following command:

   $ oc get clusterserviceversion logic-operator-rhel8.v1.35.0 -n openshift-serverless-logic

   Expected output

   NAME                           DISPLAY                               VERSION   REPLACES                       PHASE
   logic-operator-rhel8.v1.35.0   OpenShift Serverless Logic Operator   1.35.0    logic-operator-rhel8.v1.34.0   Succeeded

3. Check Operator logs for any errors by entering the following command:

   $ oc logs -l control-plane=sonataflow-operator -n openshift-serverless-logic