Create a gateway cluster

In Gateway Manager, gateway clusters represent the identity of your Itential Automation Gateway (IAG) deployment. Before you can connect your gateway cluster to Itential Platform, you must create a gateway cluster in Gateway Manager that facilitates and explicitly allows the cluster to connect to Platform.

Gateway cluster parameters

Gateway Cluster ID: The unique identifier assigned to your gateway cluster. The gateway cluster ID that you provide must match the GATEWAY_APPLICATION_CLUSTER_ID defined in your gateway server configuration.
(Optional) Description: An optional string value that cannot exceed 1000 characters. If you register multiple gateway clusters in Gateway Manager, you can use the description parameter to help you identify and organize how each gateway cluster is used.
Access: One or more authorization groups used to enforce group-based access control (GBAC). You must specify at least one user group when you create a gateway cluster.

Prerequisites

Before creating a gateway cluster in Gateway Manager, ensure you have completed the following:

Installed and configured a gateway server. Your gateway server must be running to connect it to Gateway Manager.
Installed Gateway Manager (On-prem deployments only).
Generated and uploaded your certificate(s) to Gateway Manager. Each gateway cluster requires at least one certificate to establish a secure connection between your IAG deployment and Gateway Manager.

Create a gateway cluster

Creating a gateway cluster tells the Itential Platform that your gateway is trusted and can be used to run automation services.

Navigate to Itential Platform.

Select Gateway Manager from the Administration collection in the left-side navigation menu.

Navigate to the Gateways tab in Gateway Manager.

Click Add Gateway Cluster.

Set the gateway cluster ID to match the GATEWAY_APPLICATION_CLUSTER_ID defined in your gateway server configuration.

(Optional) Enter a description.

Under Access, add at least one authorization group to your gateway cluster.

Click Add.

Enable your gateway cluster

Gateway clusters are disabled at creation and must be manually enabled. To enable your gateway cluster, you need to connect at least one certificate to the gateway.

Navigate to the Gateways tab in Gateway Manager.

Select your newly created gateway cluster to view the gateway details.

Under Linked Certificates, click the Link toggle to connect the appropriate certificate to your gateway cluster.

This certificate should match the certificate specified in the GATEWAY_CONNECT_CERTIFICATE_FILE configuration variable. For more information, see Create certificates.

Select Enabled from the status dropdown menu to enable your gateway.

Enabling your gateway cluster completes the trust chain between your gateway cluster and Itential Platform, allowing them to communicate securely.