Skip to content

Open Metadata Repository Cohort Operation

An Open Metadata Repository Cohort (or more simply, just a cohort) is a collection of servers sharing metadata using a peer-to-peer exchange. Once a server becomes a member of the cohort, it can share metadata with, and receive metadata from, any other member either through events, or through federated queries.

Formation of a cohort

Cohort membership is established dynamically. This is through the cohort topic(s).

First server

To join an open metadata repository cohort, a server must integrate with the OMRS module. OMRS then manages the metadata exchange. When OMRS running inside the server is configured to join a cohort it first adds a registration event to the cohort topic(s). This event identifies the server, its metadata repository (if any) and its capabilities.

Figure 1

Figure 1: The first server to join the cohort issues a registration request and waits for others to join.

Subsequent servers

When another server joins the cohort, it also adds its registration event to the cohort topic(s) and begins to receive the registration events from other members. The other members respond with re-registration events to ensure the new member has the latest information about the originator's capabilities. The exchange of registration information causes all members to verify that they have the latest information about their peers. This is maintained in their own cohort registry store so that they can reconfigure themselves on restart without needing the other members to resend their registration information.

Figure 2

Figure 2: When another server joins the cohort they exchange registration information.

Peer-to-peer operation

Once the registration information is exchanged and stored in each member's cohort registry store, it is ready to issue federated queries across the cohort, and respond to requests for metadata from other members. These requests can both retrieve metadata and maintain metadata in the home metadata repository.

The management of federated queries and the routing of maintenance requests is managed by OMRS's enterprise repository services. The enterprise repository services are configured with the registration information from across the cohort at the same time as the cohort registry store is updated. This process is managed by the cohort registry.

The registration information includes the URL Root and server name of the member. The federation capability in each member allows it to issue metadata create, update, delete and search requests to each and every member of the cohort.

Figure 3

Figure 3: Once the registration is complete the cohort members can issue federated queries.

Primary mechanism for accessing metadata

This peer-to-peer operation and federated queries are the primary mechanism for accessing metadata, because the access services use federated queries for every request they make for metadata.

Metadata exchange

Once the cohort membership is established, the server begins publishing information using instance events about changes to the home metadata instances in their repository. These events can be used by other members to maintain a cache of reference copies of this metadata to improve availability of the metadata and retrieval performance. Updates to this metadata will, however, be automatically routed to the home repository by the enterprise repository services:

Figure 4

Figure 4: Metadata can also be replicated through the cohort to allow caching for availability and performance.

Metadata refresh

A member may also request that metadata is "refreshed" across the cohort. The originator of the requested metadata then sends the latest version of this metadata to the rest of the cohort through the cohort topic. This mechanism is useful to seed the cache in a new member of the cohort and is invoked as a result of a federated query issued from any cohort member.

Dynamic changes to types

Finally, as type definitions (TypeDefs) are added and updated, the cohort members send out events to allow the other members to verify that this type does not conflict with any of their types. Any conflicts in the types causes audit log messages to be logged in all members, prompting action to resolve the conflicts.

Figure 5

Figure 5: TypeDef validation.

Leaving the cohort

When an OMAG Server permanently leaves the cohort, it sends an unregistration request. This enables the other members to remove the parting member from their registries.

Enabling cohort membership

Egeria provides a number of pre-built cohort members.

One of them, the repository proxy provides a simple way to integrate a third party server into a cohort by creating an OMRS Repository Connector and optional Event Mapper Connector to map between the third party APIs/events and the repository service's equivalents

A more bespoke integration involves:

  • Creating an OMRS repository connector and optional event mapper connector
  • Designing how to configure the OMRS Services for your metadata repository. Typically, this is done by extending the existing administration services of the metadata repository, but Egeria also offers some pre-built administration services that can be used or modified.
  • Plugging the OMRS and any administration services into the metadata repository's security module so that requests to the server can be secured against unauthorized access.
  • Integrating the OMRS, administration and security capability into your product.

There are different integration patterns available to help you choose the best approach for your product. Each method is optimized for specific use cases and so the metadata repository can only play a full role in the open metadata use cases if it supports all integration methods. These are:

  • Support for an OMRS repository connector to allow open metadata API calls to the repository to create, query, update and delete metadata stored in the repository.
    • The OMRS connectors support the Open Connector Framework (OCF) to provide a call interface to the metadata repositories.
    • The OMRS Repository Connector API is a standard interface for all metadata repositories. This enables services such as the Enterprise OMRS Repository Connector to interact with 1 or many metadata repositories through the same interface.
    • The connection configuration it passes to the OCF determines which type of OMRS connector is returned by the OCF.
  • Support for the OMRS event notifications that are used to synchronize selective metadata between the metadata repositories.

Cohort members

A cohort member is an OMAG Server that is registered with at least one open metadata repository cohort.

Different types of cohort members

Management of a server's membership is handled by the cohort services.

The exchange of metadata uses the Open Metadata Repository Services (OMRS) interfaces which gives fine-grained1 metadata notifications and updates. During server start up, the repository services detect the configuration of at least one cohort and starts the metadata highway manager. The metadata highway manager creates a cohort manager for each cohort configuration. The cohort manager manages the initialization and shutdown of the server's connectivity to a cohort, including the management of the cohort registry.

The server's metadata security connector provides fine-grained control on which metadata is sent, received and/or stored by the server. This level of control is necessary for metadata repositories that are managing specific collections of valuable metadata such as Assets.

The types of cohort members include:

Explore hands-on

The administration hands-on lab called "Understanding Cohort Configuration Lab" provides an opportunity to query the cohort registries of cohort members as they exchange metadata for Coco Pharmaceuticals.

Cohort registration

Each repository in the cohort has a cohort registry that supports the registration of the metadata repositories across the cohort. Through the registration process, each cohort registry assembles a list of all members of the cohort. This is saved in the cohort registry store.

The list of connections to the remote members of the cohort are passed to the OMRS Enterprise Connector Manager that in turn manages the configuration of the Enterprise OMRS Repository Connectors. The Enterprise OMRS Connector provides federated query support across the metadata cohort for the Open Metadata Access Services (OMAS).

When a metadata repository registers with the cohort registry, the administrator may either supply a unique server identifier, or ask the OMRS to generate one. This server identifier (the metadata collection id) is used in the OMRS event notifications, and on OMRS repository connector calls to identify the location of the home copy of the metadata entities and to identify which repository is requesting a service or supports a particular function.

Once the metadata repository has registered with the cohort registry, it is a member of the metadata repository cohort and can synchronize and share metadata with other repositories in the cohort through the cohort topic(s).

Registering with multiple cohorts

A single metadata repository can register with multiple metadata cohorts as long as its server identifier is unique across all cohorts that it joins and it manages the posting of events to the appropriate OMRS topic for each cohort it registers with.

This capability is useful for a metadata repository that is aggregating reference copies of metadata from multiple open metadata repository cohorts.

Cohort registry

The cohort registry resides in each cohort member. It is responsible for registering a member with a specific open metadata repository cohort and maintaining a list of the other members of this cohort.

The registration process is managed by exchanging registry events over the cohort topic(s).

The cohort registry maintains its record of the membership of the cohort in a cohort registry store.

Federated queries

A federated query combines metadata retrieved from all members of the connected cohorts.

Federated Query

Federated query visiting the local repository and then calling all other servers connected via the cohort(s).

The list of servers that are called by a federated query is built dynamically from the cohort registration request events. These events take information from the configuration document for the server.

Configuring the local repository for federated queries

In the Local Repository section of the configuration document are two connections:

Local Repository Configuration

Configuration document showing the both the local and remote connections for the local repository in a metadata access store or repository proxy. In a metadata access point, both connections are null. In a metadata access store that does not support federated queries, LocalRepositoryRemoteConnection is null.

The LocalRepositoryRemoteConnection is sent to the other cohort members in the registration request events. The default value specifies the OMRS REST Repository Connector as the remote repository connector.

Default Remote Repository Connector

The default remote-repository connector is a REST API client for the Repository REST API supported by Egeria OMAG Server Platform.

When the registration request is accepted, the receiving system uses the LocalRepositoryRemoteConnection to configure the remote repository connector in the Enterprise Repository Connector from the enterprise repository services that is responsible for executing the federated queries.

Enterprise Repository Connector

The remote repository connectors are established dynamically in the enterprise repository connector using information from the registration events.

Making federated queries

Whenever an Open Metadata Access Service (OMAS) is called, it uses the enterprise repository connector to create, retrieve, update and delete metadata.

The operation of the enterprise repository connector depends on the type of request. When metadata is retrieved, the request is passed to all connected repositories and the results are combined.

Retrieve federated query operation

When metadata is retrieved, the enterprise repository connector calls the local repository and each of the registered remote repositories. The metadata returned is combined and passed to caller.

Updates and deletes are targeted to the home repository of the instance. The metadata collection identifier of the home repository is encoded in the header of the metadata instance. This identifier is also known to each of the remote repository connectors, so it is possible to match the instance with its home repository.

Home Metadata Collection

The home metadata collection is identified in the header of each metadata element.

When the home repository makes the change to the instance, it sends an event with the latest version of the instance to the rest of the cohort.

Create requests are passed first to the local repository, and if it can not support the requested type of metadata, then the enterprise repository connector tries each of the remote repository connectors until one of them returns to say that the new instance is created.

Whichever repository created the instance, becomes that instance's home repository, and it sends out an event to the rest of the cohort to announce that the new instance is available.

  1. You may want to see the OMRS metamodel for more details on the granularity of metadata exchange.