This documentation supports BMC Helix AIOps till November 2021. To view other versions of the documentation, select a version from the Product version menu.

Upgrading third-party integrations

Upgrade an existing third-party integration to the latest version. While upgrading the integration, you must first upgrade the BMC Helix Intelligent Integrations Connector to the latest version, if available, and then continue with the upgrade in the same workflow.

Related topics

2022-02-11_06-15-01_Downloading and installing connectors for third-party integrations

Rolling-back-a-third-party-integration-to-the-previous-version

Before you begin

Perform the following steps:

  • Ensure that the existing configured Connector is running on one of the following operating systems:
    • RHEL 8.x, 7.x
    • CentOS 8.x, 7.x
    • Ubuntu 20.x, 18.x

  • Ensure that you have installed Docker version 18.01 or later. For information about the latest version, see the Docker.
    You can also install the Docker image while you are upgrading the Connector.

  • From the BMC Helix Discovery navigate to the Explore > Data > Miscellaneous > Import Records > Import Record List view, check whether the Complete column shows Yes or No  for the imported records for the desired integrations. For more information, see BMC Helix Discovery documentation.

    • If it shows No, wait for a few more minutes till the pipeline imports all the CIs from the third party integrations completely.
    • If it shows Yes, check whether the End Time column shows a recent import cycle time of the import or not. By default, the CI import cycle is set to refresh once every 24 hours.
    • If it shows Yes and if the import cycle time is scheduled to happen in a short time, wait for next import cycle to be completed.

  • Take a backup of the /opt/bmc/connectors/<connector-name>/data directory. 

    Best practice
    Name the backup directory with the integration version details. For example, if you are taking a backup of the integration version 80, name the backup directory Integration_backup_build80.

  • Proceed to upgrade.

To upgrade a third-party integration

  1. Go to Integrations > Configured Integrations, and click Upgrade on an integration tile that you plan to upgrade.
    tsom_connector.png

  2. On the Edit Integration page, under Select Connector, click Upgrade.
    Note: The option to upgrade is enabled only when a later version of the Connector is available. 
    edit_upgrade.png
  3. On the Upgrade Connector page, perform the following steps:
    1. If a Docker image does not previously exist in your system, or if you want a new Docker image, click Download.
      download_docker_image.png

    2. Click Download Upgrade Script to download the Connector shell script.
    3. Click Close to return to the Edit Integration page.

  4. Copy the downloaded script and the Docker image on the host computer on which the existing Connector is configured, and run the script.

    Important: Script security and location

    • Do not copy the script to any public domain.
    • Copy the downloaded script in the same location as that of the Docker image.

    (Optional) To verify the upgrade status, you can check the container logs in the /opt/bm/connectors/<connector_name>/logs/fluent.log file. 

  5. On the Edit Integration page, under Select Connector, click reload reload.png to reflect the upgraded Connector changes.
  6. Click Update.
  7. Click OK to confirm.

To verify the upgrade

Go to Integrations > Configured Integrations, check the build number on the third-party integration tile, and ensure that the integration is upgraded to the latest version, and the Upgrade link is no longer displayed on the integration tile.