Deploying the on-premises gateway in an on-premises Kubernetes or OpenShift cluster
Use your existing on-premises Kubernetes or OpenShift clusters to deploy the BMC Helix Intelligent Integrations on-premises gateway. When you deploy the on-premises gateway, authentication is enabled for it.
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 host from where the Kubernetes or OpenShift cluster is accessible.
- 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>.zipNavigate 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:
- useAdeStorage
- hiigHAClusterID
- minioAccessKey
- minioSecretKey
- minioServerUrl
- minioBucketName
For information about these parameters, see Configuring the on-premises gateway for high availability in on-premises Kubernetes and OpenShift clusters.
- 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": "",
"minioSecretKey": "",
"minioServerUrl": "",
"minioBucketName": "helix-hii-backup",
"useHttpsImsUrl": "false"
- Deploy the on-premises gateway for which authentication will be enabled:
- Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
Run the gateway_deployment.sh script.
./gateway_deployment.sh- 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. - 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.- 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:
- Navigate to the /<IIGateway_INSTALL_DIR>/hii/scripts directory.
- Run the gateway_monitoring_services_deployment.sh script:
./gateway_monitoring_services_deployment.sh - 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:
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"
}
]- 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.
- 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.- 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.
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.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.- Edit the destination connection details:
- On the CONNECTORS tab, click Configure Mediator
on the DESTINATIONS panel. - 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 7(c).
- Click Validate to validate the connection.
- Click Save & Close.
- On the CONNECTORS tab, click Configure Mediator
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.
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*