diff --git a/site/docs/concepts/governance-action.md b/site/docs/concepts/governance-action.md index 36336f1653..7ec6d9dfd4 100644 --- a/site/docs/concepts/governance-action.md +++ b/site/docs/concepts/governance-action.md @@ -9,7 +9,7 @@ hide: # Governance Action -A *governance action* describes an automated service that governs either metadata, or the digital resource it describes. A governance action is described either as a [governance action type](/concepts/governance-action-type) or a [governance action process](/concepts/governance-action-process). It can be run by calling the open governance service included in any [Open Metadata Access Service (OMAS)](/services/omas) or through the [Automated Curation OMVS](/services/omvs/automated-curation/overview). +A *governance action* describes an automated service that governs either metadata, or the digital resource it describes. A governance action is described either as a [governance action type](/concepts/governance-action-type) or a [governance action process](/concepts/governance-action-process). It can be run by calling the [open governance service](/gaf-metadata-management) included in any [Open Metadata Access Service (OMAS)](/services/omas) or through the [Automated Curation OMVS](/services/omvs/automated-curation/overview). !!! tip "*Governance Action* was renamed to *Engine Action* in release 5.0" If you have been using Egeria for a while, you may be familiar with the term *Governance Action* as the mechanism used to control the execution of automated actions in the Engine Hosts. In [release 5.0](/release-notes/5-0), *Governance Action* was renamed to [*Engine Action*](/concepts/engine-action) to create a greater name differentiation between the concepts that are used to define the governance behaviour and those used to control the execution of this behaviour. The term *Governance Action* is now used as a general term for a [Governance Action Process](/concepts/governance-action-process) or a [governance action type](/concepts/governance-action-type). diff --git a/site/docs/concepts/governance-server.md b/site/docs/concepts/governance-server.md index 2058e48cc2..f4e046b77c 100644 --- a/site/docs/concepts/governance-server.md +++ b/site/docs/concepts/governance-server.md @@ -8,16 +8,20 @@ hide: # Governance server -Governance servers host specific integration or governance connectors for technology that does -not integrate directly with open metadata. +A *Governance Server* is a specialized [OMAG Server](/concepts/omag-server). It is designed to host specific governance daemon connectors that manage metadata in different technologies or perform specific active governance actions. ![Governance server](governance-server.svg) -These are the different types: +The governance servers each have a specific subsystem that contains its services. They are also paired with different [Open Metadata Access Services (OMASs)](/services/omas) that supports appropriate open metadata services needed by the governance server. + +The table below shows the different types of governance servers and the OMASs they are paired with. + +| Governance Server | Description | Supported by subsystem | Paired with OMAS | +|:----------------------------------------------------|:-------------------------------------------------------------------------|:---------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Integration Daemon](/concepts/integraition-daemon) | Manages the capture of metadata through configured integration services. | [Integration Daemon Services](/services/integration-daemon-services) | [Governance Server OMAS](/services/omas/governance-server/overview) provides support for retrieving governance engine definitions. The [integration services](../../integration-services) define the OMASs that support each type of integration connector. | +| [Engine Host](/concepts/engine-host) | Manages governance engines. | [Engine Host Services](/services/engine-host-services) | [Governance Server OMAS](/services/omas/governance-server/overview) provides support for retrieving governance engine definitions. The [engine services](../../engine-services) define the OMASs that support each type of governance engine. | +| [Data Engine Proxy](/concepts/data-engine-proxy) | Manages capture of metadata from a data engine. | [Data Engine Proxy Services](/services/data-engine-proxy-services) | [Data Engine OMAS](/services/omas/data-engine/overview) | +| [Lineage Warehouse](/concepts/lineage-warehouse) | Provides a historic reporting warehouse for lineage. | [Lineage Warehouse Services](/services/lineage-warehouse-services) | [Asset Lineage OMAS](/services/omas/asset-lineage/overview) | -- [Engine hosts](/concepts/engine-host) - host governance engines for active management of the open metadata ecosystem. -- [Integration daemons](/concepts/integration-daemon) - manage the exchange of metadata with third party technologies. -- [Data engine proxy](/concepts/data-engine-proxy) - captures information about processes and the data sources that they work with and catalogs them in open metadata. -- [Lineage warehouse](/concepts/lineage-warehouse) - accumulates lineage information to provide a comprehensive historical reporting service for lineage. --8<-- "snippets/abbr.md" diff --git a/site/docs/connectors/governance-daemon/governance-daemon-intro.md b/site/docs/connectors/governance-daemon/governance-daemon-intro.md index 40e87a973c..5b9d62f32d 100644 --- a/site/docs/connectors/governance-daemon/governance-daemon-intro.md +++ b/site/docs/connectors/governance-daemon/governance-daemon-intro.md @@ -1,5 +1,10 @@ -The governance daemon connectors contain specialist connectors for the governance servers that make active use of open metadata. - +The governance daemon connectors contain specialist connectors for the [governance servers](/concepts/governance-server) that make active use of open metadata. + +* The *Integration Connector* supports the ongoing exchange of metadata between open metadata and a third party technology. It runs in an [Integration Daemon](/concepts/integraiton-daemon). +* The *Governance Service* is a connector that runs in a [Governance Engine](/concepts/governance-service) hosted on the [Engine Host](/concepts/engine-host). +* The *Lineage Warehouse Connector* provides access to a specialist repository for managing lineage information extracted from the open metadata ecosystem. It runs in a [Lineage Warehouse](/concepts/lineage-warehouse). +* The *Data Engine Connector* extracts metadata from a data engine. It has been designed around the needs of IBM's DataStage ETL Engine. It runs in the [Data Engine Proxy](/concepts/data-engine-proxy). + diff --git a/site/docs/connectors/governance-daemon/lineage-warehouse-janus-connector.md b/site/docs/connectors/governance-daemon/lineage-warehouse-janus-connector.md index a086f2927a..4e35632b83 100644 --- a/site/docs/connectors/governance-daemon/lineage-warehouse-janus-connector.md +++ b/site/docs/connectors/governance-daemon/lineage-warehouse-janus-connector.md @@ -6,10 +6,10 @@ hide: -# Lineage Warehouse Janus Connector +# Lineage Warehouse Janus Connectors -The Lineage Warehouse Janus connector allows the Lineage Warehouse Services to connect with a JanusGraph database. +The Lineage Warehouse Connector allows the Lineage Warehouse Services to connect with a repository that stores lineage information. The Connector can be configured to connect to either an embedded JanusGraph database or a standalone JanusGraph server. For more details on possible configurations please use the documentation [offered by JanusGraph](https://docs.janusgraph.org/basics/deployment/). diff --git a/site/docs/connectors/index.md b/site/docs/connectors/index.md index 4bb729440f..79236397c8 100644 --- a/site/docs/connectors/index.md +++ b/site/docs/connectors/index.md @@ -74,9 +74,9 @@ The *topic* integration connectors run in the [Topic Integrator Open Metadata In The *API* integration connectors run in the [API Integrator Open Metadata Integration Service (OMIS)](/services/omis/api-integrator/overview) hosted in the [integration daemon](/concepts/integration-daemon). -| API Integration Connectors | Description | -|---|---| -| [Open API Monitor integration connector](/connectors/integration/open-api-monitor-integration-connector) | Automatically maintains the open metadata instances for the APIs extracted from the Open API Specification extracted from an application.| +| API Integration Connectors | Description | +|----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| [Open API Monitor integration connector](/connectors/integration/open-api-monitor-integration-connector) | Automatically maintains the open metadata instances for the APIs extracted from the Open API Specification extracted from an application. | #### Synchronizing with third party catalogs @@ -216,17 +216,17 @@ There are currently no repository governance services supplied by Egeria. *Runtime* connectors enable Egeria's [OMAG Server Platform](/egeria docs/concepts/omag-server-platform) and its hosted [OMAG Servers](/concepts/omag-server) to operate in many environments by providing plug-in points for the runtime services it needs to operate. Most of the runtime connectors relate to persistent storage, or connections to distributed services. -| Type | Description | -|---|---| -| [Platform Metadata Security Connectors](#platform-metadata-security-connectors) | manage authorization requests for the OMAG Server Platform's services. | -| [Server Metadata Security Connectors](#server-metadata-security-connectors) | manage authorization requests for the OMAG Server's services. | -| [Configuration Document Store Connectors](#configuration-document-store-connectors) | manage the persistence and retrieval of [configuration documents](/concepts/configuration-document). | -| [Cohort Registry Store Connectors](#cohort-registry-store-connectors) | store the [open metadata repository cohort](/concepts/cohort-member) membership details in the [cohort registry store](/concepts/cohort-registry-store). | -| [Open Metadata Archive Store Connectors](#open-metadata-archive-store-connectors) | read and write [open metadata archives](/concepts/open-metadata-archive). | -| [Audit Log Destination Connectors](#audit-log-destination-connectors) | support different destinations for audit log records. | -| [REST Client Connectors](#rest-client-connectors) | issue REST API calls to Egeria's deployed platforms and third party technologies. | -| [Cohort Member Client Connector](#cohort-member-client-connectors) | supports repository service called to remote cohort members. | -| [Open Metadata Topic Connectors](#open-metadata-topic-connectors) | send and receive events. | +| Type | Description | +|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Platform Metadata Security Connectors](#platform-metadata-security-connectors) | manage authorization requests for the OMAG Server Platform's services. | +| [Server Metadata Security Connectors](#server-metadata-security-connectors) | manage authorization requests for the OMAG Server's services. | +| [Configuration Document Store Connectors](#configuration-document-store-connectors) | manage the persistence and retrieval of [configuration documents](/concepts/configuration-document). | +| [Cohort Registry Store Connectors](#cohort-registry-store-connectors) | store the [open metadata repository cohort](/concepts/cohort-member) membership details in the [cohort registry store](/concepts/cohort-registry-store). | +| [Open Metadata Archive Store Connectors](#open-metadata-archive-store-connectors) | read and write [open metadata archives](/concepts/open-metadata-archive). | +| [Audit Log Destination Connectors](#audit-log-destination-connectors) | support different destinations for audit log records. | +| [REST Client Connectors](#rest-client-connectors) | issue REST API calls to Egeria's deployed platforms and third party technologies. | +| [Cohort Member Client Connector](#cohort-member-client-connectors) | supports repository service called to remote cohort members. | +| [Open Metadata Topic Connectors](#open-metadata-topic-connectors) | send and receive events. | ### Platform Metadata Security Connectors @@ -349,8 +349,8 @@ Egeria provides a single implementation for Spring. This is embedded in Egeria's Java clients. See - - Egeria's [Platform API clients](/guides/developer/#working-with-the-platform-apis). - - Egeria's [OMAS clients](/guides/developer/#working-with-the-open-metadata-and-governance-apis). +- Egeria's [Platform API clients](/guides/developer/#working-with-the-platform-apis). +- Egeria's [OMAS clients](/guides/developer/#working-with-the-open-metadata-and-governance-apis). diff --git a/site/docs/connectors/resource/digital-resource-connector-intro.md b/site/docs/connectors/resource/digital-resource-connector-intro.md index c6dc5c8aba..880fb8d645 100644 --- a/site/docs/connectors/resource/digital-resource-connector-intro.md +++ b/site/docs/connectors/resource/digital-resource-connector-intro.md @@ -1,7 +1,7 @@ -The [digital resource connectors](/concepts/digital-resource-connector) provide access to [digital resources](/concept/resource) and their [asset metadata](/concepts/asset) that is stored in the open metadata ecosystem. These connectors are for use by external applications and tools to connect with resources and services in the digital landscape. The can also be used by other connectors, such as [integration connectors](/concepts/integration-connector), [Open Discovery Services](/concepts/open-discovery-service) and [Governance Action Services](/concept/governance-action-service), to access a third party technology. +The [digital resource connectors](/concepts/digital-resource-connector) provide access to [digital resources](/concepts/resource) and their [asset metadata](/concepts/asset) that is stored in the open metadata ecosystem. These connectors are for use by external applications and tools to connect with resources and services in the digital landscape. The can also be used by other connectors, such as [integration connectors](/concepts/integration-connector), [Open Discovery Services](/concepts/open-discovery-service) and [Governance Action Services](/concept/governance-action-service), to access a third party technology. These connectors also supply the Asset metadata from Egeria that describes these resources. diff --git a/site/docs/guides/admin/egeria-admin.drawio b/site/docs/guides/admin/egeria-admin.drawio index 18884c80e9..db941772ff 100644 --- a/site/docs/guides/admin/egeria-admin.drawio +++ b/site/docs/guides/admin/egeria-admin.drawio @@ -1,4 +1,4 @@ - + @@ -4934,55 +4934,55 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/site/docs/services/omas/governance-engine/governance-engine-omas.drawio b/site/docs/services/omas/governance-engine/governance-engine-omas.drawio index 97ba0e99f1..ce6d4f6d6d 100644 --- a/site/docs/services/omas/governance-engine/governance-engine-omas.drawio +++ b/site/docs/services/omas/governance-engine/governance-engine-omas.drawio @@ -1,6 +1,6 @@ - + - + @@ -74,7 +74,7 @@ - + @@ -357,7 +357,7 @@ - + @@ -595,443 +595,4 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/site/docs/services/omas/governance-server/database-agents-and-information.svg b/site/docs/services/omas/governance-server/database-agents-and-information.svg new file mode 100644 index 0000000000..3643e54299 --- /dev/null +++ b/site/docs/services/omas/governance-server/database-agents-and-information.svg @@ -0,0 +1,4 @@ + + + +
Integration Connector
to identify schemas within
a database asset
Integration Connector...
Database
(asset describing the database to catalog)
Database...
Catalog Target
Catalog Target
Connection (connection for the database) 
Connection (connecti...
Database Schema
(asset describing the database schema)
Database Schema...
Engine Action to add profile of database to Discovery Analysis Report
Engine Action to add profi...
TargetForAction
TargetForAction
Engine Action to identify lineage origin for database
Engine Action to identify...
TargetForAction
TargetForAction
Discovery Analysis Report
Discovery Analysis R...
Application that is Ultimate Source of database
Application that is...
UltimateSource
UltimateSource
Agents acting on the database resource
Agents acting on the database resource
Information being gathered about the database resource
Information being gathered about the database resource
DataContentForDataSet
DataContentForDataSet
AssetDiscoveryReport
AssetDiscoveryReport
ConnectionForAsset
ConnectionForAssetText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/governance-server-omas.drawio b/site/docs/services/omas/governance-server/governance-server-omas.drawio new file mode 100644 index 0000000000..a6be9f1103 --- /dev/null +++ b/site/docs/services/omas/governance-server/governance-server-omas.drawio @@ -0,0 +1,586 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/services/omas/governance-server/integration-connector-catalog-target-data-folder-example.svg b/site/docs/services/omas/governance-server/integration-connector-catalog-target-data-folder-example.svg new file mode 100644 index 0000000000..8dbc1713ef --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-catalog-target-data-folder-example.svg @@ -0,0 +1,4 @@ + + + +
Integration Connector
(description of the integration connector)
Integration Connector...
DataFolder
(asset describing the directory)
DataFolder...
Connection
(for the integration connector)
Connection...
Connector Type
(for the integration connector)
Connector Type...
Connection (connection for the directory) 
Connection (connecti...
Connector Type
(to access a directory)
Connector Type...
Endpoint
(directory path name)
Endpoint...
Catalog Target
Catalog TargetText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-connector-catalog-target-database-example.svg b/site/docs/services/omas/governance-server/integration-connector-catalog-target-database-example.svg new file mode 100644 index 0000000000..a4a589de6a --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-catalog-target-database-example.svg @@ -0,0 +1,4 @@ + + + +
Integration Connector
(description of the integration connector)
Integration Connector...
Database
(asset describing the database to catalog)
Database...
Connection
(for the integration connector)
Connection...
Connector Type
(for the integration connector)
Connector Type...
VirtualConnection (connection for the database) 
VirtualConnection (c...
Connector Type
(to access a database)
Connector Type...
Endpoint
(url for database)
Endpoint...
Catalog Target
Catalog Target
Connection
(for the secret store)
Connection...
Connector Type
(for the secret store)
Connector Type...
Endpoint
(for the secret store)
Endpoint...
EmbeddedConnection
EmbeddedConnectionText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-connector-catalog-target.svg b/site/docs/services/omas/governance-server/integration-connector-catalog-target.svg new file mode 100644 index 0000000000..8708834318 --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-catalog-target.svg @@ -0,0 +1,4 @@ + + + +
Open Metadata
Element
Open Metadata...
Connection
Connection
Connector Type
Connector Type
Endpoint
Endpoint
Catalog Target
Catalog Target
Integration Connector
(description of the integration connector)
Integration Connector...
Connection
(for the integration connector)
Connection...
Connector Type
(for the integration connector)
Connector Type...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-connector-simple.svg b/site/docs/services/omas/governance-server/integration-connector-simple.svg new file mode 100644 index 0000000000..21ecbf2320 --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-simple.svg @@ -0,0 +1,4 @@ + + + +
Integration
Connector
Integration...
Connection
Connection
Connector Type
Connector Type
Endpoint
EndpointText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-connector-virtual-connection-example.svg b/site/docs/services/omas/governance-server/integration-connector-virtual-connection-example.svg new file mode 100644 index 0000000000..56b9f024c9 --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-virtual-connection-example.svg @@ -0,0 +1,4 @@ + + + +
Integration
Connector
Integration...
VirtualConnection
(for the integration connector)
VirtualConnection...
Connector Type
(for the integration connector)
Connector Type...
Endpoint
(for the integration connector)
Endpoint...
Connection
(for the secret store)
Connection...
Connector Type
(for the secret store)
Connector Type...
Endpoint
(for the secret store)
Endpoint...
EmbeddedConnection
EmbeddedConnectionText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-connector-virtual-connection.svg b/site/docs/services/omas/governance-server/integration-connector-virtual-connection.svg new file mode 100644 index 0000000000..0af1b44d1b --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-connector-virtual-connection.svg @@ -0,0 +1,4 @@ + + + +
Integration
Connector
Integration...
VirtualConnection
VirtualConnection
Connector Type
Connector Type
Endpoint
Endpoint
Connection
Connection
Connector Type
Connector Type
Endpoint
Endpoint
EmbeddedConnection
EmbeddedConnectionText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-group-example.svg b/site/docs/services/omas/governance-server/integration-group-example.svg new file mode 100644 index 0000000000..390219e6d4 --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-group-example.svg @@ -0,0 +1,4 @@ + + + +
Integration
Connector
Integration...
Open Metadata
Elements
Open Metadata...
Connection
Connection
Integration Group
Integration Group
CatalogTarget
CatalogTarget
Integration
Connector
Integration...
Open Metadata
Element
Open Metadata...
Connection
Connection
ConnectionToAsset
ConnectionToAssetText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/integration-group-use.svg b/site/docs/services/omas/governance-server/integration-group-use.svg new file mode 100644 index 0000000000..fa39ae107e --- /dev/null +++ b/site/docs/services/omas/governance-server/integration-group-use.svg @@ -0,0 +1,4 @@ + + + +
Integration
Daemon
Integration...
Metadata Access Server
Metadata Access Serv...
Cohort
Cohort
Integration
Connectors
Integration...
Integration
Connectors
Integration...Text is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/services/omas/governance-server/overview.md b/site/docs/services/omas/governance-server/overview.md new file mode 100644 index 0000000000..0a8c64871f --- /dev/null +++ b/site/docs/services/omas/governance-server/overview.md @@ -0,0 +1,57 @@ + + + +--8<-- "snippets/content-status/in-development.md" + +# Governance Server Open Metadata Access Service (OMAS) + +The *Governance Server OMAS* supports the implementation of a [governance server](/concepts/governance-server) by providing the metadata services for defining and running [governance engines](#governance-engines) as well as setting up [integration groups](#integration-groups). + +## Governance Engines + +A governance engine is a collection of related *[governance services](/concepts/governance-service)* that provide pluggable governance functions. The governance services are implemented as +specialist [connectors](/frameworks/ocf/overview) that are defined by: + +* [Survey Action Framework (SAF)](/frameworks/saf/overview) for Survey Action Services that analyse the content of resources in the digital landscape. +* [Governance Action Framework (GAF)](/frameworks/gaf/overview) of Governance Action Services that monitor, assess and maintain metadata. + +The governance services run in the [Engine Host OMAG Server](/concepts/engine-host) supported by the [Open Metadata Engine Services (OMES)](/services/omes). They are triggered via [governance actions](/concepts/governane-action). + +The Governance Engine OMAS has the following capabilities to support governance engines: + +| Java Interface | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [GovernanceEngineConfiguration](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineConfiguration.html) | Creating the definitions for [governance engines](/concepts/governance-engine) and their [governance services](/concepts/governance-service). | +| [GovernanceEngineEventInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineEventInterface.html) | Providing the events that enable the Engine Host OMAG Server to be notified of any changes to governance actions, governance engines and governance services. It also provides support for the watchdog events. | +| [GovernanceProcessingInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceProcessingInterface.html) | Providing the APIs that enable the Engine Host OMAG Server to retrieve the definitions of the governance engines and services. | +| [GovernanceActionProcessInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceActionProcessInterface.html) | Creating the definitions for [governance action processes](/concepts/governance-action-process) that control the sequencing of [engine actions](/concepts/engine-action. | +| [GovernanceProcessingInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceProcessingInterface.html) | Providing APIs to initiate [engine actions](/concepts/engine-action) and [governance action processes](/concepts/governance-action-process) explicitly. | +| [GovernanceEngineEventListener](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineEventListener.html) | Notification of new [engine actions](/concepts/engine-action) to the Engine Host OMAG Servers that then invoke the appropriate governance services to action them. | +| [MetadataElementInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/commonservices/gaf/api/MetadataElementInterface.html) | Supporting the metadata requirements for many of the [engine services](/services/omes). | +| [GovernanceEngineConfiguration](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/GovernanceEngineConfiguration.html) | Providing APIs to query the status of the governance capabilities implemented through the governance engines. | +| [SpecialGovernanceActionInterface](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/governanceengine/api/SpecialGovernanceActionInterface.html) | Providing specialized governance remediation APIs such as linking duplicates. | + +Behind the scenes, Governance Engine OMAS handles the choreography of governance actions based on the process definition provided by a [governance action process](/concepts/governance-action-process). + +!!! info "Further documentation" + The documentation for writing governance services is located in the developer guide: + + - [Survey Action Services](/guides/developer/survey-action-services) for metadata discovery. + - [Governance Action Services](/guides/developer/governance-action-services) for the Governance Action Services: Watchdog Governance Services, Triage Governance Services, Verification Governance Services, Remediation Governance Services and Provisioning Governance Services. + - [Event Action Services](/guides/developer/event-action-services) for the time-based services. + - [Repository Governance Services](/guides/developer/repository-governance-services) for the management of open metadata repositories. + + +## Integration Groups + +An [integration group](/concepts/integration-group) is a collection of [integration connector](/concepts/integration-connector) definitions intended to run in one or more [integration daemons](/concepts/integration-daemon). The Governance Engine OMAS provides the API to maintain the integration group and integration connector definitions. The integration daemon then loads the definitions from the integration group and runs the requested integration connectors. This is an alternative method to configure the integration daemon from adding the integration connectors directly into the integration daemon's configuration document. The advantage of this approach is that new integration connectors can be added without restarting the integration daemon. + +![integration group operation](integration-group-use.svg) + +The Governance Server OMAS supports the creation and maintenance of the metadata that makes up an integration pack. At the root is the [IntegrationGroup](/types/4/0464-Dynamic-Integration-Group). Linked to it are the *IntegrationConnector* entities - one for each integration connector that is to run. Each have a [connection](/concepts/connection) attached that is used to initialize the integration connector. Optionally, the integration connector can be linked to existing metadata elements via the *CatalogTarget* relationship. This guides the integration connector on which elements to update - rather than creating new elements. For example, if the integration connector is cataloguing a specific database and its *Database* entity has already been created, it would be linked to the *IntegrationConnector* entity via the *CatalogTarget* relationship. The integration connector is able to retrieve the catalog target via its context. + +![integration group example](integration-group-example.svg) + + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/services/omas/index.md b/site/docs/services/omas/index.md index 0481ba1337..b85a68c7d0 100644 --- a/site/docs/services/omas/index.md +++ b/site/docs/services/omas/index.md @@ -12,40 +12,41 @@ The Open Metadata Access Services (OMAS) provide domain-specific services for da The access services are as follows: -| OMAS | Description | -|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Asset Consumer](/services/omas/asset-consumer/overview) | The Asset Consumer OMAS is designed for applications that are using [OCF](/frameworks/ocf/overview) connectors to access data stores, APIs and functions such as analytics. The Asset Consumer OMAS provides a factory function for the connectors, the ability to retrieve all of the metadata about the asset and the ability to add feedback on the asset. | -| [Asset Lineage](/services/omas/asset-lineage/overview) | The Asset Lineage OMAS listens to relevant lineage related events on the enterprise topic level and publishes these on the Asset Lineage OutTopic, combined with relevant context information on the described entities. These events are listened to by the open lineage services governance server. | -| [Asset Manager](/services/omas/asset-manager/overview) | The Asset Manager OMAS manages the exchange of metadata with third party metadata catalogs and asset managers. It is typically called by the [Catalog Integrator OMIS](/services/omis/catalog-integrator/overview) to send and receive asset information, including schemas, profiles, policies and lineage information with a third party asset manager. Typical examples of asset managers include data catalogs that are managing metadata for a collection of data assets for a data-serving solution. | -| [Asset Owner](/services/omas/asset-owner/overview) | The Asset Owner OMAS provides services for an asset owner to curate metadata about their asset(s) and understand how these assets are being used and governed. | -| [Community Profile](/services/omas/community-profile/overview) | The Community Profile OMAS supports the administration for a community and related user profiles. These communities are involved in reviewing and crowd-sourcing knowledge about the data assets and their use. | -| [Data Engine](/services/omas/data-engine/overview) | The Data Engine OMAS provides APIs and events for a data movement/processing engine to record the changes it is making the the data landscape. This information forms a key part of asset lineage. | -| [Data Manager](/services/omas/data-manager/overview) | The Data Manager OMAS provides an integration point to enable technologies that manage collections of data such as database servers, file systems, file managers and content managers to publish metadata to the metadata repositories about the changing structures and content stored in the data platform. It is typically called from the [Database Integrator OMIS](/services/omis/database-integrator/overview) and [Files Integrator OMIS](/services/omis/files-integrator/overview) integration services. | -| [Data Privacy](/services/omas/data-privacy/overview) | The Data Privacy OMAS supports a privacy officer as they manage data privacy in their organization. This includes managing privacy impact assessments and reviews of software services that use personal data as they move through their development, deployment and use. | -| [Data Science](/services/omas/data-science/overview) | The Data Science OMAS provides access to metadata for data assets, connections and projects, plus the ability to maintain metadata about data science notebooks and models and log activity during the analytics development process. It is designed for data science and analytics management tools. | -| [Design Model](/services/omas/design-model/overview) | The Design Model OMAS provides the ability to manage information from all types of design models. These models may come from tools or be part of a packaged standard. This content is useful for governance, system integration and software development. | -| [DevOps](/services/omas/dev-ops/overview) | The DevOps OMAS provides services for a DevOps pipeline to query and maintain metadata about systems, processes and software components that are being deployed into the information landscape. | -| [Digital Architecture](/services/omas/digital-architecture/overview) | The Digital Architecture OMAS provides the ability to define information standards, definitions, solution blueprints and models for an organization. It is designed for architecture tools. It is able to support the definition and management of a digital service through concept to deployment. | -| [Digital Service](/services/omas/digital-service/overview) | The Digital Service OMAS provides services for a managing the lifecycle of an Egeria Digital Service. | -| [Discovery Engine](/services/omas/discovery-engine/overview) | The Discovery Engine OMAS provides an API for a discovery engine to access and store metadata from an open metadata repository (or open metadata repository cohort). | -| [Governance Engine](/services/omas/governance-engine/overview) | The Governance Engine OMAS provides APIs and events that retrieve and manage metadata for governance engines. Governance engines ensure that the infrastructure supporting the data landscape is operating according to the governance program. For example, the governance engine may be ensuring that individuals and servers only have access to the data they have been authorized to see. | -| [Governance Program](/services/omas/governance-program/overview) | The Governance Program OMAS provides the ability to maintain a governance program in the open metadata repositories. It is designed for governance and CDO tools. | -| [IT Infrastructure](/services/omas/it-infrastructure/overview) | The IT Infrastructure OMAS provides support for the design and planning of the information infrastructure that supports the data assets. This includes the development of system blueprints that link down to the metadata about real infrastructure components. This metadata helps in the linkage between information governance metadata and IT infrastructure management (ITIL) metadata typically stored in a Configuration Management Database (CMDB). | -| [Project Management](/services/omas/project-management/overview) | The Project Management OMAS supports the metadata associated with projects and campaigns. These projects and campaigns may be for governance projects, or generic data use projects. | -| [Security Manager](/services/omas/security-manager/overview) | The Security Manager OMAS provides the services to exchange security tags with access control and data protection technology services. It is called by the [Security Integrator OMIS](/services/omis/security-integrator/overview). | -| [Security Officer](/services/omas/security-officer/overview) | The Security Officer OMAS provides the services to support the definition of roles and rules for managing the protection of metadata and assets, plus work with the audit logs captured by the open metadata and governance tools. It is typically used by the security, compliance and auditing teams. | -| [Software Developer](/services/omas/software-developer/overview) | The Software Development OMAS provides access to metadata needed to build compliant APIs, data stores and related software components. | -| [Stewardship Action](/services/omas/stewardship-action/overview) | The Stewardship Action OMAS provides services for managing exceptions discovered in the information landscape that need correcting. These exceptions may be quality errors, missing or outdated information, invalid licensing, job failures, and many more. The Stewardship Action OMAS also enables the review and triage of the exceptions, simple remediation and status reporting. | -| [Subject Area](/services/omas/subject-area/overview) | The Subject Area OMAS is for tools that support subject matter experts who are defining glossaries, reference data and rules around data for a specific subject area, such as "customer data". It supports the development of a comprehensive definition of the subject area and the standards that support it. These definitions can then be folded into the Governance Program, and used by Asset Owner's to improve the findability and understandability of their assets by linking their asset's structure to relevant parts of the subject area definition. | +| OMAS | Description | Supplied APIs and events to | +|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Asset Consumer](/services/omas/asset-consumer/overview) | The Asset Consumer OMAS is designed for applications that are using [OCF](/frameworks/ocf/overview) connectors to access data stores, APIs and functions such as analytics. The Asset Consumer OMAS provides a factory function for the connectors, the ability to retrieve all of the metadata about the asset and the ability to add feedback on the asset. | [Search Integrator OMIS](/services/omis/search-integrator/overview), [Asset Catalog OMVS](/services/omvs/asset-catalog/overview) | +| [Asset Lineage](/services/omas/asset-lineage/overview) | The Asset Lineage OMAS listens to relevant lineage related events on the enterprise topic level and publishes these on the Asset Lineage OutTopic, combined with relevant context information on the described entities. These events are listened to by the open lineage services governance server. | [Lineage Warehouse Services](/services/lineage-warehouse-services) | +| [Asset Manager](/services/omas/asset-manager/overview) | The Asset Manager OMAS manages the exchange of metadata with third party metadata catalogs and asset managers. It is typically called by the [Catalog Integrator OMIS](/services/omis/catalog-integrator/overview) to send and receive asset information, including schemas, profiles, policies and lineage information with a third party asset manager. Typical examples of asset managers include data catalogs that are managing metadata for a collection of data assets for a data-serving solution. | [Catalog Integrator OMIS](/services/omis/catalog-integrator/overview), [Lineage Integrator OMIS](/services/omis/lineage-integrator/overview), [Glossary Browser OMVS](/services/omvs/glossary-browser/overview), [Glossary Workflow OMVS](/services/omvs/glossary-workflow/overview) | +| [Asset Owner](/services/omas/asset-owner/overview) | The Asset Owner OMAS provides services for an asset owner to curate metadata about their asset(s) and understand how these assets are being used and governed. | [Survey Action OMES](/services/omes/survey-action/overview), [Automated Curation OMVS](/services/omvs/automated-curation/overview) | +| [Community Profile](/services/omas/community-profile/overview) | The Community Profile OMAS supports the administration for a community and related user profiles. These communities are involved in reviewing and crowd-sourcing knowledge about the data assets and their use. | [Organization Integrator OMIS](/services/omis/organization-integrator/overview), [My Profile OMVS](/services/omvs/my-profile/overview) | +| [Data Engine](/services/omas/data-engine/overview) | The Data Engine OMAS provides APIs and events for a data movement/processing engine to record the changes it is making the the data landscape. This information forms a key part of asset lineage. | [Data Engine Proxy Services](/services/data-engine-proxy-services) | +| [Data Manager](/services/omas/data-manager/overview) | The Data Manager OMAS provides an integration point to enable technologies that manage collections of data such as database servers, file systems, file managers and content managers to publish metadata to the metadata repositories about the changing structures and content stored in the data platform. It is typically called from the [Database Integrator OMIS](/services/omis/database-integrator/overview) and [Files Integrator OMIS](/services/omis/files-integrator/overview) integration services. | [API Integrator OMIS](/services/omis/api-integrator/overview), [Database Integrator OMIS](/services/omis/database-integrator/overview), [Display Integrator OMIS](/services/omis/display-integrator/overview), [Files Integrator OMIS](/services/omis/files-integrator/overview), [Topic Integrator OMIS](/services/omis/topic-integrator/overview) | +| [Data Privacy](/services/omas/data-privacy/overview) | The Data Privacy OMAS supports a privacy officer as they manage data privacy in their organization. This includes managing privacy impact assessments and reviews of software services that use personal data as they move through their development, deployment and use. | | +| [Data Science](/services/omas/data-science/overview) | The Data Science OMAS provides access to metadata for data assets, connections and projects, plus the ability to maintain metadata about data science notebooks and models and log activity during the analytics development process. It is designed for data science and analytics management tools. | [Analytics Integrator OMIS](/services/omis/analytics-integrator/overview), [Event Action OMES](/services/omes/event-action/overview) | +| [Design Model](/services/omas/design-model/overview) | The Design Model OMAS provides the ability to manage information from all types of design models. These models may come from tools or be part of a packaged standard. This content is useful for governance, system integration and software development. | | +| [DevOps](/services/omas/dev-ops/overview) | The DevOps OMAS provides services for a DevOps pipeline to query and maintain metadata about systems, processes and software components that are being deployed into the information landscape. | | +| [Digital Architecture](/services/omas/digital-architecture/overview) | The Digital Architecture OMAS provides the ability to define information standards, definitions, solution blueprints and models for an organization. It is designed for architecture tools. It is able to support the definition and management of a digital service through concept to deployment. | | +| [Digital Service](/services/omas/digital-service/overview) | The Digital Service OMAS provides services for a managing the lifecycle of an Egeria Digital Service. | [Collection Manager OMVS](/services/omvs/collection-manager/overview) | +| [Discovery Engine](/services/omas/discovery-engine/overview) | The Discovery Engine OMAS provides an API for a discovery engine to access and store metadata from an open metadata repository (or open metadata repository cohort). | [Asset Analysis OMES](/services/omes/asset-analysis/overview) | +| [Governance Engine](/services/omas/governance-engine/overview) | The Governance Engine OMAS provides APIs and events that retrieve and manage metadata for [governance action services](/concepts/governance-action-service). | [Governance Action OMES](/services/omes/governance-action/overview) | +| [Governance Program](/services/omas/governance-program/overview) | The Governance Program OMAS provides the ability to maintain a governance program in the open metadata repositories. It is designed for governance and CDO tools. | | +| [Governance Server](/services/omas/governance-server/overview) | The Governance Server OMAS supplies the [governance engine definitions](/concepts/governance-engine-definition) to the [engine hosts](/concepts/engine-host) and the and [integration group definitions](/concepts/integration-group) to the [integration daemons](/concepts/integration-daemon). | [Integration Daemon Services](/services/integration-daemon-services), [Engine Host Services](/services/engine-host-services) | +| [IT Infrastructure](/services/omas/it-infrastructure/overview) | The IT Infrastructure OMAS provides support for the design and planning of the information infrastructure that supports the data assets. This includes the development of system blueprints that link down to the metadata about real infrastructure components. This metadata helps in the linkage between information governance metadata and IT infrastructure management (ITIL) metadata typically stored in a Configuration Management Database (CMDB). | [Infrastructure Integrator OMIS](/services/omis/infrastructure-integrator/overview) | +| [Project Management](/services/omas/project-management/overview) | The Project Management OMAS supports the metadata associated with projects and campaigns. These projects and campaigns may be for governance projects, or generic data use projects. | [Project Manager OMVS](/services/omvs/project-manager/overview) | +| [Security Manager](/services/omas/security-manager/overview) | The Security Manager OMAS provides the services to exchange security tags with access control and data protection technology services. It is called by the [Security Integrator OMIS](/services/omis/security-integrator/overview). | [Security Integrator OMIS](/services/omis/security-integrator/overview) | +| [Security Officer](/services/omas/security-officer/overview) | The Security Officer OMAS provides the services to support the definition of roles and rules for managing the protection of metadata and assets, plus work with the audit logs captured by the open metadata and governance tools. It is typically used by the security, compliance and auditing teams. | | +| [Software Developer](/services/omas/software-developer/overview) | The Software Development OMAS provides access to metadata needed to build compliant APIs, data stores and related software components. | | +| [Stewardship Action](/services/omas/stewardship-action/overview) | The Stewardship Action OMAS provides services for managing exceptions discovered in the information landscape that need correcting. These exceptions may be quality errors, missing or outdated information, invalid licensing, job failures, and many more. The Stewardship Action OMAS also enables the review and triage of the exceptions, simple remediation and status reporting. | [Stewardship Integrator OMIS](/services/omis/stewardship-integrator/overview), [Notification Manager OMVS](/services/omvs/notification-manager/overview) | +| [Subject Area](/services/omas/subject-area/overview) | The Subject Area OMAS is for tools that support subject matter experts who are defining glossaries, reference data and rules around data for a specific subject area, such as "customer data". It supports the development of a comprehensive definition of the subject area and the standards that support it. These definitions can then be folded into the Governance Program, and used by Asset Owner's to improve the findability and understandability of their assets by linking their asset's structure to relevant parts of the subject area definition. | [Glossary Author OMVS](/services/omvs/glossary-author/overview) | ## Using the OMAS's -The OMAS's run in a [metadata access server](/concepts/metadata-access-server). They can be configured and activated individually or as a complete set. The [administration services](/guides/admin/servers) provide the ability to configure, start and stop the access services. +The OMAS's run in a [metadata access server](/concepts/metadata-access-server). They can be configured and activated individually or as a complete set through the [administration services](/guides/admin/servers/by-section/access-services-section). -Each OMAS typically supports a Java API, a topic where it publishes notifications of interest to its callers (called the [OutTopic](/concepts/out-topic)), and a topic where new metadata requests can be posted to the OMAS (called the [InTopic](/concepts/in-topic)). +Each OMAS typically supports a Java API, an optional topic where it publishes notifications of interest to its callers (called the [OutTopic](/concepts/out-topic)), and an optional topic where new metadata requests can be posted to the OMAS (called the [InTopic](/concepts/in-topic)). -Internally, the Java client calls the REST API of the server module to allow it to reside in remote servers. This java client is embedded in the [integration services](/services/omis), [engine services](/services/omes) and [view services](/services/omvs). +Internally, the Java client calls the REST API of the server module to allow it to reside in remote servers. This java client is embedded in the [integration services](/services/omis), [engine services](/services/omes) and [view services](/services/omvs) to facilitate exchange of metadata between the OMAG servers. ## Inside an OMAS diff --git a/site/docs/services/omes/engine-services-asset-analysis-server-side.svg b/site/docs/services/omes/engine-services-asset-analysis-server-side.svg index 1fd28249ad..9e2055ef59 100644 --- a/site/docs/services/omes/engine-services-asset-analysis-server-side.svg +++ b/site/docs/services/omes/engine-services-asset-analysis-server-side.svg @@ -1,4 +1,4 @@ - + -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Listener
Listener
Request
Handler
Request...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Configuration
Handler
Configuration...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
Discovery Engine
OMAS
Discovery Engine...
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Asset
Analysis
Engine
Service
Asset...
Admin
Admin
REST API
REST API
Discovery Engine Handler
Discovery Engine Handler
Governance Services Map
Governance Services Map
Discovery
Engine
OMAS
Client
Discovery...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Discovery
Service
Handler
Discovery...
Audit Log (Repository Services)
Audit Log (Repository Services)Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Discovery Engine
OMAS
REST API calls
Admin
REST API
Asset
Analysis
Engine
Service
Admin
REST API
Discovery Engine Handler
Governance Services Map
Discovery
Engine
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Discovery
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-engine-host-internals.svg b/site/docs/services/omes/engine-services-engine-host-internals.svg index 801588e6ac..753dc29175 100644 --- a/site/docs/services/omes/engine-services-engine-host-internals.svg +++ b/site/docs/services/omes/engine-services-engine-host-internals.svg @@ -1,4 +1,4 @@ - + -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Listener
Listener
Request
Handler
Request...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Configuration
Handler
Configuration...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
Partner
Service
Partner...
Engine
Service
Engine...
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Engine
Service
Engine...
Admin
Admin
REST API
REST API
Governance Engine Handler
Governance Engine Handler
Governance Services Map
Governance Services Map
Partner
Service
Client
Partner...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Audit Log (Repository Services)
Audit Log (Repository Services)
watchdog
events
watchdog...Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Partner
Service
Engine
Service
REST API calls
Admin
REST API
Engine
Service
Admin
REST API
Governance Engine Handler
Governance Services Map
Partner
Service
Client
Governance
Service
Handler
Governance
Service
Handler
Governance
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-event-action-server-side.svg b/site/docs/services/omes/engine-services-event-action-server-side.svg index e7f5c8d424..fc734872ab 100644 --- a/site/docs/services/omes/engine-services-event-action-server-side.svg +++ b/site/docs/services/omes/engine-services-event-action-server-side.svg @@ -1,4 +1,4 @@ -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Listener
Listener
Request
Handler
Request...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Configuration
Handler
Configuration...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
Stewardship Action OMAS
Stewardship Action...
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Event
Action
Engine
Service
Event...
Admin
Admin
REST API
REST API
Event Action Engine Handler
Event Action Engine Handler
Governance Services Map
Governance Services Map
Stewardship
Action
OMAS
Client
Stewardship...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Event Action
Service
Handler
Event Action...
Audit Log (Repository Services)
Audit Log (Repository Services)Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Data Science OMAS
REST API calls
Admin
REST API
Event
Action
Engine
Service
Admin
REST API
Event Action Engine Handler
Governance Services Map
Stewardship
Action
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Event Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-governance-action-server-side.svg b/site/docs/services/omes/engine-services-governance-action-server-side.svg index afee8df2a6..9411b77dd0 100644 --- a/site/docs/services/omes/engine-services-governance-action-server-side.svg +++ b/site/docs/services/omes/engine-services-governance-action-server-side.svg @@ -1,4 +1,4 @@ - + -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Governance
Action
Engine
Service
Governance...
Admin
Admin
REST API
REST API
Governance Action Engine Handler
Governance Action Engine Handler
Governance Services Map
Governance Services Map
Governance
Engine
OMAS
Client
Governance...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Governance
Action Service
Handler
Governance...
Audit Log (Repository Services)
Audit Log (Repository Services)
Governance Engine
OMAS
Governance Engine...
Listener
Listener
Request
Handler
Request...
Configuration
Handler
Configuration...
watchdog
events
watchdog...Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Governance Server
OMAS
REST API
REST API calls
Admin
REST API
Governance
Action
Engine
Service
Admin
REST API
Governance Action Engine Handler
Governance Services Map
Governance
Engine
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Governance
Action Service
Handler
Audit Log (Repository Services)
Governance Engine
OMAS
Listener
Request
Handler
Configuration
Handler
Out
Topic
OutTopic
Events
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-repository-governance-server-side.svg b/site/docs/services/omes/engine-services-repository-governance-server-side.svg index 087961417d..3bda2015d2 100644 --- a/site/docs/services/omes/engine-services-repository-governance-server-side.svg +++ b/site/docs/services/omes/engine-services-repository-governance-server-side.svg @@ -1,4 +1,4 @@ - + -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Listener
Listener
Request
Handler
Request...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Configuration
Handler
Configuration...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
Open Metadata Repository Services (OMRS)
Open Metadata Repos...
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Repository
Governance
Engine
Service
Repository...
Admin
Admin
REST API
REST API
Repository Governance Engine Handler
Repository Governance Engine Handler
Governance Services Map
Governance Services Map
Enterprise
Repository
Services
Client
Enterprise...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Repository Governance
Service
Handler
Repository Gover...
Audit Log (Repository Services)
Audit Log (Repository Services)
Remote
Enterprise
OMRS
Topic
Remote...
OMRS Topic
Events
OMRS Topic...Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Access Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Open Metadata Repository Services (OMRS)
REST API calls
Admin
REST API
Repository
Governance
Engine
Service
Admin
REST API
Repository Governance Engine Handler
Governance Services Map
Enterprise
Repository
Services
Client
Governance
Service
Handler
Governance
Service
Handler
Repository Governance
Service
Handler
Audit Log (Repository Services)
Remote
Enterprise
OMRS
Topic
OMRS Topic
Events
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services-survey-action-server-side.svg b/site/docs/services/omes/engine-services-survey-action-server-side.svg index 96d92067b7..e2010689af 100644 --- a/site/docs/services/omes/engine-services-survey-action-server-side.svg +++ b/site/docs/services/omes/engine-services-survey-action-server-side.svg @@ -1,4 +1,4 @@ -
Engine Host OMAG Server
Engine Host OMAG Server
Engine Host Services
Engine Host Services
Metadata Server
Metadata Server
Out
Topic
Out...
Listener
Listener
Request
Handler
Request...
Governance Engine
OMAS Client
Governance Engine...
REST API calls
REST API calls
OutTopic
Events
OutTopic...
Configuration
Handler
Configuration...
Governance Engine
OMAS
Governance Engine...
REST API
REST API
Stewardship Action OMAS
Stewardship Action...
REST API calls
REST API calls
Admin
Admin
REST API
REST API
Survey
Action
Engine
Service
Survey...
Admin
Admin
REST API
REST API
Survey Action Engine Handler
Survey Action Engine Handler
Governance Services Map
Governance Services Map
Stewardship
Action
OMAS
Client
Stewardship...
Governance
Service
Handler
Governance...
Governance
Service
Handler
Governance...
Survey Action
Service
Handler
Survey Action...
Audit Log (Repository Services)
Audit Log (Repository Services)Text is not SVG - cannot display \ No newline at end of file +
Engine Host OMAG Server
Engine Host Services
Metadata Server
Out
Topic
Listener
Request
Handler
Governance Server
OMAS Client
REST API calls
OutTopic
Events
Configuration
Handler
Governance Server
OMAS
REST API
Asset Owner OMAS
REST API calls
Admin
REST API
Survey
Action
Engine
Service
Admin
REST API
Survey Action Engine Handler
Governance Services Map
Asset
Owner
OMAS
Client
Governance
Service
Handler
Governance
Service
Handler
Survey Action
Service
Handler
Audit Log (Repository Services)
 \ No newline at end of file diff --git a/site/docs/services/omes/engine-services.drawio b/site/docs/services/omes/engine-services.drawio index bf79875bbe..58ea1f310c 100644 --- a/site/docs/services/omes/engine-services.drawio +++ b/site/docs/services/omes/engine-services.drawio @@ -1,6 +1,6 @@ - + - + @@ -10,7 +10,7 @@ - + @@ -58,7 +58,7 @@ - + @@ -90,14 +90,14 @@ - + - + @@ -124,9 +124,9 @@ - + - + @@ -212,7 +212,7 @@ - + @@ -251,7 +251,7 @@ - + @@ -276,7 +276,7 @@ - + @@ -360,7 +360,7 @@ - + @@ -393,7 +393,7 @@ - + @@ -405,7 +405,7 @@ - + @@ -415,7 +415,7 @@ - + @@ -456,7 +456,7 @@ - + @@ -465,7 +465,7 @@ - + @@ -479,7 +479,7 @@ - + @@ -518,7 +518,7 @@ - + @@ -543,7 +543,7 @@ - + @@ -637,17 +637,6 @@ - - - - - - - - - - - @@ -655,7 +644,7 @@ - + @@ -672,7 +661,7 @@ - + @@ -683,22 +672,10 @@ - - - - - - - - - - - - - + @@ -849,7 +826,7 @@ - + @@ -874,14 +851,14 @@ - + - - + + @@ -949,95 +926,95 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1046,57 +1023,79 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/services/omes/index.md b/site/docs/services/omes/index.md index 3129466136..512dca0790 100644 --- a/site/docs/services/omes/index.md +++ b/site/docs/services/omes/index.md @@ -8,16 +8,22 @@ hide: # Open Metadata Engine Services (OMES) -The engine services are each able to host a specific type of [governance engine](/concepts/governance-engine). +The engine services run in the [engine host](/concepts/engine-host). They provide the special services that are available to the [governance services](/concepts/governance-services) through their context. There is an engine service for each type of governance service. Each engine service also maps the calls from the governance service to calls to the services of a [metadata access server](/concepts/metadata-access-server). The table below summarizes the engine services, the type of governance service they support and the service on the metadata access server that they call. -Broadly there are three types of governance engines: +| Name of the Engine Service | Type of Governance Service supported | Partner service in the metadata | +|-----------------------------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------| +| [Survey Action OMES](/services/omes/survey-action/overview) | [Survey Action Service](/concepts/survey-action-service) | [Asset Owner OMAS](/services/omas/asset-owner/overview) | +| [Governance Action OMES](/services/omes/governance-action/overview) | [Governance Action Service](/concepts/governance-action-service) | [Governance Engine OMAS](/services/omas/governance-engine/overview) | +| [Event Action OMES](/services/omes/event-action/overview) | [Event Action Service](/concepts/event-action-service) | [Data Science OMAS](/services/omas/data-science/overview) | +| [Repository Governance OMES](/services/omes/repository-governance/overview) | [Repository Governance Service](/concepts/repository-governance-service) | [Repository Governance OMAS](/services/omrs) | +| [Asset Analysis OMES](/services/omes/asset-analysis/overview) (Deprecated) | [Open Discovery Service](/concepts/open-discovery-service) | [Discovery Engine OMAS](/services/omas/discovery-engine/overview) | -- *[Open discovery engines](/concepts/open-discovery-engine)* that run automatic metadata discovery requests to analyze the content of an [asset's](/concepts/asset) real-world [resource](/conceepts/resource) counterpart. They implement the engine interface defined in the [Open Discovery Framework (ODF)](/frameworks/odf/overview). -- *[Governance action engines](/concepts/governance-action-engine)* that manage the processing supporting governance processing such as the resolution of issues reported in the open metadata ecosystem or the assets it supports. They implement the engine interface defined in the [Governance Action Framework (GAF)](/frameworks/gaf/overview). +The diagram below shows the generic picture of an engine service plugged into the Engine Host. The [engine host services](/services/engine-host-services) provide most of the capability of the Engine Host. This includes managing the retrieval of the [governance engine definitions](/concepts/governance-engine-definition) from the metadata access server that map the engine action requests to calls to the governance services. -- *[Repository governance engines](/concepts/repository-governance-engine)* that govern open metadata repository such as maintain [Open Metadata Archives](/concepts/open-meetadata-archive) based on the live content of the open metadata repositories. +The engine services each provide an implementation of the governance engine handler that is able to run a particular type of governance service. When an [engine action](/concepts/engine-action) is initiated, the engine host services receives it, claims it, selects the right engine handler and passes the engine action to it. The governance engine handler runs the governance service through its governance service handler, making calls to the partner service as required. It records the outcome in the engine outcome in the metadata access server. + +![Engine Host Internals](engine-services-engine-host-internals.svg) -These engines are supported by the [Asset Analysis OMES](/services/omes/asset-analysis/overview), [Governance Action OMES](/services/omes/governance-action/overview) and [Repository Governance OMES](/services/omes/repository-governance/overview) respectively. --8<-- "snippets/abbr.md"