Skip to content
Stable

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Runtime Manager API

he Runtime Manager API enables the caller to retrieve configuration and status from platforms and servers. It is also used to manage the lifecycle of servers, their registration in cohorts and the loading of open metadata archives.

Key Features

Key features of the API include:

  • Platform Management: Retrieving configuration and status (reports) from OMAG Server Platforms.
  • Server Management: Retrieving configuration and status (reports) from OMAG Servers.
  • Server Lifecycle Management: Activating and shutting down OMAG Servers using stored configuration.
  • Cohort Management: Managing open metadata repository cohorts and their members, including connecting, disconnecting, and unregistering servers.
  • Archive Management: Loading open metadata archives into running repositories.
  • Engine and Integration Management: Refreshing configuration for governance engines and integration daemons, and managing integration connectors (configuration properties, endpoints, and connections).
  • Open Lineage Support: Publishing open lineage events to the integration service.

Sample REST API requests can be found in the Egeria-api-runtime-manager.http file. In addition

Further Information

API Overview

The Runtime Manager API is a REST API designed to support user interfaces (UIs) and python environments that work with the Egeria infrastructure to:

  • Display the status of an OMAG Server Platform, and which OMAG Servers are known/active to it.
  • The status of an OMAG Server, its active history and the health of the components running within it.
  • The status of the connectors an OMAG Server is hosting.

It is also able to:

  • Activate/deactivate servers on a platform.

  • For metadata access stores, it can:

  • For integration daemons, it can:

  • Temporarily change integration connector configuration.

  • Restart and refresh integration connectors.
  • Send open lineage events for augmentation, analysis, and distribution through the open metadata ecosystem.

  • Refresh the server's integration group configuration stored in the connected metadata access server.

  • For engine hosts it can:

  • Refresh the server's governance engine configuration stored in the connected metadata access server.

The Runtime Manager API is able to work with any platform (and its hosted servers) that are reachable via REST APIs. The calling user (provided they have sufficient security privileges) is able to work with the platform services, server operation services, integration daemon services and engine-host-services as if they were calling them directly. This allows remote management without needing to expose the back-end platforms' endpoints to the administrative users.

Production Deployment

Egeria's resource connectors

The secret to this service is that it works with Egeria's resource connectors that are responsible for making the calls.

Egeria resource connectors

These resource connectors are accessed via the catalog entries for the platforms and servers. The catalog entries for the OMAG Server Platforms need to be created explicitly.

Raise an issue or comment below