Deploying the BMC Helix Intelligent Integrations Gateway

Deploy the BMC Helix Intelligent Integrations Gateway in your on-premises environment to collect data from your on-premise tools and environments, and send the data to BMC Helix applications.


System requirements

Before you deploy BMC Helix Intelligent Integrations Gateway, ensure that your environment meets the hardware and software requirements.

Supported operating systems

BMC Helix Intelligent Integrations Gateway is supported on the following operating systems:

  • CentOS 7.x
  • Red Hat Enterprise Linux 8.x

Repository requirements

Make sure that your system meets the following requirements to access images from a local repository:

RequirementDescription
Hardware

Minimum 8 CPU with 32 GB memory and 120 GB disk space

Softwaredocker-ce-cli version 20
containerd.io version 1.6
docker version 20
docker-compose version 1.29
Port

The system must be reachable to the third-party connector port and it should be able to post data to BMC Helix Intelligent Integrations (SaaS deployment) on port 443.

Before you begin

  1. Obtain the container images and utility from BMC Customer Support.
  2. Ensure that you can access SaaS deployment of BMC Helix Intelligent Integrations.

To deploy the BMC Helix Intelligent Integrations Gateway

  1. Log on to SaaS deployment of BMC Helix Intelligent Integrations and click the Download Installer link. 
    The installation script (Intelligent_Integrations_Installation_script.sh) is downloaded.
  2. Copy both the container images, utility, and installation script to the same directory on the computer where you want to deploy BMC Helix Intelligent Integrations Gateway.
  3. Provide execute permissions on the Intelligent_Integrations_Installation_script.sh script:
    chmod +x Intelligent_Integrations_Installation_script.sh
  4. Run the installation script:
    ./Intelligent_Integrations_Installation_script.sh 
    If the script is executed successfully, an output similar to the following is displayed:

    ------------ BMC Helix Intelligent Integrations Installation Script -------------
    =================================================================================
    Checking for prerequisites...
    [Importing Docker images...] /
    
    Docker image 'docker-images-bmc-22.4.00-RC2SHA1c56f3dcBUILD14.tgz' successfully imported.
    Extracting the Docker utility file swp-bmc-22.4.00-RC2SHA1c3878dcBUILD14.zip
    Starting Docker containers...
    Creating swp-fluentd   ... done
    Creating swp-zookeeper ... done
    Creating swp-ui        ... done
    Creating swp-arangodb  ... done
    Creating swp-broker    ... done
    Creating swp-mediator  ... done
    Creating swp-backup    ... done
    Creating swp-nginx     ... done
    Waiting for Docker containers to start.
    BMC Helix Intelligent Integrations is up and running.
    Use URL http://<hostName>/swpui to access BMC Helix Intelligent Integrations.

    The output includes the container names and the URL that you can use to access BMC Helix Intelligent Integrations.

To enable HTTPS

Use the following instructions to configure BMC Helix Intelligent Integrations to allow the UI and REST to use both use HTTPS for configuration.

  1. Open the docker-compose.yaml file with a text editor.
  2. Uncomment the following lines: 

      nginx-proxy:
        image: nginxproxy/nginx-proxy
        ports:
          - "80:80"
          # - "443:443"
     
    … 
        volumes:
          - /var/run/docker.sock:/tmp/docker.sock:ro
          # - ./conf/certs:/etc/nginx/certs:ro
  3. Update the VIRTUAL_HOST parameter with the host name that corresponds to the certificate, as shown in the following example:

    VIRTUAL_HOST: localhost #,host.youcompany.com

     

  4. Create a directory in the conf/certs directory and copy the *.crt and *.key certificates to this directory. 

Where to go from here

Start configuring integrations with third-party sources. For more information, see Integrating by using BMC Helix Intelligent Integrations.

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. John O'Toole

    I think it might be common for a user to need to provide HTTP Proxy details for their On Prem II Gateway to connect to their SaaS BHOM Destination.

    I don't see this documented anywhere.

    The way to do it is:

    1) Edit the Destination

    2) Enable the Edit JSON bar

    3) The JSON is displayed which includes some fields for populating proxy information:

    { "proxyUsername": "", "accessSecretKey": "*****", "allowUnsignedCertificate": false, "pipeLiningLimit": 1, "timeout": { "unit": "MINUTES", "value": 15 }, "proxyPort": 8888, "maxResponseSize": 1000000, "usesHttps": false, "minConnections": 0, "connectingTimeout": { "unit": "SECONDS", "value": 30 }, "host": "helixtrialsjc604-or1-demo.onbmc.com", "poolTimeout": { "unit": "MINUTES", "value": 30 }, "maxConnections": 5, "maxRedirects": 5, "usesProxy": false, "proxyPassword": "*****", "maxLogEntrySizeKb": 4000, "logResponses": false, "proxyHost": "", "logRequests": false, "accessKey": "*****", "port": 8000, "tenantId": "1539623124", "maxOpenRequests": 1024, "editHost": false }

    4) Save the changes

    If you need screenshots, please reach out to me as I captured them for a recent case on this topic

    Dec 19, 2022 11:13
    1. Praveen Sudarsana

      John,

      If a customer process steps as is - OutCome of it SWP UI accesible with Default Destination created.

      Not all Customers will have same case - possible scenario

      • With Proxy with Outgoing traffic to BHOM -Without Proxy to Outgoing traffic to BHOM

      approach is to handle with Download Script - Which would configure the Destination with Proxy details. And OnPrem Source collector on same customer network wouldnt be needing to connect internally so no proxy is needed for Source connection.

      Let me know if the above explanation helps were we would like to address the proxy in Download Script and Destination created will have Proxy info configured already :)

      Jan 19, 2023 03:29
  2. John O'Toole

    If a customer does not need a HTTP Proxy to connect to BHOM - we are good. Nothing to do.

    If a customer has installed the On Prem Gateway already and realizes they do need a HTTP Proxy to connect to BHOM - we just need to provide the steps to do so (which, I believe, involves editing the the json above)

    Feb 07, 2023 09:49