Deploying the on-premises gateway by using Docker containers

Use the Docker container images to deploy the BMC Helix Intelligent Integrations on-premises gateway in your on-premises environment.



Before you begin

Before you deploy the BMC Helix Intelligent Integrations on-premises gateway, review the system requirements and download the container images and utility files.


To deploy the on-premises gateway by using Docker containers

  1. Go to the server where you want to deploy the gateway.
  2. Copy the following files that you have downloaded to the /opt/bmc directory:  
    • Container images: docker-images-bmc-<version>-<buildNo>.tgz
    • Utility file: swp-bmc-<version>-<buildNumber>.zip or swp-bmc-<version>-<buildNumber>.tgz
  3. Disable SELinux:
    1. Open the /etc/selinux/config file with a text editor.
    2. Set SELInux to disabled.

      # This file controls the state of SELinux on the system.
      # SELINUX= can take one of these three values:
      #       enforcing - SELinux security policy is enforced.
      #       permissive - SELinux prints warnings instead of enforcing.
      #       disabled - No SELinux policy is loaded.
      SELINUX=disabled
      # SELINUXTYPE= can take one of these two values:
      #       targeted - Targeted processes are protected,
      #       mls - Multi Level Security protection.
      SELINUXTYPE=targeted
  4. Reboot the server:

    /sbin/reboot now
  5. Disable firewalld:

    systemctl disable firewalld
  6. Set the HOST_NAME variable to the fully-qualified domain name of the server if not set already, as shown in the following example:

    echo "export HOSTNAME=hostA.mycompany.com" >> ~/.bash_profile 
    source ~/.bash_profile
  7. Load the container images:

    docker load --input /opt/bmc/docker-images-bmc-<version>-<buildNo>.tgz
  8. Update the container image registry information to match it to the loaded images:

    sed -i -e 's/containers/phx-epddtr-prd/g' /opt/bmc/hii/docker-compose.yaml


  9. Extract the swp-bmc-<version>-<buildNumber>.zip or swp-bmc-<version>-<buildNumber>.tar to the /opt/bmc directory.

    tar -xvf <path to swp.tgz> -C /opt/bmc


  10. Change permissions on the /opt/bmc/hii/logs directory to 777:

    chmod +x /opt/bmc/hii/logs
  11. Navigate to the /opt/bmc/hii directory and start the docker-compose service:

    docker-compose up -d
  12. Create a file with the following contents and name it ade-default-destination-min.json:

    [
      {
        "entityKind": "Destination",
        "configWithSchema": {
          "config": {
            "connection": {
    		  "proxyUsername": "",
              "proxyPassword": "",
              "accessSecretKey": "CHANGEME",
              "allowUnsignedCertificate": false,
              "logResponses": false,
              "pipeLiningLimit": 1,
              "proxyHost": "",
              "logRequests": false,
              "timeout": {
                "unit": "MINUTES",
                "value": 15
              },
              "proxyPort": 8888,
              "maxResponseSize": 1000000,
              "usesHttps": true,
              "accessKey": "CHANGEME",
              "port": 443,
              "minConnections": 0,
              "tenantId": "CHANGEME",
              "connectingTimeout": {
                "unit": "SECONDS",
                "value": 30
              },
              "host": "CHANGEME - BMC Helix host - ex.swp-2021-1840-disceks1.abc.com",
              "poolTimeout": {
                "unit": "MINUTES",
                "value": 30
              },
              "maxOpenRequests": 1024,
              "maxConnections": 5,
              "maxRedirects": 5,
              "usesProxy": false
            },
            "poolTimeout": {
              "unit": "MINUTES",
              "value": 30
            }
          }
        },
        "instanceName": "BMC",
        "tenantId": "CHANGEME - Must match the tenantId specified in the previous occurrence",
        "typeName": "BmcDestination",
        "id": "CHANGEME - GENERATE NEW UUID using https://www.uuidgenerator.net/version4 e.g. 2643e089-18a8-4b0d-a58a-c022926812e0  MUST BE UNIQUE in a stack",
        "moduleId": "bmc"
      }
    ]
  13. Update the values of the following parameters in the file wherever you see the CHANGEME occurrences and save the file:
    • proxyUsername: User name for the proxy.
    • proxyPassword: Password for the proxy.
    • proxyPort: Proxy port number.
    • proxyHost: Host name of the proxy.
    • usesProxy : Whether proxy should be used for communication. Set its value to true .
    • accessKey and accessSecretKey: Access key and secret key required to the access the BMC Helix applications.
      For instructions about how to generate the access key and secret key, see Setting up access keys for programmatic access. Open link

      Important

      The keys are generated in the following format: key:<access key>::<secret key>,tenant id: <tenant ID>. Enter <access key> and <secret key> as the values of the accessKey and accessSecretKey parameters.

      The access key and secret key must have the Administrators group and the Administrator role assigned.

    • tenantId (in two occurrences): T enant ID.
      Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id: <tenant ID>) that you generated earlier.

    • id: Universally unique identifier (UUID).
      Access https://www.uuidgenerator.net/version4 to generate UUID.
  14. Access the BMC Helix Intelligent Integrations UI by using the following URL:
    http://<hostName>:80/swpui
  15. (Optional) Allow access to the UI by using the HTTPS protocol :
    1. Obtain the self-signed from you organization or CA-signed certificate and private keys from Certificate Authority. 

    2. Copy the certificate and private key you obtained to the /opt/bmc/hii/conf/certs directory, and ensure that the names of the certificate and private key files are in the following format:
      < hostName>.crt and <hostName>.key
      hostName is the fully-qualified domain name of the server where BMC Helix Intelligent Integrations is installed.
    3. Open the /opt/bmc/hii/docker-compose.yaml file with an editor.
    4. Uncomment the port number and certificate-related lines in the nginx-proxy and volumes sections:

        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
    5. Update the VIRTUAL_HOST parameter:
      1. Navigate to the ui: section.
      2. Replace host.youcompany.com with the fully-qualified domain name of the computer where BMC Helix Intelligent Integrations is installed, as shown in the following example:

        VIRTUAL_HOST: localhost #,hostA.mycompany.com


    6. Restart the docker-compose service:

      docker-compose start
  16. Import the ade-default-destination-min.json file by using the Backup/Restore option to create the destination .
    For more information, see Backing up and restoring connector configurations.


Where to go from here

Start configuring connections 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