Upgrading Automation assets

IBM Automation foundation assets (Automation assets) is a capability in IBM Cloud Pak® for Integration that allows users to store, manage, and retrieve assets. To learn more about this capability, see Automation assets deployment by using the Platform UI.

Before version 2021.1, Automation assets was called Asset repository.

Important: For upgrades to 2022.2.1, your data is not automatically migrated. See Manually backing up and restoring your data for a procedure to manually back up and restore your data.

Note that upgrades from versions before 2021.1 require different procedures:

Upgrading the Automation assets involves updating the:

  1. IBM Automation foundation assets operator, using Operator Lifecycle Manager.

  2. operator channel, in the OpenShift console.

  3. instance, either automatically or manually.

Upgrading by using the OpenShift web console

Upgrading the operator

The Operator Lifecycle Manager (OLM) attempts to upgrade an operator when a new version is available to the cluster. If the operator subscription is set to Automatic approval, no action is required. Otherwise, approve the InstallPlan created by OLM to upgrade the operator.

  1. Open the OpenShift web console.

  2. Click Operators > Installed Operators.

  3. Select the Automation assets operator.

  4. To approve the InstallPlan, click the Upgrade available link adjacent to the Automation assets operator.

  5. At the prompt, click Preview Install Plan, then click Approve.

Upgrade available

Upgrading the operator channel

To upgrade the operator channel:

  1. Open the OpenShift web console.

  2. Click Operators > Installed Operators.

  3. Select the Automation assets operator.

  4. In the Subscription Details pane, select the Channel field and change to the new channel. This manual step is required, even when automatic upgrades are configured.

Updating the custom resource

Update the AssetRepository custom resource (installed instance). When Automation assets was installed, the update function may have been configured to either happen automatically, or be done manually. In a situation where an upgraded Automation assets operator might support new versions:

  • If your CR spec.version is set to use a channel, and the operator supports a newer version in that channel, your Automation assets deployment is automatically upgraded.

  • If your CR spec.version is set to use a specific version, upgrade your instance by updating the spec.version in the AssetRepository CR.

Updating the instance using the Platform UI

Log into the Platform UI and in the navigation menu, click Integration instances to find your installed instance. If your instance can be upgraded, you see a blue information icon that indicates there are new versions available.

New Version

To update the version and license of your instance, click the three-dot icon to see available options for editing the CR.

Updating the instance in the OpenShift Console

In the OpenShift web console, click Operators > Installed Operators. Select the IBM Automation foundation assets operator, then click the Asset Repository tab. Your instance should be listed. Click the instance and click the YAML view tab. Update the spec section and update the license and version values.

Upgrading by using the CLI

Upgrading the operator channel

To upgrade the operator channel:

  1. Set the default project (namespace) to the one containing the operator to be upgraded:

    oc project <namespace>
  2. Confirm from which catalog source the operator was installed:

    oc get subscription ibm-integration-asset-repository -o=jsonpath='{.spec.source}'

    This returns the catalog source, for example, ibm-operator-catalog.

  3. Confirm whether the image reference is pinned to a specific version:

    oc get catalogsource <catalog-source> -n openshift-marketplace -o=jsonpath='{.spec.image}'

    If the image ends with:

    • a tag, for example, :latest then the catalog source is not pinned.

    • a specific image reference, for example, @sha256:<some numbers and letters>, it is pinned and it may need to be updated. For more information, see either "Mirroring the 2020.4 patch for catalog sources and images" in Upgrading from 2020.4 or "Mirroring the 2021.4 patch for catalog sources and images" in Upgrading from 2021.4, depending on your upgrade path.

  4. Confirm the current subscription:

    oc get subscription ibm-integration-asset-repository

    If you are upgrading from:

    • 2020.4 (EUS), the channel should be v1.1-eus.

    • 2021.1, the channel should be v1.4.

  5. Confirm that the required IBM Automation assets upgrade channel is available:

    oc get packagemanifest ibm-integration-asset-repository -o=jsonpath='{.status.channels[*].name}'

    The response should confirm that channel v1.5 is available.

  6. Patch the Subscription to move to the desired upgrade channel, for example, v1.5:

    oc patch subscription ibm-integration-asset-repository --patch '{"spec":{"channel":"v1.5"}}' --type=merge

    After a few minutes, the operator should be upgraded. To confirm, rerun this command:

    oc get subscription ibm-integration-asset-repository

    Confirm that the channel version is correct.

Updating the custom resource

  1. Set the default project (namespace) to the one that contains the Automation assets instance to be upgraded:

    oc project <namespace>
  2. Confirm the name of the Automation assets instance:

    oc get assetrepository
  3. Edit the Automation assets custom resource (CR):

    oc edit assetrepository <instance-name>

    This opens the instance's CR in your default editor.

    Make the following changes:

    • For spec.version, enter 2022.2.1.

    • For spec.license.license, enter either L-RJON-CD3JKX or L-RJON-CD3JJU. For more information about specific licenses, see Licensing. Save your changes. This updates the Automation assets CR on the cluster.

Rolling back instance versions

There is no rollback capability available for the 2022.2.1 Automation assets release.

Manually backing up and restoring your data

Before upgrading, you can migrate information assets to your new installation.

  1. Back up your data. Choose which information assets you want to migrate:

    • Remote assets - Click Remotes and note down all remote configurations (Git URLs, asset types, and so on).

    • Local assets - Delete all remotes so that only local assets remain, then click Browse Assets and download each asset in the list.

  2. Install the 2022.2.1 Automation assets.

    Follow the procedure in Automation assets deployment by using the Platform UI.

  3. Restore your data.

    • Remote assets - Click Remotes and recreate all the remotes using the configuration noted down in the first step. See the "Remotes" section in Automation assets deployment by using the Platform UI for more information.

    • Local assets - Click Browse Assets and select your Automation assets instance. Use Add assets to upload all the assets downloaded in the backup stage.