Administration Guide¶
The Egeria technology principally runs on the Open Metadata and Governance (OMAG) Server Platform. This platform hosts one or more OMAG Servers, each supporting a variety of open metadata and governance capabilities.
In the illustration above, the OMAG Server Platforms are the blue, rounded boxes and the orange circles are the OMAG Servers. The green clouds represent different cloud platforms or data centers.
This guide explains how to configure the OMAG Server Platform and the different types of OMAG Servers that run on it.
TL;DR
If you are keen to get started right away then these are the links to the configuration instructions.
and once you have your OMAG Servers configured:
OMAG subsystems¶
An OMAG Server is a set of configured OMAG subsystems supported by the OMAG Server Platform. Each subsystem supports a particular type of technology, so it can exchange metadata with the open metadata ecosystem. Some technologies are sources of metadata, others just consume metadata and then there are technologies that have a two-way exchange of metadata with the open metadata ecosystem.
The OMAG subsystems that are to be enabled in a specific instance of an OMAG Server are defined in a configuration document. When the configuration document is loaded into the OMAG Server Platform, the OMAG Server that it describes is started, and the subsystems defined in the configuration document are activated for that server.
OMAG Servers¶
In an open metadata landscape, there may be multiple instances of OMAG Servers running in an OMAG Server Platform, each performing a different role. Each of these server instances would have their own configuration document allowing them to have different subsystems active.
Configuring an OMAG Server¶
The configuration document for a specific OMAG Server is identified by the server's name. This is passed on the URL of every admin services API request along with the user id of the administrator. By default, the configuration is stored in a file called:
omag.server.{serverName}.config
The administration services that set up this file all begin with a URL like this:
.../open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/...
The serverName specified on these calls determines which configuration document is used, and hence which OMAG Server's configuration it is working with.
The OMAG Server Platform typically starts up without any OMAG Servers active. Once it is running, it can be used to set up the configuration documents that describe the open metadata subsystems needed for each OMAG Server instance.
Once the configuration document is in place, the OMAG Server can be activated and deactivated multiple times, across multiple restarts of the OMAG Server Platform.
Further information
Examples of configuration calls¶
The admin-services modules has three Postman collections to illustrate many of the configuration and operation calls:
- Egeria-admin-services-platform-configuration.postman_environment.json - setting up and configuring the OMAG Server Platform.
- Egeria-admin-services-server-configuration.postman_environment.json - setting up and configuring the variety of OMAG Servers.
- Egeria-admin-services-operational.postman_environment.json - operating the OMAG Servers.
Raise an issue or comment below