A configuration document provides the configuration details for a single OMAG Server. It defines which subsystems are activated in the server and which connector implementations it should use.
An OMAG Server's configuration document is structured into elements that each describe the configuration properties for each of its desired capabilities.
Figure 1 provides more details.
Figure 1: Structure of the configuration document
The sections are as follows:
- Default values to use when creating other configuration elements. These values need to be set up first
- Basic properties of any OMAG server.
- Configuration for specific subsystems that provide the key capabilities for different types of OMAG Servers.
- Audit trail that documents the changes that have been made to the configuration document.
It is possible to retrieve the configuration document for a server using the following command.
GET {platformURLRoot}/open-metadata/admin-services/users/{adminUserId}/servers/{serverName}/configuration
When the server is running, the following command returns the configuration document that was used to start it (since it may have changed in the configuration document store since the server was started.)
GET {platformURLRoot}/open-metadata/admin-services/users/{adminUserId}/servers/{serverName}/instance/configuration
At the top of the configuration document are Local Server URL Root and Event Bus Config.
- The local server URL root defines the root of the network address for the OMAG Server Platform where the OMAG Server will run.
- The event bus configuration provides the configuration of the event bus (Apache Kafka or similar) where all of the event topics that the server will use are located.
Both of these elements provide default values for other configuration elements.
If they are changed, their new values do not affect existing definitions in the configuration document.
- Configuring the Basic Properties
- Configuring the Audit Log
- Configuring the Server Security Connector
- Configuring the local repository - Metadata Server only
- Configuring registration to a cohort - Metadata Access Point, Metadata Server, Repository Proxy and Conformance Test Server only
- Configuring the open metadata archives loaded at server start - Metadata Access Point, Metadata Server and Repository Proxy only
- Configuring the repository proxy connectors - Repository Proxy only
- Configuring the Open Metadata Access Services (OMASs) - Metadata Access Point and Metadata Server only
- Configuring the Open Metadata Engine Services (OMES) - Engine Host only
- Configuring the Open Metadata Integration Services (OMIS) - Integration Daemon only
- Configuring the Open Metadata View Services (OMVSs) - View Server only
The audit trail allows you to keep track of changes to the configuration document. This is helpful what any recent changes might have been - particularly if a working server suddenly stops working - the first question is always, "what has changed recently?".
It also acts as a nice summary of how the server has been configured.
Below is an example of an audit trail:
{
"auditTrail" : [
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's URL root to https://localhost:9444.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for maximum page size to 100.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server type name to Open Metadata Server.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's owning organization's name to Coco Pharmaceuticals.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's userId to cocoMDS1npa.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's password to cocoMDS1passw0rd.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke added configuration for an Open Metadata Server Security Connector",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for default event bus.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for the local repository.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for the local repository.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke preserving local metadata collection id bfdfdc61-01bb-4564-9c29-6b81c0fb79f8.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for cohort cocoCohort.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
"Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
"Thu Jan 30 22:44:10 GMT 2020 garygeeke deployed configuration for server."
]
}
By default the configuration document are stored as JSON in a file in the default directory for the OMAG Server Platform that creates them.
These files may contain security certificates and passwords and so should be treated as sensitive. It is possible to change the storage location of configuration documents - or even the type of store. See Configuration document Store Connector for more information.
- OMAG Server - different types of OMAG servers and what they do.
- Open Connector Framework (OCF) to understand more abut open connectors and connections since many of the sections in the configuration document take connection objects for connectors.
- Configuring an OMAG Server provides more detail on the process of creating a configuration document.
Return to Administration Services Concepts
License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.