Installing Egeria via IntelliJ

Once you have a successful build and you see:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 04:47 min
[INFO] Finished at: 2022-02-09T08:04:45Z
[INFO] Final Memory: 433M/1474M
[INFO] ------------------------------------------------------------------------

Process finished with exit code 0

Click on the Terminal tab - typically at the bottom of the IntelliJ window to open the terminal window.

Installing Egeria¶

The egeria build process creates the distribution files for Egeria in the open-metadata-distribution/omag-server-platform module. To see its contents, after a full gradle build completes, use the following cd command to change to its build/distributions directory:

cd open-metadata-distribution/omag-server-platform/build/distributions

List the files:

ls

The distribution tar file is egeria-platform-{release}-distribution.tar.gz or egeria-platform-4.3-distribution.tar.gz in this example.

egeria-platform-4.3-distribution.tar.gz

Create a directory for Egeria and copy the tar file into it. The two commands shown below creates a directory in your home directory and then copies the egeria distribution file into it.

mkdir ~/egeria-install

cp egeria*-distribution.tar.gz ~/egeria-install

This next command changes to the new directory.

cd ~/egeria-install

It is now possible to unpack the tar file with the following steps.

gunzip egeria*-distribution.tar.gz

tar -xf egeria*-distribution.tar

A new directory is created called egeria-platform-{release}-distribution.tar.gz or egeria-platform-4.3-distribution.tar.gz in this example. Change to this new directory and list its contents as shown below.

cd egeria*gz

ls

Dockerfile      LICENSE         NOTICE          
README.md       assembly        dist

As before, you may notice different files as Egeria evolves.

The Dockerfile contains the directives to build a docker image. Instructions for doing this are in the README.md file. Change to the assembly directory.

cd assembly

ls

README.md       etc             opt             platform

Under platform is a directory for the OMAG Server Platform that is used to run open metadata and governance services. This is the omag-server-platform-{{release}}.jar.

ls platform

README.md                  data       keystore.p12     logs                            truststore.p12
application.properties     extra      lib              omag-server-platform-4.3.jar

The platform/lib directory is where the jar files for connectors, samples and new registered services are installed. It includes the connectors that are located in the egeria.git repository.

ls platform/lib

README.md                                                       csv-file-connector-4.3.jar                                      jdbc-integration-connector-4.3.jar
apache-atlas-rest-connector-4.3.jar                             data-folder-connector-4.3.jar                                   jdbc-resource-connector-4.3.jar
atlas-integration-connector-4.3.jar                             discovery-service-connectors-4.3.jar                            kafka-integration-connector-4.3.jar
audit-log-console-connector-4.3.jar                             dynamic-archiver-connectors-4.3.jar                             kafka-open-metadata-topic-connector-4.3.jar
audit-log-event-topic-connector-4.3.jar                         elasticsearch-integration-connector-4.3.jar                     omrs-rest-repository-connector-4.3.jar
audit-log-file-connector-4.3.jar                                env-variable-secrets-store-connector-4.3.jar                    open-lineage-janus-connector-4.3.jar
audit-log-slf4j-connector-4.3.jar                               files-integration-connectors-4.3.jar                            open-metadata-archive-directory-connector-4.3.jar
avro-file-connector-4.3.jar                                     governance-action-connectors-4.3.jar                            open-metadata-archive-file-connector-4.3.jar
basic-file-connector-4.3.jar                                    governance-services-sample-4.3.jar                              open-metadata-security-samples-4.3.jar
cohort-registry-file-store-connector-4.3.jar                    graph-repository-connector-jar-with-dependencies-4.3.jar        openapi-integration-connector-4.3.jar
configuration-encrypted-file-store-connector-4.3.jar            inmemory-open-metadata-topic-connector-4.3.jar                  openlineage-integration-connectors-4.3.jar
configuration-file-store-connector-4.3.jar                      inmemory-repository-connector-4.3.jar                           spring-rest-client-connector-4.3.jar

The platform/extra directory is where connectors from other repositories are added (including those that you write yourself). Copy the jar files for any additional connectors you want to use into the extra directory. The connectors available for Egeria are listed in the Connector Catalog.

The opt and etc directories contain additional content that can used with the platform. For example, the etc/reports directory contains java programs that describe different aspects of the platform.

ls etc/reports

README.md       component-id-report.jar         database-report.jar             egeria-platform-report.jar

The opt/content-packs directory contains Open Metadata Archives that provide sample open metadata content. The README.md describes their content.

ls content-packs

APIsContentPack.omarchive                         CocoTypesArchive.omarchive                        OracleContentPack.omarchive
ApacheAtlasContentPack.omarchive                  CoreContentPack.omarchive                         OrganizationInsightContentPack.omarchive
ApacheKafkaContentPack.omarchive                  DB2LUWContentPack.omarchive                       PostgresContentPack.omarchive
CocoBusinessSystemsArchive.omarchive              DuckDBContentPack.omarchive                       README.md
CocoClinicalTrialsTemplatesArchive.omarchive      EgeriaContentPack.omarchive                       SimpleAPICatalog.omarchive
CocoComboArchive.omarchive                        FilesContentPack.omarchive                        SimpleCatalog.omarchive
CocoGovernanceEngineDefinitionsArchive.omarchive  MSSQLContentPack.omarchive                        SimpleDataCatalog.omarchive
CocoGovernanceProgramArchive.omarchive            OpenLineageContentPack.omarchive                  SimpleEventCatalog.omarchive
CocoOrganizationArchive.omarchive                 OpenMetadataDigitalProductsContentPack.omarchive  SimpleGovernanceCatalog.omarchive
CocoSustainabilityArchive.omarchive               OpenMetadataTypes.omarchive                       UnityCatalogContentPack.omarchive

The /opt/sample-data directory contains sample data that is used in various labs and samples.

ls /opt/sample-data/*

opt/sample-data/README.md

opt/sample-data/data-files:
CompDir-ContactEmail.csv        CompDir-ContactPhone.csv        Employee-Dept.csv               Location-WorkLocation.csv
CompDir-ContactList.csv         EmplSAnl-EmpSalaryAnalysis.csv  Employee-Employee.csv           Patient-Patient.csv

opt/sample-data/database:
ibm-db2         mariadb         postgresql

opt/sample-data/oak-dene-drop-foot-weekly-measurements:
week1.csv       week2.csv       week3.csv       week4.csv       week5.csv       week6.csv       week7.csv       week8.csv       week9.csv

Notice that each directory contains a README.md file that explains the content of the directory.