To view the details page for a gateway cluster:
- Open Itential Platform in your browser.
- Select Gateway Manager from the Administration collection in the left-side navigation menu.
- Navigate to the Gateways tab in Gateway Manager.
- Select the gateway cluster that you want to view from the list of gateways.
Figure 1: Gateway cluster details page
Gateway cluster details
The details page for each gateway cluster displays the following information about the gateway:
Admin state
Controls whether or not a gateway cluster can connect to Gateway Manager and Itential Platform. There are three admin states:
- Disabled: When a gateway cluster is disabled, it does not connect to Gateway Manager or Itential Platform. Gateways are disabled at creation and must be manually enabled.
- Enabled: When a gateway cluster is enabled, it connects to Gateway Manager and Gateway Manager can discover all of the services associated with the gateway and advertise these services to Itential Platform. The Platform can use these services as tasks in automation workflows. Gateway Manager executes the services when Itential Platform calls them during a workflow.
- Read-Only: When a gateway cluster is read-only, it can connect to Gateway Manager and Gateway Manager can discover all of the services associated with the gateway, but it cannot execute the services or advertise them to Itential Platform.
You can update the admin state by selecting your desired admin state from the dropdown menu.
Gateway cluster description
You can provide a description for your gateway to help identify and organize how each gateway in your environment is used. This is an optional string value that cannot exceed 1000 characters.
You can edit the description by clicking the edit icon below the description.
Gateway cluster history
The gateway cluster details page logs the following creation, edit, and connection details:
- Created by: the user or service account that created the gateway cluster and the date and time that the gateway was created.
- Last Updated by: the user or service account that last updated the gateway cluster and the date and time that the gateway was last updated.
- Last Connection: the last date and time that a controller node connected to Gateway Manager and the hostname of the controller node.
These details are automatically populated and cannot be modified.
Access
The user authorization groups that have been assigned access to the gateway cluster. These user groups enable you to enforce group-based access control (GBAC). You must specify at least one user group for each gateway cluster.
You can add or remove user groups from by clicking the edit icon next to the Access list.
Linked Certificates
The end-entity certificates that have been uploaded to Gateway Manager. The Linked Certificates tab of the details page displays the basic properties of the certificate.
You can modify what certificates are linked to your gateway cluster by clicking the Link toggle:
- If the Link toggle is enabled, the certificate is associated with the gateway cluster.
- If the Link toggle is disabled, the certificate has been uploaded to Gateway Manager but has not been associated with the gateway cluster.
For more information, see Certificates.
Service Groups
The service groups used to control which users can access and utilize specific services within your gateway cluster. The Service Groups tab of the details page displays all of the service groups associated with the gateway.
Every gateway cluster automatically creates a Default Service Group when you first establish the gateway. New services are automatically added to the default service group.
Select a service group from the list to expand and view the service group details. The drop down displays the Service Group Name, Description, and lists the user groups provided access to the service group in the Access list. You can also view and edit which services are included in the service group.
You can modify service group access, create new service groups, and manage service group details from the Service Groups tab of the details page.
For more information, see Service groups.
Services
The gateway services registered on the gateway cluster. The Services tab of the details page displays the basic properties of your gateway services.
The Services tab displays the Service Name, Type (ansible-playbook, python-script, or opentofu-plan), and indicates whether there are Decorators associated with the service.
Select a service from the list to expand and view the service details. The drop down displays when the service was Last Executed, lists which workflows reference the service, and displays the service parameters.
For more information, see Creating gateway services.
Workflows
The workflows in Itential Platform that reference gateway services in this gateway cluster. The Workflows tab displays the name of the workflow and lists the services that are included in the workflow.
Select a workflow from the list to view the workflow in Studio. Studio opens in a new browser tab.
For more information, see Adding services to workflows.