Navigating the UI
This page provides a visual walk-through of how to navigate the main canvas in Automation Gateway, including the interface for version information, API documentation, and sign out.
Figure 1: Automation Gateway UI
| UI Label | Description |
|---|---|
| 1 | The left navigation tree view provides a group list of all the Modules, Roles, Playbooks and Devices in your Ansible deployment. |
| 2 | The top toolbar displays the group name (i.e. family) and unit within that collection. A breadcrumb trail allows you to keep track of your location within Automation Gateway. |
| 3 | The main canvas is a card-based user interface. It captures each input within a family and provides a brief description. |
| 4 | The Details icon for each card opens a screen to display a list of configurable parameters and values. Information displayed on the Details screen align with information shown in the Red Hat Ansible documentation. |
| 5 | Users can "decorate" (enhance) a configuration by augmenting the variables of a module, role, or playbook. A blue triangle denotes user applied decoration. An orange triangle denotes Itential applied decoration. Decoration is stored in the database. |
Figure 2: Dialog Menu
| UI Label | Description |
|---|---|
| 1 | Click the stacked bars icon (☰) to open a separate dialog box. |
| 2 | Click About to display the version of Automation Gateway and Ansible that is running. |
| 3 | Click Documentation to open a slide-out panel from the right. The panel provides access to the API documentation for Automation Gateway. |
| 4 | Click Sign Out to exit Automation Gateway. You will return to the login screen. |
Displaying the Property Details
This guide provides a brief walk-through of how to access property details in Automation Gateway.
Figure 3: Automation Gateway Property Details
| UI Label | Description |
|---|---|
| 1 | Click the Information icon to display the name and schema type for your Ansible deployment of a module, role, or playbook. For devices, the OS type and device user role is displayed. This information is rendered directly from the Red Hat Ansible ® documentation. |
| 2 | Click the Edit icon to display the JSON schema in Edit mode. |
| 3 | Use the Revert icon to rollback any changes made to the JSON properties for a module, role, playbook, or device. This will reset the schema to the original property settings that were shipped with the current installation. To the right of Revert are icon buttons to import/export a JSON schema. |
| 4 | Use the top row of fields to search and sort by various parameters (i.e., name, type, description, etc.). |
Click to see the IAG 2022.1 user interface.
Import and export icons are not displayed on the Parameters tab in the 2022.1 release.
IAG 2022.1 Property Details UI
Accessing the API Documentation
When you click Documentation in the dialog menu, a slide-out panel opens from the right. The panel provides access to the API Documentation for Automation Gateway.
Figure 4: API Documentation
| UI Label | Description |
|---|---|
| 1 | The click-out panel for API Documentation can be use to pop out the window. The floating window then can be resized. |
| 2 | The Try it out button allows the user to interact with and run each operation command the API exposes in Automation Gateway. |
| 3 | Click Close at the bottom to close the panel. |