Upgrading the IBM App Connect Operator

Use these instructions to upgrade the IBM® App Connect Operator to the latest version. You can do so by using the Red Hat® OpenShift® web console.

Before you begin

About this task

The way in which an upgrade occurs for the IBM App Connect Operator will depend on the Operator version that you are upgrading from and the approval strategy that was set when the Operator was installed.

Note: If you want to upgrade the IBM App Connect Operator in a restricted network, follow the instructions in Installing IBM App Connect in a restricted network to mirror the new images in the public registry to your internal registry. After you update the Operator channel, your cluster should then detect the new images and an upgrade will occur to match your approval strategy.

Procedure

To upgrade from 1.0.x to the latest 1.1.x version of the IBM App Connect Operator, complete the following steps:

  1. Log in to the OpenShift web console for your cluster.
  2. From the navigation, click Operators > Installed Operators to display all the installed Operators in the current namespace.
  3. If necessary, select a specific namespace where your IBM App Connect Operator is installed.
    Starting version number for the Operator
  4. Ensure that the IBM Common Service Operator is upgraded to a version that is supported for an EUS release. To upgrade to the latest supported version (3.19.x), complete the step that matches the approval strategy for the Operator:
    • If the Operator was installed with an Automatic approval strategy, complete the following steps:
      1. Click IBM Common Service Operator in the table to open the Operator Details view.
      2. Click the Subscription tab.
      3. Click the channel version to open the Change Subscription Update Channel window and then select v3 as the channel on which to receive updates.
      4. Click Save and wait while the Operator upgrades to the latest version that is available to the new channel.

        When the upgrade completes, the upgrade status will change from Upgrading to Up to date, and the installed version is updated to show the latest 3.19.x version.

      5. Navigate back to Operators > Installed Operators.
        Tip: You should notice that the IBM Common Service Operator is renamed to IBM Cloud Pak foundational services on the Installed Operators page.
    • If the Operator was installed with a Manual approval strategy, complete the following steps:
      1. Click IBM Common Service Operator in the table to open the Operator Details view.
      2. Click the Subscription tab.
      3. Click the channel version to open the Change Subscription Update Channel window and then select v3 as the channel on which to receive updates.
      4. Click Save. The Upgrade Status value should indicate that an upgrade is available and to the right of this value, you should see a link, which indicates that approval is required; for example, 1 requires approval.
      5. Click the link to open the InstallPlan Details view and then click Preview Install Plan.
      6. Review the plan as instructed and then click Approve to create the resources in the Install Plan.
      7. Navigate back to Operators > Installed Operators.
        Tip: You should notice that the IBM Common Service Operator is renamed to IBM Cloud Pak foundational services on the Installed Operators page.
  5. Locate and click Operator for Apache CouchDB in the table. Then click the Subscription tab and switch the channel if necessary to choose the latest supported version.
  6. From the Installed Operators view, access the IBM App Connect subscription details:
    1. Locate IBM App Connect in the table. The Operator version should display as 1.0.x; for example, 1.0.5.
    2. Click IBM App Connect in the table to open the Operator Details view.
    3. Click the Subscription tab. The channel should be shown as v1.0, and the approval might either be set to Automatic or Manual.
      Sample subscription details for the Operator
      • If Approval is set to Automatic, go to step 7.
      • If Approval is set to Manual, go to step 8.
  7. To complete an App Connect upgrade with Automatic approval, complete the following steps:
    1. Click the channel version to open the Change Subscription Update Channel window and then select v1.1-eus as the channel on which to receive updates.
      Change Subscription Update Channel window
    2. Click Save and wait while the Operator upgrades to the latest version that is available to the new channel.
      When the upgrade completes, the upgrade status will change from Upgrading to Up to date, and the installed version is updated to show the latest 1.1.x version.
      Operator upgrade in progress and complete

      If you return to the Installed Operators view (by using the breadcrumbs), the IBM App Connect entry in the table will display the latest version of the Operator; for example, 1.1.10. The Status column will also display a value of Up to date.

  8. To complete an App Connect upgrade with Manual approval, complete the following steps:
    1. Click the channel version to open the Change Subscription Update Channel window and then select v1.1-eus as the channel on which to receive updates.
    2. Click Save.

      The Upgrade Status value switches to Upgrade available and to the right of this value, a link indicates that approval is required; for example, 1 requires approval.

      Link to initiate a Manual approval
    3. Click the link to open the InstallPlan Details view and then click Preview Install Plan.
      Preview Install Plan button in the InstallPlan Details view
    4. Review the plan as instructed and then click Approve.
      Approve button for an Install Plan

      The resources in the Install Plan are created, and the overall status is shown as Complete.

    5. Navigate back to Operators > Installed Operators. The IBM App Connect entry in the table will display the latest version of the Operator (for example, 1.1.10), and when the upgrade completes, the value in the Status column changes to Succeeded / Up to date.

To upgrade from an earlier to a later 1.1.x version of the IBM App Connect Operator, complete the following steps:

  1. Log in to the OpenShift web console for your cluster.
  2. From the navigation, click Operators > Installed Operators to display all the installed Operators in the current namespace.
  3. If necessary, select a specific namespace where your IBM App Connect Operator is installed.
  4. Ensure that the IBM Common Service Operator is upgraded to the latest supported version (3.19.x) for an EUS release:
    1. Click IBM Common Service Operator in the table to open the Operator Details view.
    2. Click the Subscription tab and ensure that the channel is set to v3.
    3. Navigate back to Operators > Installed Operators.
      Tip: You should notice that the IBM Common Service Operator is renamed to IBM Cloud Pak foundational services on the Installed Operators page.
  5. Choose the upgrade step that matches the approval strategy for the IBM App Connect Operator:
    • If the Operator was installed with an Automatic approval strategy, no additional user intervention is required because OLM will automatically upgrade the Operator to the latest version when it detects a new version in the channel that receives updates. In the Installed Operators view, locate the IBM App Connect entry in the table. You should see the latest version of the Operator (for example, 1.1.10) and the Status column should display a value of Up to date.
    • If the Operator was installed with a Manual approval strategy, approve the Install Plan that is created on your behalf when a new Operator version is detected in the channel:
      1. From the Installed Operators view, click IBM App Connect in the table to open the Operator Details view.
      2. Click the Subscription tab. You should notice that Approval is set to Manual, and Upgrade Status is set to Upgrade available. You should also see a link indicating that approval is required; for example, 1 requires approval.
      3. Click the link to open the InstallPlan Details view and then click Preview Install Plan.
      4. Review the plan as instructed and then click Approve to create the resources in the Install Plan.
      5. Navigate back to Operators > Installed Operators. The IBM App Connect entry in the table should now display the latest version of the Operator.

What to do next

If necessary, take the required action that is needed to upgrade existing instances of App Connect Dashboard, App Connect Designer, switch servers, and integration servers. For more information, see Upgrading your instances.