Upgrading your instances

To upgrade your instances, complete the following steps:

1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
2. If necessary, switch to the namespace (or project) that contains the instances:

   oc project namespace

3. Use your preferred method to update the spec.version and spec.license.licence values for each instance that you want to upgrade. The oc patch command is used in these steps to apply a patch with some bash shell features, but you can also use oc edit, or oc apply with the appropriate YAML.
   1. Use your preferred text editor to create a YAML file that contains the updated values. To help you choose the correct values, see spec.version values and Licensing reference for IBM App Connect Operator.

      For example, if you wanted to upgrade from a channel (such as 12.0.11-lts) or a fully qualified version (such as 12.0.M.0-rX-lts) to the latest version, you can update spec.version to use the 12.0-lts channel. And to switch the earlier license, which is incompatible with the latest release, you can update spec.license.licence to L-QECF-MBXVLU.

      spec:
        version: 12.0-lts
        license:
          license: L-QECF-MBXVLU
      

   2. Save this file with a .yaml extension; for example, newversion.yaml.
   3. Run the following command to update the values for an instance, where:
      • kind represents the value of the kind parameter for the instance, which can be Dashboard, DesignerAuthoring, SwitchServer, or IntegrationServer. (These values are not case sensitive.)
      • instanceName is the name of the instance, which is shown as the metadata.name value.

      (Use the name of the .yaml file that you created.)

      oc patch kind instanceName --type='merge' --patch "$(cat filename.yaml)"

      For example:

      oc patch dashboard db-prod --type='merge' --patch "$(cat newversion.yaml)"

      Tip:

      • Other possible oc patch commands for updating the spec.version or spec.license.licence value are as follows. (These commands might show an Invalid JSON Patch message on certain operating systems.)

        oc patch kind instanceName -p '{"spec":{"version":"12.0-lts"}}' --type=merge

        oc patch kind instanceName -p '{"spec":{"license":{"license":"licenseValue"}}}' --type=merge

        oc patch kind instanceName -p '{"spec":{"version":"12.0-lts", "license":{"license":"licenseValue"}}}' --type=merge

      • The oc edit command will automatically open the default text editor for your operating system (for example, Notepad on Windows) or another configured editor. Update and save the YAML definition, and then close the text editor to apply the command.

        oc edit kind instanceName -n namespace

To upgrade your instances, complete the following steps:

1. Applicable to IBM Cloud Pak for Integration only:
   1. If not already logged in, log in to the IBM Cloud Pak Platform UI for your cluster.
   2. From the Platform UI home page, click Install operators or OpenShift Container Platform, and log in if prompted.
2. Applicable to an IBM App Connect Operator deployment only: From a browser window, log in to the OpenShift web console for your cluster.
3. Ensure that you are in the Administrator perspective .
4. From the navigation, click Operators > Installed Operators to display all the installed Operators in the current namespace.
5. If necessary, select a specific namespace (project) where your IBM App Connect Operator is installed.
6. Locate and click IBM App Connect in the table to open the Operator details view.
7. Click the All instances tab.
8. Complete the following steps to update the spec.version and spec.license.licence values for each instance that you want to upgrade.
   1. Click the name of the instance.
   2. Go to the YAML tab.
   3. Update the spec.version value to an LTS channel or fully qualified version, and update the spec.license.licence value to an appropriate LTS licence. To help you choose the correct values, see spec.version values and Licensing reference for IBM App Connect Operator.
   4. Click Save.

To upgrade your App Connect Dashboard and App Connect Designer instances, complete the following steps:

1. From a browser window, log in to the IBM Cloud Pak Platform UI.
   Tip: You can use the generated URL for a deployed IBM Cloud Pak for Integration Platform UI instance to access the IBM Cloud Pak Platform UI.
2. From the Platform UI home page, open the navigation menu , and then click Administration > Integration instances.
   Any existing instances of App Connect Dashboard (Integration dashboard) and App Connect Designer (Integration design) are displayed on the Integration instances page. In the instances table, the entries in the Version column are either annotated with the text New version available or with an information icon (i) if new versions are available. The Status should also be shown as Ready, or as Warning if the current version is deprecated (or its storage is ephemeral).

3. Complete either of the following steps:
   • Upgrade by using the Change version option:
     1. Click the options icon for an instance that you want to upgrade, and then click Change version from the menu. The "Change version" panel for the Designer or Dashboard instance opens.
     2. From the Available versions drop-down list, select an LTS channel or fully qualified custom resource (or operand) version. Also review and accept the licence that is presented in the License drop-down list. To help you choose the correct values, see spec.version values and Licensing reference for IBM App Connect Operator.
        Tip: The display names in the License drop-down list within the Change version panel map directly to the spec.license.license values. In the Licensing reference for IBM App Connect Operator topic, the display names are shown in the Description and (Display name) column in the table.
     3. Click Change version to save your changes and start the upgrade.
   • Upgrade by using the Edit option. (You might choose this option if you wanted to also modify other settings; for example, if you wanted to enable Mapping Assist in your App Connect Designer instance.)
     1. Click the options icon for an instance that you want to upgrade, and then click Edit from the menu. The Edit page for the Designer or Dashboard instance opens.
     2. From the UI form or YAML view, update the Channel or version field or spec.version value to an LTS channel or fully qualified custom resource (or operand) version. Also update the License LI field or spec.license.licence value to an appropriate LTS licence. To help you choose the correct values, see spec.version values and Licensing reference for IBM App Connect Operator.
     3. Optional. Update any other settings as required.
     4. Click Update to save your changes and start the upgrade.
   You are redirected to the Integration instances page. In the instances table, the entry in the Version column shows the updated version when the upgrade completes.

Use these commands to check your versions and license values if required before upgrading, or to verify that your intended values have been applied after the upgrade.