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

Related topics

Use your existing on-premises Kubernetes or OpenShift clusters to deploy the BMC Helix Intelligent Integrations on-premises gateway. You can configure the on-premises gateway either during deployment or after deployment is complete.

When you deploy the on-premises gateway, authentication is enabled for it.

Important

Deployment of the on-premises gateway without authentication is not supported.

If you are deploying the on-premises gateway in an on-premises Kubernetes or OpenShift cluster, first prepare for the deployment.

(If you are a Helix subscriber) To deploy the on-premises gateway in an on-premises Kubernetes or OpenShift cluster

Log on to the controller or bastion host, and as a cluster-admin user, connect to the Kubernetes or OpenShift cluster in which you want to deploy the on-premises gateway.
Copy the utility files (hii-bmc-<buildNumber>.zip) that you obtained to a temporary directory, for example, /<IIGateway_INSTALL_DIR>.
Extract the utility files.
unzip hii-bmc-<buildNumber>.zip
Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory and open the deployment_config.json file by using a text editor.
Update the following parameters with the details that you noted when creating the namespace:
- namespace
- storageclass
- ingressclass
- registryhost
- imagepullsecret
- imageformat
- org
- swpuiingress
- grafanaingress
(Optional) To configure the protocol to be used (defaults to HTTP) for authorization between the on-premises gateway and the Identity Management System (IMS), which is part of the BMC Helix platform, set the useHttpsImsUrl parameter to true or false.

(Optional) If you want to deploy the on-premises gateway in high availability mode, depending on whether you are using the object storage included with the BMC Helix deployment or a private object storage, update the parameters as shown in the following table:

Parameter name and description	Parameter value for the storage included with the BMC Helix SaaS deployment	Parameter value for the private storage
useAdeStorage Type of object storage to be used in the HA deployment	true	false
hiigHAClusterID A unique cluster ID in case you have multiple clusters, each cluster containing multiple on-premises gateway instances.	An integer from 0 to 9	An integer from 0 to 9 The default value is 0, which indicates that you have only one cluster.
minioAccessKey Access key or login ID for the S3-compatible storage	"" (default)	Access key or login ID
minioSecretKey Secret key or password for the S3-compatible storage	"" (default)	Secret key or password
minioServerUrl Endpoint URL for the S3-compatible storage	"" (default)	Endpoint URL
minioBucketName Name of the bucket on the S3-compatible storage instance Important: If you are using the same S3-compatible storage server across multiple HA environments (for example, Test and Production), make sure that each bucket has a unique name.	helix-hii-backup (default) Warning: Don't update the bucket name.	Name of the bucket
dataPushInterval Interval at which an on-premises gateway instance should push data to the object storage	Interval in milliseconds Default and minimum value: 300000 milliseconds.	Interval in milliseconds Default and minimum value: 300000 milliseconds.

Save and close the file.
The following snippet shows a sample file:
    "namespace": "iionpremk8s",
    "storageclass": "ceph-rbd-sc-neoceph",
    "ingressclass": "nginx",
    "registryhost": "docker.io",
    "imagepullsecret": "dockerpull",
    "imageformat": "legacy",
    "org": "bmchelixhub",
    "swpuiingress": "swpui-iionpremk8s-dev1.dsm-01.abc.com",
    "grafanaingress": "swpgrafana-iionpremk8s-dev2.dsm-01.abc.com",
    "useAdeStorage": "true",
    "hiigHAClusterID": "0",
    "minioAccessKey": "",
    "minioSecretKey": "",
    "minioServerUrl": "",
    "minioBucketName": "helix-hii-backup",
    "dataPushInterval": "600000",
    "useHttpsImsUrl": "false"
Deploy the on-premises gateway for which authentication will be enabled:
1. Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
2. Run the gateway_deployment.sh script.
  ./gateway_deployment.sh
3. 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.
4. Enter the following information:
  - Access key and access secret key: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - Tenant Id: BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id: <tenant ID>).
  - Tenant URL: BMC Helix tenant URL.
  - Host name: Provide the same value as provided for the swpuiingress parameter in the deployment_config.json file.
    After you provide all the credentials, the on-premises gateway is deployed. Also, the cred.json, external.config, and nginx.config configuration files are backed up in the /<userHome>/iig_auth directory.
(Optional, applicable only for the deployment 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.
Perform the following steps to configure the BMC Helix destination to which you want to send data collected by BMC Helix Intelligent Integrations:
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 tenant host name - for example: 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": "287c466d-7467-4e72-9e52-8357b4a27eaf",
      "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. Enter the values of the following parameters in 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 a proxy should be used for communication. Set its value to true or false depending on whether the proxy should be used.
    Important: If a proxy is configured for the destination, the same proxy is used for communication with the BMC Helix object storage in a high-availability deployment of the on-premises gateway.
3. Replace the CHANGEME value of the following parameters with the generated values:
  - accessKeyand accessSecretKey: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - tenantId(first occurrence only): BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id:<tenant ID>) that you generated earlier and replace the CHANGEME occurrences with the copied tenant ID.
  - host: BMC Helix tenant host name.
    For example, if the tenant URL is https://swp-2021-1840-disceks1.abc.com, replace CHANGEME with swp-2021-1840-disceks1.abc.com.
  - id: Universally unique identifier (UUID).
    Access https://www.uuidgenerator.net/version4 to generate UUID.
4. 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
  BMC Helix Portal does not display any tile for the BMC Helix Intelligent Integrations on-premises gateway. Access the UI by using the URL specified in this step.
  If you encounter an issue when accessing or using BMC Helix Intelligent Integrations, see Troubleshooting the BMC Helix Intelligent Integrations issues.
5. 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.
  Information
  Can I create more than one BMC destination for one instance of the on-premises gateway?
  No, BMC Helix Intelligent Integrations supports only one destination for one instance of on-premises gateway.
6. Edit the destination connection details:
  1. On the CONNECTORS tab, click Configure Mediator on the DESTINATIONS panel.
  2. Replace the existing values in the Access Key and Access Secret Key fields with the values that you have copied in the ade-default-destination-min.json file in step 11 (c).
  3. Click Validate to validate the connection.
  4. Click Save & Close.

(If you are using BMC Helix ITOM on premises with additional capabilities) To deploy the on-premises gateway in an on-premises Kubernetes or OpenShift cluster

Make sure that the SWP_INTELLIGENT_INTEGRATIONS service flag is set to true during the fresh deployment or upgrade to version BMC Helix ITOM on premises version 25.4 or later.
When you set the flag to true, services to support only the additional capabilities are deployed. For more information, see Deploying BMC Helix IT Operations Management.
Log on to the controller or bastion host, and as a cluster-admin user, connect to the Kubernetes or OpenShift cluster in which you want to deploy the on-premises gateway.
Copy the following files that you obtained to a temporary directory, for example, /<IIGateway_INSTALL_DIR>.
Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory and open the deployment_config.json file by using a text editor.
Update the following parameters with the details that you noted when creating the namespace:
- namespace
- storageclass
- ingressclass
- registryhost
- imagepullsecret
- imageformat
- org
- swpuiingress
- grafanaingress
(Optional) To configure the protocol to be used (defaults to HTTP) for authorization between the on-premises gateway and the Identity Management System (IMS), which is part of the BMC Helix platform, set the useHttpsImsUrl parameter to true or false.

(Optional) If you want to deploy the on-premises gateway in high availability mode, update the following parameters:

Parameter name and description	Parameter value for the storage included with the BMC Helix ITOM deployment
useAdeStorage Type of object storage to be used in the HA deployment	true
hiigHAClusterID A unique cluster ID in case you have multiple clusters, each cluster containing multiple on-premises gateway instances.	An integer from 0 to 9 The default value is 0, which indicates that you have only one cluster.
minioAccessKey Access key or login ID for the S3-compatible storage	"" (default)
minioSecretKey Secret key or password for the S3-compatible storage	"" (default)
minioServerUrl Endpoint URL for the S3-compatible storage	"" (default)
minioBucketName Name of the bucket on the S3-compatible storage instance	helix-hii-backup (default) Warning: Don't update the bucket name.
dataPushInterval Interval at which an on-premises gateway instance should push data to the object storage	Interval in milliseconds Default and minimum value: 300000 milliseconds

Save and close the file.
The following snippet shows a sample file:
    "namespace": "iionpremk8s",
    "storageclass": "ceph-rbd-sc-neoceph",
    "ingressclass": "nginx",
    "registryhost": "docker.io",
    "imagepullsecret": "dockerpull",
    "imageformat": "legacy",
    "org": "bmchelixhub",
    "swpuiingress": "swpui-iionpremk8s-dev1.dsm-01.abc.com",
    "grafanaingress": "swpgrafana-iionpremk8s-dev2.dsm-01.abc.com",
    "useAdeStorage": "true",
    "hiigHAClusterID": "0",
    "minioAccessKey": "",
    "minioSecretKey": "",
    "minioServerUrl": "",
    "minioBucketName": "helix-hii-backup",
    "dataPushInterval": "300000",
    "useHttpsImsUrl": "false"
Deploy the on-premises gateway for which authentication is enabled:
1. Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
2. Run the gateway_deployment.sh script.
  ./gateway_deployment.sh
3. 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.
4. Enter the following information:
  - Access key and access secret key: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - Tenant Id: BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id: <tenant ID>).
  - Tenant URL: BMC Helix tenant URL.
  - Host name: Provide the same value as provided for the swpuiingress parameter in the deployment_config.json file.
    After you provide all the credentials, the on-premises gateway is deployed. Also, the cred.json, external.config, and nginx.config configuration files are backed up in the /<userHome>/iig_auth directory.
(Optional, applicable only for deployment 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.
Perform the following steps to configure the BMC Helix destination to which you want to send data collected by BMC Helix Intelligent Integrations:
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 tenant host name - for example: 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": "287c466d-7467-4e72-9e52-8357b4a27eaf",
      "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. Enter the values of the following parameters in 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 a proxy should be used for communication. Set its value to true or false depending on whether the proxy should be used.
    Important: If a proxy is configured for the destination, the same proxy is used for communication with the BMC Helix object storage in a high-availability deployment of the on-premises gateway.
3. Replace the CHANGEME value of the following parameters with the generated values:
  - accessKeyand accessSecretKey: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - tenantId(first occurrence only): BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id:<tenant ID>) that you generated earlier and replace the CHANGEME occurrences with the copied tenant ID.
  - host: BMC Helix tenant host name.
    For example, if the tenant URL is https://swp-2021-1840-disceks1.abc.com, replace CHANGEME with swp-2021-1840-disceks1.abc.com.
  - id: Universally unique identifier (UUID).
    Access https://www.uuidgenerator.net/version4 to generate UUID.
4. 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
  BMC Helix Portal does not display any tile for the BMC Helix Intelligent Integrations on-premises gateway. Access the UI by using the URL specified in this step.
  If you encounter an issue when accessing or using BMC Helix Intelligent Integrations, see Troubleshooting the BMC Helix Intelligent Integrations issues.
5. 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.
  Information
  Can I create more than one BMC destination for one instance of the on-premises gateway?
  No, BMC Helix Intelligent Integrations supports only one destination for one instance of on-premises gateway.
6. Edit the destination connection details:
  1. On the CONNECTORS tab, click Configure Mediator on the DESTINATIONS panel.
  2. Replace the existing values in the Access Key and Access Secret Key fields with the values that you have copied in the ade-default-destination-min.json file in step 11 (c).
  3. Click Validate to validate the connection.
  4. Click Save & Close.

(If you are using BMC Helix ITOM on premises without additional capabilities) To deploy the on-premises gateway on Docker containers

Make sure that the SWP_INTELLIGENT_INTEGRATIONS service flag is set to false (default) during the fresh deployment or upgrade to version BMC Helix ITOM on premises version 25.4 or later. For more information, see Deploying BMC Helix IT Operations Management.
Log on to the controller or bastion host, and as a cluster-admin user, connect to the Kubernetes or OpenShift cluster in which you want to deploy the on-premises gateway.
Copy the following files that you obtained to a temporary directory, for example, /<IIGateway_INSTALL_DIR>.
Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory and open the deployment_config.json file by using a text editor.
Update the following parameters with the details that you noted when creating the namespace:
- namespace
- storageclass
- ingressclass
- registryhost
- imagepullsecret
- imageformat
- org
- swpuiingress
- grafanaingress
(Optional) To configure the protocol to be used (defaults to HTTP) for authorization between the on-premises gateway and the Identity Management System (IMS), which is part of the BMC Helix platform, set the useHttpsImsUrl parameter to true or false.

Parameter name and description	Parameter value for the storage included with the BMC Helix ITOM deployment or the private object storage
useAdeStorage Type of object storage to be used in the HA deployment	false
hiigHAClusterID A unique cluster ID in case you have multiple clusters, each cluster containing multiple on-premises gateway instances	An integer from 0 to 9 The default value is 0, which indicates that you have only one cluster.
minioAccessKey Access key or login ID for S3-compatible storage	Access key or login ID
minioSecretKey Secret key or password for the S3-compatible storage	Secret key or password
minioServerUrl Endpoint URL for the S3-compatible storage	Endpoint URL
minioBucketName Name of the bucket on the S3-compatible storage instance Important: If you are using the same S3-compatible storage server across multiple HA environments (for example, Test and Production), make sure that each bucket has a unique name.	Name of the bucket
dataPushInterval Interval at which an on-premises gateway instance should push data to the object storage	Interval in milliseconds Default and minimum value: 300000 milliseconds

Save and close the file.
The following snippet shows a sample file:
    "namespace": "iionpremk8s",
    "storageclass": "ceph-rbd-sc-neoceph",
    "ingressclass": "nginx",
    "registryhost": "docker.io",
    "imagepullsecret": "dockerpull",
    "imageformat": "legacy",
    "org": "bmchelixhub",
    "swpuiingress": "swpui-iionpremk8s-dev1.dsm-01.abc.com",
    "grafanaingress": "swpgrafana-iionpremk8s-dev2.dsm-01.abc.com",
    "useAdeStorage": "false",
    "hiigHAClusterID": "0",
    "minioAccessKey": "Q3AM3UQ867SPQQA43P2F",
    "minioSecretKey": "Pq4Rs8TuVw3XyZ6aBcDeFgH",
    "minioServerUrl": "http://minio.example.com:9000",
    "minioBucketName": "hii-backup",
    "dataPushInterval": "600000",
    "useHttpsImsUrl": "false"
Perform the following steps to update the BMC Helix SSO configuration for Auth Proxy:
1. Navigate to the <IIGATEWAY_INSTALL_DIR>/hii/conf/authproxy directory and open the external.conf file with a text editor.
2. Update the file:
  1. Search for the rsso_external_url and rsso_internal_url parameters and replace {RSSO_URL} with the OpenID Connect Issuer URL.
  2. Search for the client_id parameter and replace {RSSO_CLIENT_ID} with the Client ID that you saved in a file while registering the OAuth client.
  3. Search for the client_secret parameter and replace {RSSO_CLIENT_SECRET} with the Client Secret that you saved in a file while registering the OAuth client.
  4. Locate the proxies section, and replace {TENANT_URL} with the BMC Helix tenant URL. For example, https://swp-2021-1840-disceks1.abc.com .
  5. Save the file.
Deploy the on-premises gateway for which authentication will be enabled:
1. Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
2. Run the gateway_deployment.sh script.
  ./gateway_deployment.sh
3. 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.
4. Enter the following information:
  - Access key and access secret key: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - Tenant Id: BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id: <tenant ID>).
  - Tenant URL: BMC Helix tenant URL.
  - Host name: Provide the same value as provided for the swpuiingress parameter in the deployment_config.json file.
    After you provide all the credentials, the on-premises gateway is deployed. Also, the cred.json, external.config, and nginx.config configuration files are backed up in the /<userHome>/iig_auth directory.
(Optional, applicable only for deployment 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.
Perform the following steps to configure the BMC Helix destination to which you want to send data collected by BMC Helix Intelligent Integrations:
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 tenant host name - for example: 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": "287c466d-7467-4e72-9e52-8357b4a27eaf",
      "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. Enter the values of the following parameters in 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 a proxy should be used for communication. Set its value to true or false depending on whether the proxy should be used.
    Important: If a proxy is configured for the destination, the same proxy is used for communication with the BMC Helix object storage in a high-availability deployment of the on-premises gateway.
3. Replace the CHANGEME value of the following parameters with the generated values:
  - accessKeyand accessSecretKey: Access key and secret key required to 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.
    Warning
    Important
    The keys are generated in the following format: key:<access key>::<access secret key>,tenant id: <tenant ID>. Enter <access key> and <access secret key> as the values of the access key and access secret key.
    The access key and access secret key must have the Administrators group and the Administrator role assigned.
  - tenantId(first occurrence only): BMC Helix tenant ID.
    Copy the tenant ID from the access key (key:<access key>::<secret key>,tenant id:<tenant ID>) that you generated earlier and replace the CHANGEME occurrences with the copied tenant ID.
  - host: BMC Helix tenant host name.
    For example, if the tenant URL is https://swp-2021-1840-disceks1.abc.com, replace CHANGEME with swp-2021-1840-disceks1.abc.com.
  - id: Universally unique identifier (UUID).
    Access https://www.uuidgenerator.net/version4 to generate UUID.
4. 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
  BMC Helix Portal does not display any tile for the BMC Helix Intelligent Integrations on-premises gateway. Access the UI by using the URL specified in this step.
  If you encounter an issue when accessing or using BMC Helix Intelligent Integrations, see Troubleshooting the BMC Helix Intelligent Integrations issues.
5. 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.
  Information
  Can I create more than one BMC destination for one instance of the on-premises gateway?
  No, BMC Helix Intelligent Integrations supports only one destination for one instance of on-premises gateway.
6. Edit the destination connection details:
  1. On the CONNECTORS tab, click Configure Mediator on the DESTINATIONS panel.
  2. Replace the existing values in the Access Key and Access Secret Key fields with the values that you have copied in the ade-default-destination-min.json file in step 12 (c).
  3. Click Validate to validate the connection.
  4. Click Save & Close.

Where to go from here

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

(Optional) 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 data.

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

(If you are a Helix subscriber) To deploy the on-premises gateway in an on-premises Kubernetes or OpenShift cluster

(If you are using BMC Helix ITOM on premises with additional capabilities) To deploy the on-premises gateway in an on-premises Kubernetes or OpenShift cluster

(If you are using BMC Helix ITOM on premises without additional capabilities) To deploy the on-premises gateway on Docker containers

Where to go from here

BMC Helix Intelligent Integrations 26.1

On this page