Upgrading the on-premises gateway by using Docker containers

This topic describes how to upgrade the BMC Helix Intelligent Integrations on-premises gateway by using Docker containers. 

Upgrading the BMC Helix Intelligent Integrations on-premises gateway involves the following tasks: 

• Upgrade the container images
• (Optional) Upgrade the database
• (Optional) Update the collector URL in the third-party product

Before you begin

• Review the system requirements and download the container images and utility files.
• Back up the connector configurations, see Backing-up-and-restoring-connector-configurations.

To upgrade the on-premises gateway by using Docker containers

1. Go to the server where you want to upgrade the on-premises gateway.
2. Copy the following files that you have downloaded to the /opt/bmc directory: 
   • Container images: bmc-hii-docker-images-<buildNumber>.tgz
   • Utility file: hii-bmc-<buildNumber>.zip

3. Stop the docker-compose service.
   

   docker-compose down

4. Delete and purge the existing container images from the local repository. 
   

   docker image prune -a
5. When prompted to purge all containers, enter Y.

6. Load the container images that you have downloaded.
   

   docker load --input /opt/bmc/bmc-hii-docker-images-<version>-<buildNo>.tgz
7. Unzip hii-bmc-<buildNumber>.zip and overwrite the existing files in the /opt/bmc/hii directory.
   
8. Perform the following steps if you want to upgrade the database:

   1. Open the /opt/bmc/hii/docker-compose.yaml file with a text editor and search for the following line:

      #      - --database.auto-upgrade

   2. Uncomment the line as follows:

      - --database.auto-upgrade

   3. Start the docker-compose service.
      

      docker-compose up -d

   4. Open the /opt/bmc/hii/docker-compose.yaml file with a text editor and search for the following line:

      - --database.auto-upgrade

   5. Comment the line as follows:

      #      - --database.auto-upgrade

   6. Stop the docker-compose service.
      

      docker-compose down

9. Start the docker-compose service.
   

   docker-compose up -d

10. Verify that all the services are running depicting all containers are up without a restart.

    docker ps
11. Access the BMC Helix Intelligent Integrations UI by using the following URL:
    • (HTTP) http://<hostName>:7457/swpui
    • (HTTPS) https://<hostName>:7443/swpui

To update the collector URL in the third-party product

Update the collector URL in the third-party product if the following conditions are satisfied:

• You have upgraded to version 23.3.02 or later
• You are collecting data from a third-party product via the webhook mechanism
• You are using a port other than 7457 (HTTP) or 7443 (HTTPS) to access the BMC Helix Intelligent Integrations UI

Do the following tasks to update the collector URL:

1. Access the BMC Helix Intelligent Integrations UI by using the following URL:
   http://<hostName>:7457/swpui or https://<hostName>:7443/swpui
2. On the SOURCES panel, click Configure Mediator for the source connection that you created and then expand the <thirdPartyProduct Datatype> panel.
3. On the COLLECTOR CONFIGURATION tab, click copy to copy the existing, auto-generated collector URL and save the URL in a temporary file.
   For example, http://hostA:7457/hii/api/mediator/v3/push/9mn-6c97-4c2e-8pc5-12c0asdf
4. Configure the third-party product again to forward data to BMC Helix Intelligent Integrations.

For the sample instructions to update the collector URL in the third-party product, see To configure a connection with Entuity for collecting incidents data.