Configuring the on-premises gateway for high availability


Provide high availability for the BMC Helix Intelligent Integrations on-premises gateway by deploying it in an active-passive high availability configuration. 

Before you begin

Make sure that you have obtained the credentials to access the MinIO API endpoint that is setup on the standalone MinIO instance. 

 

To configure the on-premises gateway instances for high availability

  1. Log on to an on-premises gateway instance that you want to consider as a primary instance.
  2. Navigate to the /Gateway_INSTALL_DIR/hii directory.
  3. Open the docker-compose.yaml file or podman-compose.yaml file with an editor. 
  4. Locate the mediator > environment section, and set the following properties:
    • MINIO_ACCESS_KEY: MinIO access key
    • MINIO_SECRET_KEY: MinIO secret key
    • MINIO_SERVER_URL: MinIO server URL in the <http://<hostName>:<APIport> format. The default port is 9000. 
    • DATA_PUSH_INTERVAL: Interval in milliseconds in epoch format at which an on-premises gateway instance should push data to a MinIO bucket in a JSON file (default and minimum 300000 milliseconds). 
      The following file shows sample values:

      MINIO_ACCESS_KEY: P3pWEoNUEmZB8i0zJAnC
      MINIO_SECRET_KEY: SgA3ntRrdM3nzUGpvKjRMQ2FJZNHujfngxJgTb
      MINIO_SERVER_URL: http://vx-push-dev26.abc.com:9000
      DATA_PUSH_INTERVAL: 300000 
  5. Restart the container service by using the following command:
    • docker-compose

      docker-compose down
      docker-compose up -d
    • podman-compose

      podman-compose down
      podman-compose -f podman-compose.yaml up -d

      When you restart the service, the instance is added as a primary instance and a MinIO bucket, helix-ii-backup is created. The bucket contains the configuration backup file, Leader_backup.json, which stores the instance configuration backup with timestamp. The backup file contains a tag for the on-premises instance.
      Bucket_Tags.png

  6. Log on to the remaining on-premises gateway instances and repeat steps 2 to 5.
    The subsequent instances are added as secondary instances in the MinIO bucket.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*