Overview

This directory contains sample Docker Compose scripts to support the deployment of Egeria for experimentation, development, and learning. Rather than having to install Egeria, prerequisites and tools separately, these scripts make it easy to get a stack running quickly. These are not meant for production use. Please see the Planning Guide for more information about designing Egeria deployments. The Egeria community has also created samples for other deployment styles, such as Cloud Native approaches and the use of Helm charts to configure Kubernetes clusters. These options may be better starting points for production deployments - depending upon your requirements. Please feel free to engage with the community on our slack channel - we'd love your feedback and participation.

For a quick and simple environment to explore some of Egeria's base capabilities, the egeria-platform.yml Docker Compose deployment may be a good starting point. Once this script executes successfully, you will have two docker containers running. One for the Egeria platform and one for Kafka. With this running configuration, you can work with any of Egeria's standard interfaces - java APIs, python APIs, or just plain RESTful http calls - and of course, to make use of tools and interfaces that have been built using these APIs.

If you are a data scientist or just want to work within a Jupyter Notebook environment, the egeria-platform-jupyter-compose script adds a Jupyter server pre-configured with the Egeria Python client, pyegeria for you to use. The set of Docker Compose configurations will continue to grow and evolve over time to cover additional scenarios based on community feedback.

Contents

Our first docker compose script is called egeria-platform.yml. After running this script, you will have a running environment that consists of a single Egeria runtime platform and the Apache Kafka event system. Information about configuring Egeria can be found at Configuring Egeria. We use standard, out-of-the-box configurations for both - a minimal amount of configuration for:

Egeria Platform - Default Configuration

We use the Egeria platform docker image - egeria-platform.

• Port - By default the platform uses port 9443 and exposes this port to the host environment, This means that Egeria requests can be made to platform URL https://localhost:9443 or, if your environment is configured to support it, it can use the domain name of your host machine.

• SSL - By default strict SSL is set to false

• Auto-Started Servers - by default a useful set of Egeria Open Metadata and Governance (OMAG) servers are pre-installed and started when the Egeria platform is started. A description of these servers can be found at sample configs:

  • simple-metadata-store
  • active-metadata-store
  • engine-host
  • integration-daemon
  • view-server

• Content Packs - pre-constructed information sets that can be used to configure Egeria and pre-load metadata, reference data and glossary data. See Content Packs.

• Out-of-the-box Connectors - descriptions of the integration connectors can be found at Integration Connectors.

Kafka - configured for Egeria

We use the bitnami/kafka image described at kafka

• Port - We use the default port of 9092 for Kafka. This port is also exposed in the host environment. Changing this port also requires corresponding changes to the Egeria configuration.
• Other configuration can be seen in the egeria-platform.yaml file.

Usage

Follow these steps to use Docker Compose.

1. Install and Configure Docker and Docker Compose.
   • Docker and Docker compose must be installed and running - see https://docs.docker.com/install/
   • Configure docker with at least 6GB memory
2. Download the egeria-platform.yaml
3. Run the docker compose script from a terminal window in the directory where you downloaded egeria-platform.yaml. At the command line issue:

docker compose -f egeria-platform.yaml up

This will download the docker images for Kafka and Egeria, then create and start the two containers. Both kafka and Egeria will then automatically configure themselves. For Egeria, this means not only starting up the initial set of servers, but then loading the CoreContentPack.omarchive into the metadata repository, and then configuring all the servers. This can take several minutes the first time the containers are created. Subsequent startups will be much faster.

4. Using either the docker desktop application or the docker command line you can see the two new containers running. To do this with the docker command line, you can issue:

docker ps

5. The environment is ready to be used.

6. You can control the containers with docker compose commands - see docker compose. These commands can be used to administer and use the docker containers.

Next Steps

Now that your Egeria environment is running and configured it is waiting for you to make requests. Some tutorials for working with Egeria can be found at Tutorials. For those that want to try the new python client, you can find a quick introduction at pyegeria.

As always, your feedback and participation are welcome.

License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.