Skip to content

Using Egeria

Egeria's guides provide practical guidance on different aspects of using Egeria in your organization. As a technology, Egeria has a lot of features and these are explained along with information about each feature's business value and how to incorporate it in your organization. Using Egeria should enable your organization to change the way it works, by improving the collaboration and shared understanding of your data and digital resources.

Ready to run Egeria?

Egeria Workspaces is the best way to run Egeria if you are new to this technology. It offers a preconfigured, containerized environment that you can quickly download and run. Once running, Egeria workspaces offers a Jupyter, command line and a Markdown environment for activating Egeria's governance solutions and configuring them to work with your organization's digital resources. There is also a web server, Apache Kafka Event Bus, an Open Lineage Proxy and a PostgreSQL server to play with.

Each major capability of Egeria is demonstrated through Jupyter Notebooks, helping you to understand and apply Egeria to your organization's needs as quickly as possible. As you become familiar with Egeria, you can activate additional runtimes such as Unity Catalog, Apache Atlas, Apache Airflow and Apache Superset to make use of the integration between Egeria and these runtimes.

In addition to Egeria Workspaces:

  • User Interfaces - Illustrates different types of user interaction styles available in Egeria.
  • Features - Provides a detailed guide to the governance features of Egeria.

  • Planning Guide - The planning guide describes how to plan your Egeria installation and the development of the metadata definitions that will drive its use. Part of this planning process makes use of the following catalogs:

    • Content Pack Catalog - the content pack catalog provides detailed information about the content packs available for Egeria. These content pack provide metadata to bootstrap your deployment.
    • Connector Catalog - the connector catalog provides a list of connectors available for Egeria.
    • Template Catalog - details of the cataloguing templates prebuild in Egeria.

  • Integration Guide - the integration guides describes how to set up integrations between Egeria and third party technologies. It also makes use of the content packs and connector catalogs.

  • Administration Guide - the administration guide describes how to mange Egeria's configuration.
  • Migration Guide - Egeria strives to maintain compatibility of APIs and file formats from release to release. The migration guide covers techniques to migrate aspects of Egeria where compatibility between releases was not possible..
  • Operations Guide - Describes commands to control and monitor an Egeria deployment.
  • Diagnostic Guide - Problem determination methods and guidance.
  • Developer Guide - the developer covers how to build connectors, utilities that call Egeria, and open metadata archives.

Raise an issue or comment below