Upgrading multiple CP4BA instances in All Namespaces from 21.0.3 or 22.0.2

From 24.0.0-IF001 you can upgrade multiple Cloud Pak for Business Automation instances in All Namespaces from 21.0.3-IF031 or later or 22.0.2-IF006 to 24.0.0-IF001.

Before you begin

  • The steps in the Procedure section are applicable to your Cloud Pak for Business Automation deployment if:
    • You configured your Cloud Pak for Business Automation in 21.0.3-IF031 or later or 22.0.2-IF006 in All Namespaces.
    • Your Cloud Pak for Business Automation and Cloud Pak foundational services are installed in openshift-operators namespace.
    • You have multiple instances of Cloud Pak for Business Automation installed.
    Note: You must upgrade all instances of Cloud Pak for Business Automation one by one.
  • Download cert-kubernetes to a Linux® based machine (RHEL or macOS) to update the catalog sources for the new release.

    All the installation and upgrade artifacts are contained in the cert-kubernetes repository. It is recommended to use the latest interim fix of the release, but if you do need a previous version then you can find them all in the Cloud Pak for Business Automation download document.

    Tip: Use the move right arrow Move right arrow in the 24.0.0 release to find all the available interim fixes.

    To download the cert-kubernetes repository.

    1. Open the Cloud Pak for Business Automation download document, find the card for the latest 24.0.0 interim fix, click Cert Kubernetes, and then select and copy the displayed command.
    2. Run the copied git clone command to download the files.
  • If your Cloud Pak for Business Automation includes Business Automation Insights, choose a migration strategy before you start your migration. For more information, see Premigrating Business Automation Insights data to OpenSearch.

About this task

You can upgrade all the Cloud Pak for Business Automation 21.0.3-IF031 or later or 22.0.2-IF006 deployments that you created from the operators in All Namespaces to Cloud Pak for Business Automation 24.0.0-IF001.

The procedure assumes that you have two Cloud Pak for Business Automation instances and you want to upgrade to 24.0.0-IF001. You can follow the same steps for more than two Cloud Pak for Business Automation instances.

When you run the script, the script output displays some details. Steps that are tagged as:
  • [INFO]: Provides details of the actions that the script takes.
  • [ATTENTION]: Provides important details that you need to know or do during the upgrade.
  • [NEXT ACTION]: Provides the commands or script that you need to run to proceed with upgrade.

Procedure

  1. Log in to the target cluster from a client.
    oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR>
  2. Open multiple CLI windows and keep them open side by side. Each CLI window is used to upgrade one Cloud Pak for Business Automation instance.
  3. Change the directory to the scripts folder under cert-kubernetes/scripts.
  4. In the first CLI window, run the cp4a-deployment.sh script from cert-kubernetes in the upgradeOperator mode.
    ./cp4a-deployment.sh -m upgradeOperator -n <first_project_name>

    Where <first_project_name> is the namespace of the first Cloud Pak for Business Automation instance you want to upgrade.

    1. If the script detects Elasticsearch and Business Automation Insights, the script then asks if you completed the migration from Elasticsearch to OpenSearch. Select No if you did not complete the migration and then go to Installing OpenSearch and migrating Elasticsearch data. Select Yes if you completed migration from Elasticsearch to OpenSearch.
      Remember: Business Automation Insights uses Elasticsearch, and so does Process Federation Server. If you have either of these components in the cluster and you want to upgrade them, then you must migrate from Elasticsearch to OpenSearch.
      Note: If your Cloud Pak for Business Automation includes IBM Business Automation Workflow without Business Automation Insights, you do not need to migrate Elasticsearch to OpenSearch because Process Federation Server is removed in the upgrade. If you want to continue to use Process Federation Server after the upgrade, then you do need to migrate your Elasticsearch data.
    2. If the script detects Elasticsearch and no Business Automation Insights component, then the script asks if you are planning to use Process Federation Server after the upgrade and if you want to do the migration of Elasticsearch to OpenSearch? (Yes/No).
      • If you select Yes, the script asks if you completed the migration from Elasticsearch to OpenSearch. If you did not complete the migration select No, and then go to Installing OpenSearch and migrating Elasticsearch data. If you completed the migration from Elasticsearch to OpenSearch, select Yes.
      • If you select No, continue to upgrade the CP4BA operators without migrating Elasticsearch.
    3. After you run the ./cp4a-deployment.sh -m upgradeOperator -n <first_project_name> command, the script detects that you installed the Cloud Pak foundational services in All Namespaces.

      The script then checks whether your Cloud Pak for Business Automation deployment includes components from IBM FileNet® Content Manager.

      The script shows the following message if it detects components from IBM FileNet Content Manager.
      Not found cp-console-iam-provider/cp-console-iam-idmgmt routes in the project "ibm-common-services", you need to run ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade first,
      and then rerun ./cp4a-deployment.sh -m upgradeOperator -n <first_project_name>.

      Do not run the ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade script now. You need to run this command later.

  5. In the second CLI window, run the cp4a-deployment.sh script from cert-kubernetes in the upgradeOperator mode.
    ./cp4a-deployment.sh -m upgradeOperator -n <second_project_name>

    Where <second_project_name> is the namespace of the second Cloud Pak for Business Automation instance you want to upgrade.

    1. If the script detects Elasticsearch and Business Automation Insights, the script then asks if you completed the migration from Elasticsearch to OpenSearch. Select No if you did not complete the migration and then go to Installing OpenSearch and migrating Elasticsearch data. Select Yes if you completed migration from Elasticsearch to OpenSearch.
      Remember: Business Automation Insights uses Elasticsearch, and so does Process Federation Server. If you have either of these components in the cluster and you want to upgrade them, then you must migrate from Elasticsearch to OpenSearch.
      Note: If your Cloud Pak for Business Automation includes IBM Business Automation Workflow without Business Automation Insights, you do not need to migrate Elasticsearch to OpenSearch because Process Federation Server is removed in the upgrade. If you want to continue to use Process Federation Server after the upgrade, then you do need to migrate your Elasticsearch data.
    2. If the script detects Elasticsearch and no Business Automation Insights component, then the script asks if you are planning to use Process Federation Server after the upgrade and if you want to do the migration of Elasticsearch to OpenSearch? (Yes/No).
      • If you select Yes, the script asks if you completed the migration from Elasticsearch to OpenSearch. If you did not complete the migration select No, and then go to Installing OpenSearch and migrating Elasticsearch data. If you completed the migration from Elasticsearch to OpenSearch, select Yes.
      • If you select No, continue to upgrade the CP4BA operators without migrating Elasticsearch.
    3. After you run the ./cp4a-deployment.sh -m upgradeOperator -n <second_project_name> command, the script detects that you installed the Cloud Pak foundational services in All Namespaces.

      The script then checks whether your Cloud Pak for Business Automation deployment includes components from IBM FileNet Content Manager.

      The script shows the following message if it detects components from IBM FileNet Content Manager.
      Not found cp-console-iam-provider/cp-console-iam-idmgmt routes in the project "ibm-common-services", you need to run ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade first,
      and then rerun ./cp4a-deployment.sh -m upgradeOperator -n <second_project_name>.

      Do not run the ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade script now. You need to run this command later.

  6. In the first CLI window, run the following command if the script asks to run the pre-upgrade script in step 4.
    ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade
  7. In the second CLI window, run the following command if the script asks to run the pre-upgrade script in step 5.
    ./cp4a-pre-upgrade-and-post-upgrade-optional.sh pre-upgrade
  8. In the first CLI window, run the following command if you ran the pre-upgrade script in step 6.
    ./cp4a-deployment.sh -m upgradeOperator -n <first_project_name>
    Where <first_project_name> is the namespace of the first Cloud Pak for Business Automation instance you want to upgrade.
    Note: The script output displays the following command that you need to run as the next action. Do not run the command now. You need to run this command later.
    ./cp4a-deployment.sh -m upgradeDeployment -n <first_project_name>
  9. In the second CLI window, do the following if you ran the pre-upgrade script in step 7.
    1. Run the following command.
      ./cp4a-deployment.sh -m upgradeOperator -n <second_project_name> --cpfs-upgrade-mode <mode> --original-cp4ba-csv-ver <CP4BA_version>
      Where
      • <second_project_name> is the namespace of the second Cloud Pak for Business Automation instance you want to upgrade.
      • <mode> must be shared2shared. shared2shared is the only supported path of upgrade when you upgrade from an All Namespaces deployment.
      • <CP4BA_version> is the original version of the Cloud Pak for Business Automation CSV.
        • When you upgrade from 21.0.3-IF031, <CP4BA_version> is 21.1.31.
        • When you upgrade from 22.0.2-IF006, <CP4BA_version> is 22.2.6.
      The following command is an example when you want to upgrade from 22.0.2-IF006.
      ./cp4a-deployment.sh -m upgradeOperator -n <second_project_name> --cpfs-upgrade-mode shared2shared --original-cp4ba-csv-ver 22.2.6
    2. Run the following command to verify the original version of the Cloud Pak for Business Automation CSV.
      oc get csv -n <second_project_name> |grep ibm-cp4a-operator | awk {'print $1'} | xargs oc get csv -ojsonpath='{.spec.replaces}
      Where <second_project_name> is the namespace of the second Cloud Pak for Business Automation instance you want to upgrade.
    Note: The script output displays the following command that you need to run as the next action. Do not run the command now. You need to run this command later.
    ./cp4a-deployment.sh -m upgradeDeployment -n <second_project_name>

What to do next

Go to and complete the steps in Upgrading your CP4BA deployment version for each of your Cloud Pak for Business Automation instances. Perform the steps on each of the CLI windows.