Managing versions and upgrades using the Platform UI

The versions and upgrade interface in the Platform UI simplifies the upgrade of operators and instances of capabilities by ensuring that they are within the optimal ranges for the installed Platform UI version. It is designed to inform and support users in understanding the versions that are installed, and upgrade them if needed.

You must be an administrator to perform upgrades with the upgrade interface.

Getting an overview of the environment

This page allows you to get information about the versions of the underlying platform.

  1. Log in to the Platform UI.

  2. In the navigation menu, under Administration, click Integration versions and upgrades.

    The Environments tab provides a brief overview of three key components of the Cloud Pak for Integration installation:

    • The version of Platform UI (both the operator and the instance).

    • The version of Cloud Pak foundational services that is installed and what range of versions is optimal for this installation of the product.

    • The version of OpenShift that is installed and what range of versions is optimal for this installation of the product.

If any of the installed components are out of range, upgrading them to be within the ranges that are provided ensures optimal compatibility.

Generating an upgrade plan

This allows you to generate a plan for upgrading Cloud Pak for Integration to a target version.

  1. Log in to the Platform UI.

  2. In the navigation menu, under Administration, click Integration versions and upgrades.

  3. Click the Upgrade planning tab.

  4. Select the appropriate target version for Cloud Pak for Integration.

  5. Click the Refresh button.

    This runs a check of the existing Cloud Pak for Integration installation and compares the current installed versions of components with those that are part of the target version. Once the check has completed, you will see a sequence of steps that are required in order to upgrade the Cloud Pak for Integration installation.

    Steps that are already complete are marked with green tick icon. Additional information can be viewed by clicking on the step header to view the step content.

    Steps that are not yet complete are marked with a grey tick icon and the additional information for that step is visible. The additional information may include links to the relevant pages in OpenShift web console or the instance upgrade UI. For example:

    • clicking the OpenShift URL link to upgrade an operator will open the Subscription page for the selected operator in the OpenShift web console

    • clicking the Change version link to upgrade an instance will open a pane that allows you to select the wanted version

Tip: The upgrade plan does not update itself automatically when changes are made. Once you have completed one or more of the upgrade steps, or tasks within a step, click the Refresh button again to update the upgrade plan.

Managing operator versions

This allows you to view the versions of all the operators that are installed and ensure they are at the optimal versions, particularly when doing an upgrade.

  1. Log in to the Platform UI.

  2. In the navigation menu, under Administration, click Integration versions and upgrades.

  3. Click the Capabilities tab.

    You get a list of all the Cloud Pak for Integration operators that are currently installed.

  4. If an operator has an Upgrade tag on the operator tile, upgrading it ensures optimal performance. Click the tile for an operator (for example, IBM API Connect).

    • A notification at the beginning of the page describes the ideal range for that operator, given the installed version of Cloud Pak for Integration. If applicable, you also get a table listing the instances managed by that operator.

    • if the operator has a dependency which needs upgrading, you will get a second notification. For example, API Connect requires the administrator to upgrade the Datapower operator. An Upgrade button within this notification opens a new window that takes you directly to the Subscription page for the dependency's operator.

    • If the operator version is too high or the operator is not installed, you will get a warning notification that explaining the issue and providing possible actions to be take.

  5. Click the Upgrade button on the tile to open the Subscription page for the selected operator in the OpenShift web console. Follow the instructions in Upgrading operators by using the OpenShift web console to upgrade the operator, to the wanted version (based on the information from the first notification in the previous step).

  6. When the operator upgrade is complete, go back to the Platform UI and click the Capabilities tab again. Click the refresh icon on the table of instances. This updates the state of the operator.

Now that the operator is upgraded, upgrade the instances that the operator manages by completing the steps in the next section.

Upgrading instances on the Integration versions and upgrades page

Prerequisite: You cannot upgrade an instance through this interface until its corresponding operator is installed successfully and within the recommended range.

  1. Log in to the Platform UI.

  2. In the navigation menu, under Administration, click Integration versions and upgrades.

  3. Click the Capabilities tab.

  4. Click the wanted operator to get a table of instances that are available for upgrade.

    • Each listed instance has a notification that describes the required actions needed for upgrade.

    • In Optimal range column, if an instance is within the range specified, there is a green check mark. If not, you get information about the range the instance needs to be within to be aligned with the installed version of the Platform UI.

  5. To upgrade an instance, click the overflow menu (three vertical dots) for that instance and click Change version. This opens a pane that allow you to select the wanted version (aligned with the notification from the previous step) from the dropdown menu. If a new license is required (rather than the existing license), you will get the license name with an Accept toggle so you can accept the new license.

  6. Click Change version to patch the instance with the new version (and the new license, if required). Once successful, the page automatically reloads and reflects the selected changes.

  7. Repeat the process for each instance in the table. If you have more than 10 instances, you can set pagination to increase the number of instances shown. Click the arrow buttons to cycle between pages, or use the search page to find a specific instance.

Upgrading instances on the Integration instances page

Alternatively, you can use the Integrations instances page to upgrade instances independently of what version of the operator you want to use. For example, when you only want to apply a fixpack to an instance from an older release of Cloud Pak for Integration.

  1. Log in to the Platform UI.

  2. In the navigation menu, under Administration, click Integration instances Find the instance to upgrade, and open the overflow menu by clicking the three-dot icon at the end of the row.

  3. Click Change version.

  4. If you are asked to select a new license when upgrading to a new version, select the license and click Accept.

  5. Select the upgrade version and click Change version.