Overview
Centralised configuration allows you to use Gateway Hub to centrally manage Gateway configurations. Gateway Hub provides a repository to store and manage Gateway configurations via a REST API. This removes the need to create and manage externally hosted configuration files.
You can start a Gateway using a configuration from Gateway Hub. These Gateways are called centrally configured Gateways. For more information, see Centralised gateways user guide.
Manage centralised configuration with Gateway Hub REST API
As environments become more complex and dynamic it is useful to be able to manage centrally configured Gateways automatically and programmatically. The Gateway HubREST API provides this capability. You can create, edit, delete, validate, and lock Gateway configurations using the REST API. For more information, see Gateway in Gateway Hub REST API v1alpha OpenAPI.
Note: If Gateway Hub security is enabled, you must have a security token to access the Gateway Hub REST API endpoints. For more information, see Authentication in Retrieve Data from Gateway Hub.
Centralised configuration architecture
A typical Geneos installation will have multiple Gateways. Each unique Gateway is composed of a copy of the Gateway binaries and a gateway.setup.xml resource file. You can store binaries and resource files centrally using Gateway Hub. For more information, see Centralised gateways user guide.
You can control centrally configured Gateways using the Gateway Setup Editor or using the REST API. Gateway Hub coordinates between Geneos components to enable centralised configuration.
You can perform the following operations to control centrally configured Gateways:
| Operation | Description |
|---|---|
| Create or Delete | When you start a centrally configured Gateway, it requests resource files from Gateway Hub. If it cannot find a resource file, then it creates a new centrally stored resource file. |
| Edit | You can edit the setup of a Gateway using the Gateway Setup Editor or the REST API. Any changes you make are saved to the Gateway Hub. |
| Validate | When you perform validation on a centrally configured Gateway, the setup is validated against the binaries stored in Gateway Hub. |
| Lock or Unlock | You can lock resource files to prevent changes to a Gateway. When locking or unlocking a resource file, using centralised configuration ensures this is locked for all users of the Gateway Hub. This requires that you have SSO authentication enabled. |