Deploying the on-premises gateway by using Podman containers


Use the Podman container images to deploy the BMC Helix Intelligent Integrations on-premises gateway in your 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 Podman containers

  1. Go to the server where you want to deploy the gateway and copy the downloaded files to the /opt/bmc directory:
    • Container images: docker-images-bmc-<version>-<buildNo>.tgz
    • Utility file: swp-bmc-<version>-<buildNumber>.zip
  2. 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
  3. Reboot the server:

    /sbin/reboot now
  4. Disable firewalld:

    systemctl disable firewalld
  5. 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
  6. Load the container images:

    podman load --input /opt/bmc/docker-images-bmc-<version>-<buildNo>.tgz
  7. 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/podman-compose.yaml

  8. Unzip swp-bmc-<version>-<buildNumber>.zip to the /opt/bmc directory.
  9. Change permissions on the /opt/bmc/hii/logs directory to 777:

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

    podman-compose -f podman-compose.yaml up -d
  11. (Optional) Perform these steps if a proxy is required for the outgoing traffic from your on-premises environment to the BMC Helix applications. If proxy is not required, skip to step 12.
    1. 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"
        }
      ]
    2. 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.

        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 accessKey and accessSecretKey parameters.

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

      • tenantId (in two occurrences): Tenant 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.
    3. Access the BMC Helix Intelligent Integrations UI by using the following URL:
      http://<hostName>:7457/swpui
    4. 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.
  12. Access the BMC Helix Intelligent Integrations UI by using the following URL:
    http://<hostName>:7457/swpui


 

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