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?

There are a number of options available to you:

Running Egeria natively on your local machine

The Getting Started with Egeria blog provides a step-by-step guide to building, installing, configuring and running Egeria on your machine.

Running Egeria in IntelliJ

See Setting up IntelliJ to develop components for Egeria.

Running Egeria in Containers

The egeria-workspaces repository provides a choice of configurations of Egeria and related technologies. These deployments are designed for evaluation and test. They provide a running Egeria system plus a JupyterLab environment where it is possible to experiment with Egeria's capability. There are example python notebooks to guide you through the principle capabilities.

  • 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.

  • 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.
  • Features - Provides a detailed guide to the governance features of Egeria.

Raise an issue or comment below