Upgrading to 24.0.1.0

To upgrade to the latest version.

1. Upgrade dependencies to the new supported versions.
   See Upgrading.
2. Get access to the container images by following the steps in Getting access to images from the public IBM Entitled Registry.
3. Upgrade the operator to the new version before you apply your custom resource upgrades.
   • Go to https://github.com/ibmbpm/BAW-Ctnr/tree/24.0.1/archive and get the latest .tar file for the IBM Business Automation Workflow repository. Extract the contents from the .tar file, Use the tar -xvzf command to extract it to the cert-kubernetes directory.
   • Run the command to update baw related operators:

     ./scripts/upgradeOperator.sh -n <project_name> -a accept -m baw

4. Get the custom resource that you used to install Business Automation Workflow and update it for the new deployment.
   1. Change the metadata.labels.release parameter value to the new version, for example, 24.0.1.0.
   2. Change the appVersion parameter value in the spec section to the new version.
   3. Compare the new custom resource template under descriptors/patterns (for example, template ibm_cp4a_cr_production_FC_workflow-standalone.yaml) with the custom resource that you used to install. Change the image.tag parameter values in all sections to the new version. Where required, add mandatory parameters to the file and provide specific values for parameters that previously used the default value.

      If you did not run the script to upgrade:

      1. The pfs_configuration and elasticsearch_configuration sections, along with their titles, can be removed from your configuration. If you upgraded from 23.0.1 or a previous release, and choose to not use IBM Process Federation Server, you can remove the host_federated_portal setting from the baw_configuration.
      2. Perform the following actions to update baw_configuration[0].case section to the new structure:
         • Move the value of object_store_name_tos to baw_configuration[0].case.tos_list[0].object_store_name.
         • Move the value of connection_point_name_tos to baw_configuration[0].case.tos_list[0].connection_point_name. If connection_point_name_tos is not configured, get the value from initialize_configuration.ic_obj_store_creation.object_store. Find the target object store and copy the value of oc_cpe_obj_store_workflow_pe_conn_point_name.
         • Move the value of target_environment_name to baw_configuration[0].case.tos_list[0].target_environment_name. An example of a target object store in tos_list:

           baw_configuration:
             - name: bawins1  # Instance name added
               case:
                 tos_list:
                 - object_store_name: "BAWTOS"
                   connection_point_name: "pe_conn_target"
                   desktop_id: "baw"
                   target_environment_name: "target_env"
                   is_default: true
            

           where desktop_id and is_default are optional parameters. For a single target object store, the default value of desktop_id is baw and the default value of is_default is true. If there are more than one target object stores, specify the default target object store by using the is_default parameter.
   4. If the purchased production license is for:
      • Business Automation Workflow, then the shared_configuration.sc_deployment_context must be BAW and the possible values for shared_configuration.sc_deployment_baw_license are non-production and production.
      • Cloud Pak for Business Automation, then the shared_configuration.sc_deployment_context must be CP4A and the possible values for shared_configuration.sc_deployment_baw_license are user, non-production, and production.
   5. If you are using Red Hat® OpenShift®, continue to the next step.
      • For Workflow Server configuration, an example of a hostname update might be a change from baw.test1.9.x.x.x.nip.io to baw-test1.9.x.x.x.nip.io. If you want to keep the hostname that you defined in a previous release, add the hostname attribute under the baw_configuration section. For example:

        baw_configuration:
          - name: bawins1  # Instance name added
            hostname: "baw.test1.9.x.x.x.nip.io" 

      • For Process Federation Server configuration, an example of a hostname update might be a change from pfs.test1.9.x.x.x.nip.io to pfs-test1.9.x.x.x.nip.io. If you want to keep the hostname that you defined in a previous release, add the hostname attribute under the pfs_configuration section. For example,

        pfs_configuration:        
          hostname: "pfs.test1.9.x.x.x.nip.io" 

5. Apply and verify the upgraded deployment.
   • Run the following command to apply the custom resource:

     oc apply -f <ibm_cp4a_cr_production_FC_workflow-standalone.yaml> -n <baw_project>

   • See Verifying the installation to complete the upgrade and verify the Business Automation Workflow component.
   • See Completing post-upgrade tasks to verify that other components are included as part of Business Automation Workflow on containers.
   • If you want to enable full text search, see Enabling full text search. To continue using the saved searches in federated environments, follow the steps in Migrating saved searches to a new federated data repository.
   • If you want Business Automation Workflow to be federated, perform the following actions:
     1. Upgrade the Process Federation Server. For more information, see Upgrading.
     2. Set the following parameters.

        baw_configuration:
          - name: bawins1  # Instance name added
          full_text_search:
            enable: true
          elasticsearch:
            endpoint:
            admin_secret_name:
          process_federation_server:
            hostname:
            port:

        Note: If the port value is not set, the default value is 443.
        To find the Process Federation Server information, run the following command.

        oc get pfs -o=jsonpath='{.items[0].status.endpoints[?(@.name=="Process Federation Server External base URL")].uri}'

        To find Elasticsearch information, run the following command:

        oc get secret|grep elasticsearch
        oc get pfs -o=jsonpath='{.items[0].status.endpoints[?(@.name=="Elasticsearch Internal https URL")].uri}'

        You can choose whether Business Automation Workflow hosts federated Process Portal. If yes, set the following parameters.

        - name: bawins1
          host_federated_portal: true

        Note: Only one Business Automation Workflow runtime server connected to the Process Federation Server can host federated portal.