Merge pull request #896 from mandy-chessell/code2024

Add description of the governance server OMAS
odpi · Feb 11, 2024 · 968dbed · 968dbed
2 parents 5bac984 + 26a5fbb
commit 968dbed
Show file tree

Hide file tree

Showing 28 changed files with 883 additions and 628 deletions.
diff --git 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
@@ -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
@@ -1,5 +1,10 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project 2020. -->
 
-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
@@ -6,10 +6,10 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
-# 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
@@ -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
@@ -1,7 +1,7 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
-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.