Upgrading the CP4BA operators from 24.0.0

Upgrade the Cloud Pak for Business Automation operators based on your deployment setup. You can upgrade the Cloud Pak for Business Automation operators in both online and airgap environments.

Before you begin

It is important to complete the following steps before you upgrade the operators.

  1. 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.1 release to find all the available interim fixes.

    To download the cert-kubernetes repository.

    1. Open the Cloud Pak for Business Automation download document, click Cert Kubernetes, and then select and copy the displayed command.
      Note: It is recommended to upgrade to the latest 24.0.1 interim fix. If you want to deploy 24.0.1 GA or 24.0.1-IF001, make sure that you clone the latest version of the respective branches from the cert-kubernetes repository to get all the latest fixes.
    2. Run the copied git clone command to download the files.
  2. Complete the pre-upgrade tasks for the FileNet® Content Manager capability.
    1. Stop the IBM Content Search Services index dispatcher.

      If your Cloud Pak for Business Automation includes IBM Content Search Services, you must disable CBRdispatcher for IBM FileNet Content Manager and IBM Business Automation Workflow.

      1. Log in to the Administration Console for Content Platform Engine.
      2. In the navigation pane, select the domain icon.
      3. In the edit pane, click the Text Search Subsystem tab and clear the Enable indexing checkbox.
      4. Click Save to save your changes.

        For more information, see Stopping the IBM Content Search Services index dispatcher.

    2. Follow the steps in Best Practice: Upgrading to Content Platform Engine V5.5.9 or higher.

About this task

Use the script -h parameter for more information about the script in the cert-kubernetes/scripts folder.

./cp4a-deployment.sh -h
Note: If you plan to use a nonadministrator user to upgrade the operator, you must add the user to the ibm-cp4a-operator role.
oc adm policy add-role-to-user ibm-cp4a-operator <user_name>

Procedure

  1. Log in to the target cluster from a client.
    oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR>
  2. Set the following environment variable.
    export projectName=<cp4ba-project>

    Where <cp4ba-project> is the target namespace.

  3. Change the directory to the scripts folder under cert-kubernetes/scripts.
  4. Run the cp4a-deployment.sh script from cert-kubernetes in the upgradeOperator mode.
    ./cp4a-deployment.sh -m upgradeOperator -n $projectName
    Note: When you run the script, messages are sent to the command terminal and prefixed with the following labels.
    • [INFO] - The INFO label summarizes the actions that the script completed.
    • [ATTENTION] - The ATTENTION label highlights important information and possible after effects of the actions that are taken during the upgrade.
    • [NEXT ACTION] - The NEXT ACTION label reminds you about the subsequent steps that you need to do to complete the upgrade.

    If your instance is using a global catalog namespace (and it is not an All Namespaces deployment), then the script asks whether to switch from global catalog namespace to private catalog namespace. It is recommended to switch to a private catalog namespace.

    A private catalog namespace uses the same target namespace as the Cloud Pak for Business Automation instance, which means a private catalog namespace can be updated without impacting other Cloud Pak for Business Automation instances on the same cluster. A global catalog namespace uses the openshift-marketplace namespace and shares the Cloud Pak for Business Automation instances on the same cluster.

    When you answer Yes to the script prompt Do you want to switch CP4BA deployment using private catalog?, then the upgrade script automatically includes the --enable-private-catalog parameter to switch your global catalog namespace to a private catalog namespace.

    Note: If you have All Namespaces deployment, you cannot switch to a private catalog.
  5. Optional: Run the following script to check the status of the Cloud Pak for Business Automation operators. Use the cp4a-deployment.sh script in upgradeOperatorStatus mode to check the status of the operators and dependencies.
    ./cp4a-deployment.sh -m upgradeOperatorStatus -n $projectName

    The script output shows that each of the operators is in the phase of Succeeded and then shows CP4BA operators upgraded successfully.

    The script also shows the next actions that you need to do.
    Next Action
    Run the script in upgradeDeployment mode to upgrade the CP4BA deployment.
    ./cp4a-deployment.sh -m upgradeDeployment -n <project_name>

    Go to the What to do next to find the next steps.

Results

If you observe unexpected behaviors or results, the troubleshooting section can help you to resolve some of the common issues. For more information, see Troubleshooting.

What to do next

Go to and complete the steps in Upgrading your IBM Cloud Pak deployment from 24.0.0.