Skip to content

OMAG Server Platform

The OMAG Server Platform provides a runtime process and platform for four broad groups of services:

  • Server origin service - used to determine the type and level of the OMAG Server Platform.
  • Platform services - used to determine the servers and their services running on the platform.
  • Administration services - used to configure and manage the OMAG Servers running inside the OMAG Server Platform.
  • Open Metadata and Governance (OMAG) services - used to work with metadata and govern the assets of an organization.

The OMAG services are configured and activated in OMAG Servers using the administration services. The configuration operations of the admin services create configuration documents, one for each OMAG Server. Inside a configuration document is the definition of which OMAG services to activate in the server. These include the Open Metadata Repository Services (OMRS) (any type of server), the Open Metadata Access Services (OMASs) (for metadata access servers), Open Metadata Engine Services (OMESs) (for engine host servers) , Open Metadata Integration Services (OMISs) (for integration daemon servers) and Open Metadata View Services (OMVSs) (for view servers).

Once a configuration document is defined, the OMAG Server can be started and stopped multiple times by the admin services server instance operations.

The OMAG Server Platform also supports some platform services to query details of the servers running on the platform.

The OMAG Server Platform can also host multiple OMAG Servers at any one time:

OMAG Server deployment choices

The choices are as follows:

  • A - Each OMAG Server has its own dedicated OMAG Server Platform - useful when only one server is needed in a deployment environment, or there is a desire to keep each server isolated in its own stack.
  • B - Multiple OMAG Servers are hosted on the same OMAG Server Platform. The OMAG Server Platform routes inbound requests to the right server based on the server name specified in the request URL. The servers may all be of the same type (multi-tenant operation) or be a set of collaborating servers of different types consolidated onto the same platform.
  • C - Multiple copies of same server instance running on different platforms to provide high availability and distribution of workload (horizontal scalability).

Each OMAG Server is isolated within the server platform and so the OMAG Server platform can be used to support multi-tenant operation for a cloud service, or host a variety of different OMAG Servers needed at a particular location.

Further reading

Inside the OMAG server platform

The OMAG server platform provides the server environment for running open metadata and governance services. It hosts one or more OMAG servers. Each server is configured to support specific open metadata and governance services. Thus each server performance a specific role in an deployment landscape.

The OMAG server platform is included in the Egeria Distribution TAR file which can be installed on your machine by following the Installing Egeria Tutorial.

The OMAG server platform supports four broad groups of services:

  • Server Origin Service - used to determine the type and level of the OMAG server platform.
  • Platform Services - used to determine the servers and their services running on the platform.
  • Administration Services - used to configure and manage the OMAG servers running inside the OMAG server platform.
  • Open Metadata and Governance Services - used to work with metadata and govern the assets of an organization.

Figure 1 shows the OMAG server platform when it first starts up.

Figure 1

Figure 1: OMAG server platform at start up

The server origin service is operational at this point. It can be used by operational scripts to determine if the OMAG server platform is still running.

The administration services are active at this point, while the open metadata and governance services will return an error if called since there are no OMAG servers running.

The configuration services are used to create configuration documents. Each configuration document describes the open metadata and governance services that should be activated in a OMAG server.

Figure 2 shows the configuration services creating three configuration documents: * one for the cdoMetadataRepository OMAG server * one for the stewardshipServer OMAG Server * one for the dataLakeDiscoveryEngine OMAG Server

Figure 2

Figure 2: Creating configuration documents for OMAG Servers

The Administration Guide provides detailed instructions on creating configuration documents.

Once a configuration document for an OMAG server is used by the operational services initialize the requested services in the OMAG server. The OMAG server can be started in any OMAG server platform. It does not have to be the same OMAG server platform that created the configuration document.

Figure 3 shows an OMAG server platform with the cdoMetadataRepository local OMAG server running.

Figure 3

Figure 3: Starting a OMAG Server through the operational services

Once the OMAG server has initialized successfully, the open metadata and governance services can route requests to it.

An OMAG server platform can run multiple OMAG servers at one time. Figure 4 shows an OMAG server platform running multiple servers.

Figure 4

Figure 4: An OMAG server platform running multiple OMAG servers

Back to top