Upgrading the on-premises gateway in on-premises Kubernetes or OpenShift clusters

This topic describes how to upgrade the BMC Helix Intelligent Integrations on-premises gateway in on-premises Kubernetes or OpenShift clusters.

To prepare for the upgrade

1. Review the system requirements and obtain the container images and utility files for the on-premises gateway version to which you want to upgrade.
2. Back up the hii directory:
   1. Log on to the controller or bastion host, and as a cluster-admin user,​​ ​connect to the Kubernetes or OpenShift cluster in which the on-premises gateway is deployed.
   2. Create a directory, backup_<current_iigw_version>_<namespace>, and back up the /<IIGateway_INSTALL_DIR>/hii directory into it.
3. Navigate to the <userHome> directory and check whether the iig_auth directory exists. If not, restore it from the <userHome> directory in the previous deployment.

4. Back up the PersistentVolumeClaim (PVC) data.

   Success

   Best practice

   We recommend using your preferred method to back up PVC data based on the PVC type.

5. (For BMC Helix IT Operations Management (ITOM) on-premises users only) Review the following capabilities supported by BMC Helix ITOM version 25.4 and later, and decide whether you want to upgrade BMC Helix ITOM:

   • II Admin role to allow users to manage the BMC Helix Intelligent Integrations connectors and configurations, improving security and operational flexibility. In earlier versions, only the tenant administrators could perform these tasks. 
   • A proxy service for communication between BMC Helix Intelligent Integrations and the BMC Helix ITOM object storage in high-availability deployments for improved reliability.

   Warning

   Important

   When you deploy the BMC Helix Intelligent Integrations services during the BMC Helix ITOM on-premises deployment, services only for the listed capabilities are deployed. For information on deploying BMC Helix ITOM, see Deploy BMC Helix IT Operations Management.

   To access the full functionality of BMC Helix Intelligent Integrations, you must also upgrade BMC Helix Intelligent Integrations in a standalone environment (referred to as the on-premises gateway), as described in this topic. ​​​​​​

6. Review the deployment_config.json file in the iig_auth directory and update it if needed. 

   Warning

   Important

   You can use another object storage type after the upgrade. Depending on whether you are a Helix subscriber or BMC Helix ITOM on-premises user, you need to update various parameters in the deployment_config.json file to use a different object storage. For information about parameter values, see Deploying the on-premises gateway in an on-premises Kubernetes or OpenShift cluster.

Task 1: To upgrade the on-premises gateway in on-premises Kubernetes or OpenShift clusters

1. Log on to the controller or bastion host, and as a cluster-admin user, connect to the Kubernetes or OpenShift cluster on which you want to upgrade the on-premises gateway.
2. Copy the hii-bmc-<buildNumber>.zip files that you have downloaded to the /<IIGateway_INSTALL_DIR> directory. 
3. Extract the utility files that you have downloaded to the /<IIGateway_INSTALL_DIR>/ directory:
   unzip hii-bmc-<buildNumber>.zip
4. Deploy the on-premises gateway for which authentication is enabled:

   1. Run the gateway_deployment.sh script.
      ./gateway_deployment.sh

   2. Depending on your environment, enter kubernetes or openshift when prompted for the deployment method.
      The deployment_config.json file is displayed with the values that you have provided in a previous step.
5. (Optional, applicable only for deployments in the Kubernetes cluster) Perform the following steps if you want to monitor the on-premises gateway node and container health by using dashboards:
   1. Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
   2. Run the gateway_monitoring_services_deployment.sh script:
      ./gateway_monitoring_services_deployment.sh
   3. Enter kubernetes when prompted for the deployment method.

6. Access the on-premises gateway UI by using the following URL:
   https://<swpuingress>/swpui
   For example, https://swpui-iionpremk8s-dev1.dsm-01.abc.com/swpui.

   Warning

   Important

   After the upgrade is complete, you can access the BMC Helix Intelligent Integrations UI by using the URL specified in this step. BMC Helix Portal does not display any tile for the on-premises gateway. 

Task 2: To edit the connector in BMC Helix Intelligent Integrations

If there are any updates to the connector configuration during the upgrade, the existing connector instances are not automatically updated after the upgrade. You need to either create a new connector instance or stop the existing data stream and create a new data stream.

For the list of updates in various connectors in version 26.1.01, see  26.1 enhancements and patches. For information about editing existing connectors and starting or stopping data streams, see Editing and deleting connectors and Managing data streams.

Where to go from here

After you upgrade the on-premises gateway, perform the following tasks:

• If you want to ensure high availability of the on-premises gateway instances in case of any failure, see Configuring the on-premises gateway for high availability in on-premises Kubernetes and OpenShift clusters.
• Configure connections with the required third-party products to collect events, metrics, and topology data.

Related topics

Upgrading the BMC Helix Intelligent Integrations on-premises gateway

Deploying the on-premises gateway in an on-premises Kubernetes or OpenShift cluster