Leveraging Egeria's runtime¶

The solution for your Egeria infrastructure is contained in the Egeria Content Pack. It makes use of its own services to ensure that Egeria's operation is observable and manageable. The heart of the solution is the OMAGServerPlatformCataloguer. This integration connector maintains an open metadata representation of the configuration and status of the OMAG Server Platforms and the OMAG Servers they host. These definitions, and the reference data also contained in the content pack, are used by the Runtime Manager API to access live status from the runtime.

---
title: Components and Roles for Solution Blueprint - Egeria Content Pack [4d033711-0449-4d67-bf98-c7bfcae86b8c]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

subgraph 1 [Components and Actors]
2@{ shape: subproc, label: "*Solution Component*
**Configure the OMAG Server Platform Cataloguer**"}
3@{ shape: rect, label: "*Solution Component*
**OMAG Server Platform**"}
4@{ shape: subproc, label: "*Solution Component*
**Delete OMAG Server Platform from Open Metadata**"}
5@{ shape: div-rect, label: "*Solution Component*
**OMAG Server Platform Cataloguer**"}
6@{ shape: subproc, label: "*Solution Component*
**Create OMAG Server Platform in Open Metadata**"}
7@{ shape: rect, label: "*Solution Component*
**Metadata Access Store**"}
8@{ shape: trap-t, label: "*Solution Actor Role*
**Open Metadata User**"}
8==>|"requests,
[Solution Component Actor]"|2
2==>|"configures,
[Solution Linking Wire]"|5
5==>|"Catalog Resource,
[Solution Linking Wire]"|3
8==>|"requests,
[Solution Component Actor]"|4
4==>|"metadata,
[Solution Linking Wire]"|7
5==>|"metadata,
[Solution Linking Wire]"|7
8==>|"requests,
[Solution Component Actor]"|6
6==>|"metadata,
[Solution Linking Wire]"|7
end
style 1 color:#FFFFFF, fill:#3079ab, stroke:#000000
style 2 color:#000000, fill:#DDA0DD, stroke:#000000
style 3 color:#000000, fill:#DDA0DD, stroke:#000000
style 4 color:#000000, fill:#DDA0DD, stroke:#000000
style 5 color:#000000, fill:#DDA0DD, stroke:#000000
style 6 color:#000000, fill:#DDA0DD, stroke:#000000
style 7 color:#000000, fill:#DDA0DD, stroke:#000000
style 8 color:#000000, fill:#FFE599, stroke:#000000
click 2 "https://egeria-project.org/concepts/governance-action-type/" "Click for more documentation" _blank
click 3 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/governance-action-type/" "Click for more documentation" _blank
click 5 "https://egeria-project.org/concepts/integration-connector/" "Click for more documentation" _blank
click 6 "https://egeria-project.org/concepts/governance-action-type/" "Click for more documentation" _blank
click 7 "https://egeria-project.org/concepts/metadata-access-store/" "Click for more documentation" _blank

Egeria Content Pack: Solution blueprint containing integration connectors for working with Egeria''s infrastructure. (Extracted from 6.0-SNAPSHOT)

OMAG Server Platform Cataloguer¶

When the Egeria Content Pack is loaded into a metadata access store, the OMAG Server Platform Cataloguer is automatically started in a connected Integration Daemon. Its first act is to extract details of the platform supporting its metadata access store, create an open metadata representation of the platform with a connection, and attach it to itself as a catalog target. This means that it will regularly check the configuration and status of that platform and maintain the open metadata representation of it. Additional platforms can be created and attached as required. A platform can be deleted from open metadata to stop the cataloguing process.

The open metadata created by the OMAG Server Platform Cataloguer is pretty comprehensive. The diagram below summarizes the platform description for the Quickstart Environment.

---
title: SoftwareServerPlatform - OMAG Server Platform [81c3cbcf-f354-47c8-a868-c5cf161cec2d]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

1@{ shape: rounded, label: "*Software Server Platform*
**OMAG Server Platform**"}
2@{ shape: card, label: "*Software Server Platform [Template]*
**~ {platformName} ~**"}
1==>|"Sourced From"|2
3@{ shape: rounded, label: "*Endpoint*
**Local OMAG Server Platform endpoint**"}
1==>|"Server Endpoint"|3
4@{ shape: hex, label: "*Software Server*
**qs-view-server on https:/ /localhost:9443**"}
4==>|"Deployed On"|1
5@{ shape: hex, label: "*Software Server*
**qs-integration-daemon on https:/ /localhost:9443**"}
5==>|"Deployed On"|1
6@{ shape: hex, label: "*Software Server*
**qs-engine-host on https:/ /localhost:9443**"}
6==>|"Deployed On"|1
7@{ shape: hex, label: "*Software Server*
**qs-metadata-store on https:/ /localhost:9443**"}
7==>|"Deployed On"|1
8@{ shape: rounded, label: "*User Authentication Manager*
**User Token Manager**"}
1==>|"Supported Software Capability"|8
9@{ shape: rounded, label: "*Virtual Connection*
**Local OMAG Server Platform connection**"}
1==>|"Asset Connection"|9
10@{ shape: rounded, label: "*Connection*
**Local OMAG Server Platform secrets store connection**"}
9==>|"restAPIBearerToken [Embedded Connection]"|10
11@{ shape: rounded, label: "*Connector Type*
**YAML File Secrets Store Connector**"}
10==>|"Connection Connector Type"|11
12@{ shape: rounded, label: "*Endpoint*
**Local OMAG Server Platform secret store endpoint**"}
10==>|"Connect To Endpoint"|12
13@{ shape: rounded, label: "*Connector Type*
**OMAG Server Platform Connector**"}
9==>|"Connection Connector Type"|13
9==>|"Connect To Endpoint"|3
14@{ shape: rect, label: "*Solution Component*
**OMAG Server Platform**"}
14==>|"running instance [Implemented By]"|1
style 11 color:#000000, fill:#39add1, stroke:#004563
style 12 color:#000000, fill:#39add1, stroke:#004563
style 13 color:#000000, fill:#39add1, stroke:#004563
style 14 color:#000000, fill:#DDA0DD, stroke:#000000
style 1 color:#000000, fill:#e0ab18, stroke:#004563
style 2 color:#004563, fill:#b0e0e6, stroke:#004563
style 3 color:#000000, fill:#39add1, stroke:#004563
style 4 color:#000000, fill:#BDB76B, stroke:#004563
style 5 color:#000000, fill:#BDB76B, stroke:#004563
style 6 color:#000000, fill:#BDB76B, stroke:#004563
style 7 color:#000000, fill:#BDB76B, stroke:#004563
style 8 color:#000000, fill:#39add1, stroke:#004563
style 9 color:#000000, fill:#39add1, stroke:#004563
style 10 color:#000000, fill:#39add1, stroke:#004563
click 1 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank
click 14 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/view-server/" "Click for more documentation" _blank
click 5 "https://egeria-project.org/concepts/integration-daemon/" "Click for more documentation" _blank
click 6 "https://egeria-project.org/concepts/engine-host/" "Click for more documentation" _blank
click 7 "https://egeria-project.org/concepts/metadata-access-store/" "Click for more documentation" _blank

OMAG Server Platform: Egeria services that provide metadata, context and insight interoperability between people, tools and platforms. (Extracted from 6.0-SNAPSHOT)

And these are the server descriptions:

---
title: SoftwareServer - qs-view-server on https://localhost:9443 [daf73d8f-c529-4d07-addb-488c49d86003]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

1@{ shape: rounded, label: "*Software Server*
**qs-view-server on https:/ /localhost:9443**"}
2@{ shape: card, label: "*Software Server [Template]*
**~ {serverName} ~**"}
1==>|"Sourced From"|2
3@{ shape: rounded, label: "*Endpoint*
**qs-view-server endpoint**"}
1==>|"Server Endpoint"|3
4@{ shape: hex, label: "*Software Server Platform*
**OMAG Server Platform**"}
1==>|"Deployed On"|4
5@{ shape: rounded, label: "*A P I Manager*
**Open Metadata and Governance End User APIs**"}
1==>|"Supported Software Capability"|5
6@{ shape: rounded, label: "*Virtual Connection*
**qs-view-server connection**"}
1==>|"Asset Connection"|6
7@{ shape: rounded, label: "*Connection*
**qs-view-server secrets store connection**"}
6==>|"restAPIBearerToken [Embedded Connection]"|7
8@{ shape: rounded, label: "*Connector Type*
**YAML File Secrets Store Connector**"}
7==>|"Connection Connector Type"|8
9@{ shape: rounded, label: "*Endpoint*
**qs-view-server secret store endpoint**"}
7==>|"Connect To Endpoint"|9
10@{ shape: rounded, label: "*Connector Type*
**View Server Connector**"}
6==>|"Connection Connector Type"|10
6==>|"Connect To Endpoint"|3
11@{ shape: rect, label: "*Solution Component*
**View Server**"}
11==>|"running instance [Implemented By]"|1
12@{ shape: cyl, label: "*Topic*
**egeria.omag.egeria.omag.server.quickstart.ffdc.audit-logs**"}
1==>|"audit log events [Data Flow]"|12
style 11 color:#000000, fill:#DDA0DD, stroke:#000000
style 1 color:#000000, fill:#e0ab18, stroke:#004563
style 12 color:#000000, fill:#BDB76B, stroke:#004563
style 2 color:#004563, fill:#b0e0e6, stroke:#004563
style 3 color:#000000, fill:#39add1, stroke:#004563
style 4 color:#000000, fill:#BDB76B, stroke:#004563
style 5 color:#000000, fill:#39add1, stroke:#004563
style 6 color:#000000, fill:#39add1, stroke:#004563
style 7 color:#000000, fill:#39add1, stroke:#004563
style 8 color:#000000, fill:#39add1, stroke:#004563
style 9 color:#000000, fill:#39add1, stroke:#004563
style 10 color:#000000, fill:#39add1, stroke:#004563
click 11 "https://egeria-project.org/concepts/metadata-access-server/" "Click for more documentation" _blank
click 1 "https://egeria-project.org/concepts/view-server/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank

qs-view-server on https://localhost:9443: A server that supplies REST API endpoints for User Interfaces and non-Java environments such as Python. (Extracted from 6.0-SNAPSHOT)

---
title: SoftwareServer - qs-metadata-store on https://localhost:9443 [9f871549-1b82-45da-a146-319dd8164943]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

1@{ shape: rounded, label: "*Software Server*
**qs-metadata-store on https:/ /localhost:9443**"}
2@{ shape: card, label: "*Software Server [Template]*
**~ {serverName} ~**"}
1==>|"Sourced From"|2
3@{ shape: rounded, label: "*Endpoint*
**qs-metadata-store endpoint**"}
1==>|"Server Endpoint"|3
4@{ shape: hex, label: "*Software Server Platform*
**OMAG Server Platform**"}
1==>|"Deployed On"|4
5@{ shape: rounded, label: "*A P I Manager*
**Open Metadata Repository Access APIs**"}
1==>|"Supported Software Capability"|5
6@{ shape: rounded, label: "*Inventory Catalog*
**Local repository capability for server qs-metadata-store.**"}
1==>|"Supported Software Capability"|6
7@{ shape: rounded, label: "*Virtual Connection*
**qs-metadata-store connection**"}
1==>|"Asset Connection"|7
8@{ shape: rounded, label: "*Connection*
**qs-metadata-store secrets store connection**"}
7==>|"restAPIBearerToken [Embedded Connection]"|8
9@{ shape: rounded, label: "*Connector Type*
**YAML File Secrets Store Connector**"}
8==>|"Connection Connector Type"|9
10@{ shape: rounded, label: "*Endpoint*
**qs-metadata-store secret store endpoint**"}
8==>|"Connect To Endpoint"|10
11@{ shape: rounded, label: "*Connector Type*
**Metadata Access Server Connector**"}
7==>|"Connection Connector Type"|11
7==>|"Connect To Endpoint"|3
12@{ shape: rect, label: "*Solution Component*
**Metadata Access Store**"}
12==>|"running instance [Implemented By]"|1
style 11 color:#000000, fill:#39add1, stroke:#004563
style 1 color:#000000, fill:#e0ab18, stroke:#004563
style 12 color:#000000, fill:#DDA0DD, stroke:#000000
style 2 color:#004563, fill:#b0e0e6, stroke:#004563
style 3 color:#000000, fill:#39add1, stroke:#004563
style 4 color:#000000, fill:#BDB76B, stroke:#004563
style 5 color:#000000, fill:#39add1, stroke:#004563
style 6 color:#000000, fill:#39add1, stroke:#004563
style 7 color:#000000, fill:#39add1, stroke:#004563
style 8 color:#000000, fill:#39add1, stroke:#004563
style 9 color:#000000, fill:#39add1, stroke:#004563
style 10 color:#000000, fill:#39add1, stroke:#004563
click 1 "https://egeria-project.org/concepts/metadata-access-store/" "Click for more documentation" _blank
click 12 "https://egeria-project.org/concepts/metadata-access-store/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank

qs-metadata-store on https://localhost:9443: A metadata store that supports Open Metadata Access Services (OMASs) with event notifications. It provides metadata to qs-view-server, qs-engine-host and qs-integration-daemon. (Extracted from 6.0-SNAPSHOT)

---
title: SoftwareServer - qs-integration-daemon on https://localhost:9443 [1beff5ee-7322-4d40-b2c3-d308f6d0c806]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

1@{ shape: rounded, label: "*Software Server*
**qs-integration-daemon on https:/ /localhost:9443**"}
2@{ shape: card, label: "*Software Server [Template]*
**~ {serverName} ~**"}
1==>|"Sourced From"|2
3@{ shape: rounded, label: "*Endpoint*
**qs-integration-daemon endpoint**"}
1==>|"Server Endpoint"|3
4@{ shape: hex, label: "*Software Server Platform*
**OMAG Server Platform**"}
1==>|"Deployed On"|4
5@{ shape: rounded, label: "*Integration Group*
**PostgreSQLIntegrationGroup**"}
1==>|"Supported Software Capability"|5
6@{ shape: rounded, label: "*Integration Group*
**EgeriaIntegrationGroup**"}
1==>|"Supported Software Capability"|6
7@{ shape: rounded, label: "*Integration Group*
**DefaultIntegrationGroup**"}
1==>|"Supported Software Capability"|7
8@{ shape: rounded, label: "*A P I Manager*
**Integration Connector Status APIs**"}
1==>|"Supported Software Capability"|8
9@{ shape: rounded, label: "*Integration Group*
**JacquardIntegrationGroup**"}
1==>|"Supported Software Capability"|9
10@{ shape: rounded, label: "*Integration Group*
**FilesIntegrationGroup**"}
1==>|"Supported Software Capability"|10
11@{ shape: stadium, label: "*Supported Software Capability*
**... plus 6 Items**"}
1-.->11
12@{ shape: rounded, label: "*Virtual Connection*
**qs-integration-daemon connection**"}
1==>|"Asset Connection"|12
13@{ shape: rounded, label: "*Connection*
**qs-integration-daemon secrets store connection**"}
12==>|"restAPIBearerToken [Embedded Connection]"|13
14@{ shape: rounded, label: "*Connector Type*
**YAML File Secrets Store Connector**"}
13==>|"Connection Connector Type"|14
15@{ shape: rounded, label: "*Endpoint*
**qs-integration-daemon secret store endpoint**"}
13==>|"Connect To Endpoint"|15
16@{ shape: rounded, label: "*Connector Type*
**Integration Daemon Connector**"}
12==>|"Connection Connector Type"|16
12==>|"Connect To Endpoint"|3
17@{ shape: rect, label: "*Solution Component*
**Integration Daemon**"}
17==>|"running instance [Implemented By]"|1
style 11 color:#000000, fill:#F9F7ED, stroke:#b7c0c7
style 12 color:#000000, fill:#39add1, stroke:#004563
style 13 color:#000000, fill:#39add1, stroke:#004563
style 14 color:#000000, fill:#39add1, stroke:#004563
style 15 color:#000000, fill:#39add1, stroke:#004563
style 16 color:#000000, fill:#39add1, stroke:#004563
style 17 color:#000000, fill:#DDA0DD, stroke:#000000
style 1 color:#000000, fill:#e0ab18, stroke:#004563
style 2 color:#004563, fill:#b0e0e6, stroke:#004563
style 3 color:#000000, fill:#39add1, stroke:#004563
style 4 color:#000000, fill:#BDB76B, stroke:#004563
style 5 color:#000000, fill:#39add1, stroke:#004563
style 6 color:#000000, fill:#39add1, stroke:#004563
style 7 color:#000000, fill:#39add1, stroke:#004563
style 8 color:#000000, fill:#39add1, stroke:#004563
style 9 color:#000000, fill:#39add1, stroke:#004563
style 10 color:#000000, fill:#39add1, stroke:#004563
click 1 "https://egeria-project.org/concepts/integration-daemon/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank
click 17 "https://egeria-project.org/concepts/integration-daemon/" "Click for more documentation" _blank

qs-integration-daemon on https://localhost:9443: A server that runs integration connectors that synchronize and exchange metadata with different types of technologies and tools. (Extracted from 6.0-SNAPSHOT)

---
title: SoftwareServer - qs-engine-host on https://localhost:9443 [ad47bd46-b720-4550-b9ef-e37ddaccc08b]
---
flowchart TD
%%{init: {"flowchart": {"htmlLabels": false}} }%%

1@{ shape: rounded, label: "*Software Server*
**qs-engine-host on https:/ /localhost:9443**"}
2@{ shape: card, label: "*Software Server [Template]*
**~ {serverName} ~**"}
1==>|"Sourced From"|2
3@{ shape: rounded, label: "*Endpoint*
**qs-engine-host endpoint**"}
1==>|"Server Endpoint"|3
4@{ shape: hex, label: "*Software Server Platform*
**OMAG Server Platform**"}
1==>|"Deployed On"|4
5@{ shape: rounded, label: "*Governance Action Engine*
**Metadata Observability Governance Engine**"}
1==>|"Supported Software Capability"|5
6@{ shape: rounded, label: "*Governance Action Engine*
**Unity Catalog Governance Engine**"}
1==>|"Supported Software Capability"|6
7@{ shape: rounded, label: "*Survey Action Engine*
**Unity Catalog Survey Engine**"}
1==>|"Supported Software Capability"|7
8@{ shape: rounded, label: "*Governance Action Engine*
**Apache Kafka Governance Engine**"}
1==>|"Supported Software Capability"|8
9@{ shape: rounded, label: "*Governance Action Engine*
**Apache Atlas Governance Engine**"}
1==>|"Supported Software Capability"|9
10@{ shape: rounded, label: "*Watchdog Action Engine*
**Egeria Watchdog Engine**"}
1==>|"Supported Software Capability"|10
11@{ shape: stadium, label: "*Supported Software Capability*
**... plus 11 Items**"}
1-.->11
12@{ shape: rounded, label: "*Virtual Connection*
**qs-engine-host connection**"}
1==>|"Asset Connection"|12
13@{ shape: rounded, label: "*Connection*
**qs-engine-host secrets store connection**"}
12==>|"restAPIBearerToken [Embedded Connection]"|13
14@{ shape: rounded, label: "*Connector Type*
**YAML File Secrets Store Connector**"}
13==>|"Connection Connector Type"|14
15@{ shape: rounded, label: "*Endpoint*
**qs-engine-host secret store endpoint**"}
13==>|"Connect To Endpoint"|15
16@{ shape: rounded, label: "*Connector Type*
**Engine Host Connector**"}
12==>|"Connection Connector Type"|16
12==>|"Connect To Endpoint"|3
17@{ shape: rect, label: "*Solution Component*
**Engine Host**"}
17==>|"running instance [Implemented By]"|1
style 11 color:#000000, fill:#F9F7ED, stroke:#b7c0c7
style 12 color:#000000, fill:#39add1, stroke:#004563
style 13 color:#000000, fill:#39add1, stroke:#004563
style 14 color:#000000, fill:#39add1, stroke:#004563
style 15 color:#000000, fill:#39add1, stroke:#004563
style 16 color:#000000, fill:#39add1, stroke:#004563
style 17 color:#000000, fill:#DDA0DD, stroke:#000000
style 1 color:#000000, fill:#e0ab18, stroke:#004563
style 2 color:#004563, fill:#b0e0e6, stroke:#004563
style 3 color:#000000, fill:#39add1, stroke:#004563
style 4 color:#000000, fill:#BDB76B, stroke:#004563
style 5 color:#000000, fill:#39add1, stroke:#004563
style 6 color:#000000, fill:#39add1, stroke:#004563
style 7 color:#000000, fill:#39add1, stroke:#004563
style 8 color:#000000, fill:#39add1, stroke:#004563
style 9 color:#000000, fill:#39add1, stroke:#004563
style 10 color:#000000, fill:#39add1, stroke:#004563
click 1 "https://egeria-project.org/concepts/engine-host/" "Click for more documentation" _blank
click 4 "https://egeria-project.org/concepts/omag-server-platform/" "Click for more documentation" _blank
click 17 "https://egeria-project.org/concepts/engine-host/" "Click for more documentation" _blank

qs-engine-host on https://localhost:9443: A server that runs governance service requests, triggered by engine actions created in qs-metadata-store. (Extracted from 6.0-SNAPSHOT)

Raise an issue or comment below