Skip to content

Commit

Permalink
Merge branch 'main' into apistatus
Browse files Browse the repository at this point in the history
  • Loading branch information
mandy-chessell authored Sep 13, 2023
2 parents a7a94f4 + f3ec757 commit 0e8656a
Show file tree
Hide file tree
Showing 179 changed files with 5,512 additions and 2,379 deletions.
4 changes: 4 additions & 0 deletions site/docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@ The Egeria project is highly appreciative of the organizations that support and

Egeria is pleased to announce integration with the following technologies:

* Apache Atlas
* Apache Kafka
* Apache Hive (MetaStore)
* PostgreSQL
* Oracle Database
* DB2
* Files
* OpenLineage
* OpenAPISpecification
Expand Down
1 change: 1 addition & 0 deletions site/docs/concepts/audit-log-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@ The structure is defined by the Audit Log Framework (ALF). The Open Metadata Re
| 12 | `Cohort` | The server is exchanging registration information about an open metadata repository cohort that it is connecting to. |
| 13 | `Trace` | This is additional information on the operation of the server that may be of assistance in debugging a problem. It is not normally logged to any destination, but can be added when needed. |
| 14 | `PerfMon` | This log record contains performance monitoring timing information for specific types of processing. It is not normally logged to any destination, but can be added when needed. |
| 15 | `Activity` | This log record describes the activity of users. It is not normally logged to any destination, but can be added when needed. |
| 0 | `<Unknown>` | Uninitialized Severity |

4 changes: 2 additions & 2 deletions site/docs/concepts/audit-log-record-structure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions site/docs/concepts/omag-server-ecosystem-cts.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion site/docs/concepts/omag-server-ecosystem.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 24 additions & 13 deletions site/docs/concepts/omag-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Most APIs in Egeria require both a [platform URL root](#platform-url-root) and a

## Types of OMAG Server

The function needed to operate the [open metadata ecosystem](/concepts/open-metadata-ecosystem) are organized into different types of [services](/services) that are configured in their own type of OMAG Server. This makes it easier to explain how to set them up and connect them together.
The types of OMAG Server are shown in Figure 1. The hierarchy groups similar types of server together.

![Figure 1](types-of-omag-servers.svg)
Expand All @@ -38,24 +39,34 @@ The types of OMAG Server are shown in Figure 1. The hierarchy groups similar typ

Object-oriented software engineers would know of this type of relationship as behavior inheritance.

- [Cohort member](cohort-member) - able to exchange metadata through an open metadata repository cohort
- [Metadata access store](/concepts/metadata-access-store) - supports a metadata repository that can natively store open metadata types as well as specialized metadata APIs for different types of tools (these APIs are called [access services](/services/omas)).
- [Metadata access point](/concepts/metadata-access-point) - supports the access services like the metadata server but does not have a repository. All metadata it serves up and stores belongs to the metadata repositories in other members of the cohort.
- [Repository proxy](/concepts/repository-proxy) - acts as an open metadata translator for a third party metadata repository. It supports open metadata API calls and translates them to the proprietary APIs of the repository. It also translates events from the proprietary repository into open metadata events that flow over the cohort.
- [Conformance test server](/concepts/conformance-test-server) - validates that a member of the cohort is conforming with the open metadata protocols. This server is typically only seen in development and test cohorts rather than production.
- [View server](/concepts/view-server) - manages specialist services for user interfaces.
- [Cohort Member](cohort-member) - All of these types of servers are optionally able to exchange metadata through an open metadata repository cohort. This is a peer-to-peer metadata exchange for metadata repositories.
- [Metadata Access Store](/concepts/metadata-access-store) - supports a metadata repository that can natively store open metadata along with specialized metadata APIs for different types of tools (these APIs are called [Open Metadata Access Services (OMASs)](/services/omas)).
- [Metadata Access Point](/concepts/metadata-access-point) - supports the OMASs like the metadata access store, but but does not have its own repository. All the metadata it serves up and stores belongs to the metadata repositories in other members of the cohort. This type of server needs to be connected to at least one cohort to be useful.
- [Repository Proxy](/concepts/repository-proxy) - acts as an open metadata translator for a third party metadata repository. It supports open metadata API calls and translates them to the proprietary APIs of the repository. It also translates events from the proprietary repository into open metadata events that flow over the cohort.
- [Conformance Test Server](/concepts/conformance-test-server) - validates that a member of the cohort is conforming with the open metadata protocols. This server is typically only seen in development and test cohorts rather than production.
- [View Server](/concepts/view-server) - manages specialist services for user interfaces.
- [Governance server](/concepts/governance-server) - supports the use of metadata in the broader IT landscape.
- [Engine host](/concepts/engine-host) - provides a runtime for a specific type of [governance engine](/services/omes).
- [Integration daemon](/concepts/integration-daemon) - manages the synchronization with third party technology that can not call the access services directly through the [integration services](/services/omis).
- [Data engine proxy](/concepts/data-engine-proxy) - supports the capture of metadata from a data engine. This includes details of the processing of data that it is doing which is valuable when piecing together lineage.
- [Open lineage server](/concepts/open-lineage-server) - Manages the collation of lineage information am maintains it in a format for reporting. This includes the state of the lineage at different points in time.
- [Engine Host](/concepts/engine-host) - provides a runtime for a specific type of [governance engine](/concepts/governance-engine) that runs [governance services](/concepts/governance-service) to monitor, enhance and govern the open metadata ecosystem.
- [Integration Daemon](/concepts/integration-daemon) - manages the synchronization of metadata with third party technology that can not call the access services directly. through the [integration services](/services/omis).
- [Data Engine Proxy](/concepts/data-engine-proxy) - supports the capture of metadata from a data engine. This includes details of the processing of data that it is doing which is valuable when piecing together lineage.
- [Open Lineage Server](/concepts/open-lineage-server) - Manages the collation of lineage information and maintains it in a format for reporting. This includes the state of the lineage at different points in time.

## Server connectivity

The different types of OMAG Servers connect together as illustrated in Figure 2. Metadata Access Stores and Metadata Access Points (collectively called [Metadata Access Servers](/concepts/metadata-access-server)) provide access to open metadata to the Governance Servers and View Servers via their [Open Metadata Access Services (OMASs)](/services/omas).
The Governance Servers connect to external tools, engines and platforms. The View Servers are called by user interfaces (including Egeria's user interfaces).
Multiple Metadata Access Servers can share metadata with Repository Proxies via one or more cohorts.

## Inter-connectivity

The different types of OMAG Servers connect together as illustrated in Figure 2. There is an inner ring of cohort members communicating via the cohort. Each cohort member is sharing the metadata they receive with the governance servers and view servers that connect to it. The governance servers connect out to external tools, engines and platforms.

![Figure 2](omag-server-ecosystem.svg)
> **Figure 2:** The inter-connectivity between OMAG Servers
> **Figure 2:** The connectivity between OMAG Servers
The repository for a Metadata Access Store may be connected to a conformance test server via a cohort to test that its implementation is conformant with the open metadata standards. It is shown in figure 3. This only happens during test and evaluation.

![Figure 3](omag-server-ecosystem-cts.svg)
> **Figure 3:** Conformance testing


!!! education "Further information"
Expand Down
Loading

0 comments on commit 0e8656a

Please sign in to comment.