Egeria is a large project with many activities adding content to the project. This page provides an overview of the aims of the project and a reflection of where we are today.
Egeria aims to deliver against 6 capability layers:
Support the leadership team for a governance program providing the ability to create governance definitions, subject areas and governance roles and to monitor the success of the governance efforts across the enterprise.
The implementation of a governance solution is focused mainly on the extension of the Egeria UI to support additional roles and functions. They make use of the services provided by the developer platform and may exploit additional content, utilities and connector implementations from the integration platform.
Provides educational resources for different personas and starting points.
Egeria's education aims to broaden the knowledge of people who need to work with digital resources about metadata, governance practices and the use of Egeria. They are It is based around the Coco Pharmaceuticals scenario and are organized by persona, so you can target your learning to your interests.
- The Egeria dojo is a deep dive into the Egeria code and community. It is a good starting point if you wish to learn more about Egeria.
- The Hands-on labs provide practical experiences in running the Egeria code and using the different services.
- The Governance practices provides governance best practices. They aim to guide a team that is setting up or revising their governance program through common governance tasks.
- The Samples are distributed between the egeria.git , egeria-samples.git and egeria-dev-projects.git repositories.
- The edX courses are a new idea to provide a full curriculum and certification for governance professionals and architects. It is in the early phases of design.
Egeria's user interfaces (UIs) provide individuals with access to search, review and update open metadata through a browser-based experience.
- Egeria Ecosystem UI: server and platform configuration, ecosystem monitoring, type explorer and repository explorer.
- Egeria General User UI: data catalog search, glossary browser, lineage explorer.
Supports integration of popular technologies by installing and configuring Egeria. Minimal coding is still required around unusual and home-grown tools and technologies.
- Utilities and converters: support for different standard formats to load industry standard definitions, models, glossaries, and other content packs built on industry standard definitions, models, glossaries and other content packs. Examples include JSON-LD, OWL/RDF, XML, ...
- Pre-canned connectors to third party technologies: popular metadata repositories, databases, data formats and platforms; data movement engines, data virtualization engines, dev ops tools, analytics/AI tools, data catalogs, MDM and user directories, CMDBs, SDLC tools, ...
- Conformance test suite: Supports the testing of third party connectors. Each type of connector or service is supported by its own test workbench.
Provides frameworks, APIs, and hosting platforms for building an integrated metadata and distributed governance solutions.
The developer platform contains the core Egeria implementation and provides support for integrating third party technology into the open metadata ecosystem and extending Egeria to run in different environments or to use different infrastructure services.
Its use is described in the developer's guide.
Open Metadata and Governance (OMAG) registered services are dynamically loaded in the OMAG Server Platform. This means they can be added and removed as needed to create a customized platform. This may include registered services written by the Egeria community and supplied by third parties.
- Access services provide specialist APIs / events for different types of tools. They work with the pre-defined open metadata types and use the repository services to access metadata.
- Engine services provide the services that host a specific type of governance engine. The governance engines collectively provide active governance to the assets and their associated metadata.
- Integration services each provide a specialized API to integration connectors. These are hosted in an integration daemon. The purpose of the integration services is to simplify the implementation and management of connectors that integrate metadata exchange with third party technologies.
- View services provide the services used by UIs. They are typically fine-grained services and they run in the view server. The use of the separate server (and server platform) enables an extra firewall to be erected between the view servers and the metadata servers and governance servers, hiding the internal systems from end users.
The open metadata types provide definitions for the different types of metadata needed by an organization. The open metadata type system is extendable; however, by providing a comprehensive starter set, and encouraging tools to use them, Egeria ensures metadata can be seamlessly shared amongst them.
- The framework services provide Egeria clients to support metadata retrieval for connectors defined by the frameworks.
- The platform chassis uses Spring Boot to provide the web server and REST API support for the platform.
- The administration services supports configuring the OMAG Platform and Servers. Details of how to use the admin services are provided in the administration guide
- The platform services provide the means to start, stop and query the OMAG Servers and services running on an OMAG Server Platform.
- The multi-tenancy management module supports multiple OMAG Servers running on an OMAG Server Platform.
- The repository services provide the basic ability to share metadata between metadata repositories. The metadata repositories are organized into open metadata repository cohorts. These cohorts define the scope of the metadata sharing and ensure metadata is available to all consumers within the cohort.
- The metadata security module provides customizable authorization checks for calls to the OMAG Server Platform, OMAG Server and the open metadata instances themselves.
- A governance server makes use of open metadata to actively manage an aspect of the digital landscape. The governance server services each provide the principle subsystem of a type of governance server.
- The generic handlers provide support for the type specific maintenance and retrieval of metadata that follows the open metadata types. This includes managing visibility of metadata through the Governance Zones, calls to Open Metadata Security and metadata management using templates.
The open metadata frameworks define the interfaces implemented by components that "plug-in" to Egeria, either to integrate calls to third party technology or extend the function of Egeria. The frameworks are as follows:
Audit Log Framework (ALF) - extensions for all types of connectors to enable natural language diagnostics such as exceptions and audit log messages.
- Open Connector Framework (OCF) - base framework for all types of plug-in components called connectors.
- Open Integration Framework (OIF) - specialized connectors for metadata exchange and synchronization with third party technologies.
- Open Discovery Framework (ODF) - specialized connectors called discovery services that support automated metadata discovery,
- Governance Action Framework (GAF) - specialized connectors for the triage and remediation of issues found in the digital landscape.
Aim to simplify the process of deploying the OMAG Server Platform and its connectors into an operational environment.
- The Egeria docker image is built daily and pushed to Quay.io. It contains an OMAG Server Platform. You can download it and use it in your own container environments. It is used by the helm charts.
- The Kubernetes Helm charts make use of the docker image to create a rich Egeria deployment used in the open metadata labs.
- The Kubernetes operators are in development. They will provide an easy way to control an Egeria deployment running on Kubernetes.
Support for docker compose was removed in release 3.5.
Understanding the roadmap¶
Following is an overview of the content status of the functions in Egeria's latest release.
As you can see, some progress has been made on all layers. However, since they do build on one another, most of the early work has been focused on establishing the frameworks, connector APIs and other services to provide the developer platform. The developer platform provides the libraries and interfaces to build connectors to integrate third party tools along with the runtime to host these connectors and manage the metadata exchange.
Today we have a robust OMAG Server Platform and the ability to configure OMAG Servers that host specific types of connectors to third party tools. The continual development of the registered services is broadening the types of metadata, and tools, that can integrate with Egeria through the federated query mechanism that
The initial implementation of Egeria focused on the Open Metadata Repository Services (OMRS) to support different types of metadata repositories exchanging metadata via an open metadata repository cohort. This also involved the build out of the OMAG Server Platform to host this code. The aim was to demonstrate how third party metadata servers could exchange metadata. This capability was delivered along with two repository connectors for the following third party connectors along with the Conformance Test Suite.
Through 2020, our focus shifted to the integration platform as we added connector implementations for popular third party technologies (see the connector catalog) and built out the ecosystem user interface (UI) that enables an organization to:
- configure OMAG Servers on OMAG Server Platforms
- visualize the open metadata types through the type explorer (TEX)
- visualize open metadata instances in a single repository or across the open metadata repository cohorts that a server is connected to.
- visualize to cohort and query the operational status of the OMAG Servers and services operating in the open metadata ecosystem
- configure OMAG Servers and deploy them to OMAG Server Platforms
The ecosystem UI makes calls to specialized REST services supported by a type of OMAG Server called the view server. The view server is new for 2020 and enables the REST APIs to the UIs to be deployed in a DMZ and the metadata servers to be behind an additional firewall. It also takes much of the load for supporting end users off of the metadata servers.
In 2020 support for a new type of OMAG Server called the integration daemon was also added. This server supports integration services that can host integration connectors dedicated to exchanging metadata with specific third party technologies.
This new website was added to the project in 2021, and it has resulted in more interest in consuming Egeria.
2022 continued the focus on metadata governance. The following OMASs were refactored to call the generic handlers rather than direct calls to the repository handler.
There was investment in both the function and performance of the generic handlers, which provide many of the metadata governance functions supported by all OMASs, such as metadata security, provenance validation, anchor management, LatestChange classifications, effectivity dating, memento management and deduplicating query results.
Integration with third party technologies made good progress with the addition of OpenLineage support, the new JDBC, Hive Metastore, schema registry, OpenAPI Specification and Apache Kafka connectors.
Support for the governance solutions naturally follows along, building on the two lower levels. The governance solutions themselves complement specific metadata and governance solutions available in the market today. Egeria is focused on filling in the gaps to support individuals that are setting up and running an open metadata ecosystem and wish to take advantage of the enterprise perspective it brings.
The first solution is Historical Lineage Exploration. This was made available as a tech preview in late 2020. This provides a user interface for finding assets and viewing their lineage along with a dedicated governance server called the open lineage server.
Next will be the Subject Area Management solution and Duplicate Metadata Management, closely followed by the others in 2023 and beyond.
Raise an issue or comment below