From 69bf5c66711fd21376019c99ca1c941a654279d9 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Thu, 10 Aug 2023 15:52:22 +0100 Subject: [PATCH] Add new server-operations module Signed-off-by: Mandy Chessell --- .../resource/jdbc-resource-connector.md | 6 +++++ .../open-metadata-for-common-definitions.md | 8 +++++++ .../common-data-definitions/overview.md | 8 ++++++- site/docs/services/gaf-metadata-management.md | 10 ++------- site/docs/services/oms-metadata-management.md | 22 +++++++++++++++++++ site/docs/services/server-chassis.md | 13 ++++++++++- site/docs/services/server-operations.md | 15 +++++++++++++ site/docs/types/0/0036-Storage.md | 10 ++++----- site/mkdocs.yml | 6 ++++- 9 files changed, 82 insertions(+), 16 deletions(-) create mode 100644 site/docs/services/oms-metadata-management.md create mode 100644 site/docs/services/server-operations.md diff --git a/site/docs/connectors/resource/jdbc-resource-connector.md b/site/docs/connectors/resource/jdbc-resource-connector.md index dc11e6e690..0322a7b21d 100644 --- a/site/docs/connectors/resource/jdbc-resource-connector.md +++ b/site/docs/connectors/resource/jdbc-resource-connector.md @@ -5,6 +5,12 @@ # JDBC Resource Connector +???+ info "Connector summary" + - Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector) + - Source Module: [jdbc resource connector :material-github:](https://github.com/odpi/egeria-database-connectors/tree/main/jdbc-resource-connector){ target=gh }. + - Jar File Name: `jdbc-resource-connector.jar` + + The JDBC Resource Connector provides a DataSource, which in turn is used to get a connection to underlying database. It provides access to both the schema metadata and the business data content. ![Figure 1](jdbc-resource-connector.svg) diff --git a/site/docs/practices/common-data-definitions/open-metadata-for-common-definitions.md b/site/docs/practices/common-data-definitions/open-metadata-for-common-definitions.md index 900626135a..95fb07be53 100644 --- a/site/docs/practices/common-data-definitions/open-metadata-for-common-definitions.md +++ b/site/docs/practices/common-data-definitions/open-metadata-for-common-definitions.md @@ -1,6 +1,14 @@ +--- +hide: +- toc +--- + + + + # Building Subject Area materials Egeria provides a comprehensive set of [open metadata types](/types) for managing [common data definitions](/practices/common-data-definitions/overview). These types provide a common language and format for exchanging these definitions between tools and metadata repositories. Each tool/repository provides a mapping to the Egeria types and Egeria manages the exchange of metadata between these parties. diff --git a/site/docs/practices/common-data-definitions/overview.md b/site/docs/practices/common-data-definitions/overview.md index 2ddbf18774..572c9a4ee9 100644 --- a/site/docs/practices/common-data-definitions/overview.md +++ b/site/docs/practices/common-data-definitions/overview.md @@ -1,3 +1,9 @@ +--- +hide: +- toc +--- + + @@ -13,7 +19,7 @@ Typically, the common data definitions consist of: * Definitions of the valid data values for specific concepts and associated governance rules. * Preferred logical and physical data formats for storing data about these concepts. -The common data definitions in open metadata are part of the *Subject Area Materials* and are grouped into [subject areas](/concepts/subject-area). The core materials that cover the meaning of data are described in one or more [glossaries](/practices/common-data-definitions/anatomy-of-a-glossary).These are augmented by valid values, reference data and quality rules. +The common data definitions in open metadata are part of the *Subject Area Materials* and are grouped into [subject areas](/concepts/subject-area). The core materials that cover the meaning of data are described in one or more [glossaries](/practices/common-data-definitions/anatomy-of-a-glossary). These are augmented by [valid values](/practices/common-data-definitions/open-metadata-for-common-definitions), [reference data](/practices/common-data-definitions/open-metadata-for-common-definitions) and [quality rules](/practices/common-data-definitions/open-metadata-for-common-definitions). [Governance action classifications](/types/4/0422-Governance-Action-Classifications) may be added to these definitions which in turn link to governance requirements. This determines how data that is linked to the subject area material should be governed. diff --git a/site/docs/services/gaf-metadata-management.md b/site/docs/services/gaf-metadata-management.md index d39d2063f2..c068ac8bdc 100644 --- a/site/docs/services/gaf-metadata-management.md +++ b/site/docs/services/gaf-metadata-management.md @@ -10,13 +10,7 @@ hide: # GAF Metadata Management -GAF metadata management provides the *Metadata Store Services* that are -defined by the [Governance Action Framework (GAF)](/frameworks/gaf/overview) and are available through all -[Open Metadata Access Services (OMASs)](/services/omas). - -GAF metadata management also provides a comprehensive interface for working with all types of metadata, subject to the user's (and the associated OMAS's) security permissions. -the interface supports search, maintenance of metadata elements, classifications and relationships plus the ability to raise incident reports -and todos along with the ability to work with metadata valid values and translations. - +GAF metadata management provides the context services +defined by the [Governance Action Framework (GAF)](/frameworks/gaf/overview). --8<-- "snippets/abbr.md" diff --git a/site/docs/services/oms-metadata-management.md b/site/docs/services/oms-metadata-management.md new file mode 100644 index 0000000000..39ca4190ac --- /dev/null +++ b/site/docs/services/oms-metadata-management.md @@ -0,0 +1,22 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/stable.md" + +# Open Metadata Store (OMS) Metadata Management + +OMS metadata management provides the *Metadata Store Services* that are +consumed by the [Open Connector Framework (OCF)](/frameworks/ocf/overview), [Open Integration Framework (OIF)](/frameworks/oif/overview), [Open Discovery Framework (ODF)](/frameworks/odf/overview), [Governance Action Framework (GAF)](/frameworks/gaf/overview) and are available through all +[Open Metadata Access Services (OMASs)](/services/omas). + +OMS metadata management also provides a comprehensive interface for working with all types of metadata, subject to the user's (and the associated OMAS's) security permissions. +the interface supports search, maintenance of metadata elements, classifications and relationships plus the ability to raise incident reports +and todos along with the ability to work with metadata valid values and translations. + + +--8<-- "snippets/abbr.md" diff --git a/site/docs/services/server-chassis.md b/site/docs/services/server-chassis.md index 46ca0c5940..0f12c47a79 100644 --- a/site/docs/services/server-chassis.md +++ b/site/docs/services/server-chassis.md @@ -1,4 +1,15 @@ +--- +hide: +- toc +--- + ---8<-- "docs/services/platform-chassis.md" +--8<-- "snippets/content-status/in-development.md" + +## Server Chassis + +The server chassis provides the base for a Spring application that runs a single [OMAG Server](/concepts/omag-server) in a cloud native style. + +--8<-- "snippets/abbr.md" diff --git a/site/docs/services/server-operations.md b/site/docs/services/server-operations.md new file mode 100644 index 0000000000..5bf504bff4 --- /dev/null +++ b/site/docs/services/server-operations.md @@ -0,0 +1,15 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/stable.md" + +# Server Operations + +Server operations provides support to start up and shutdown [OMAG Servers](/concepts/omag-server) within either the [Platform Chassis](/services/platform-chassis) or [Server Chassis](/services/server-chassis). + +--8<-- "snippets/abbr.md" diff --git a/site/docs/types/0/0036-Storage.md b/site/docs/types/0/0036-Storage.md index 1058e2a832..c5fb074c61 100644 --- a/site/docs/types/0/0036-Storage.md +++ b/site/docs/types/0/0036-Storage.md @@ -3,16 +3,16 @@ # 0036 Storage -It is common for the processing running on a [`Host`](/types/0/0030-Hosts-and-Platforms/#host) to need to persist data to storage. +It is common for the processing running on a [*Host*](/types/0/0030-Hosts-and-Platforms/#host) to need to persist data to storage. ![UML](0036-Storage.svg) -## StorageVolume +## StorageVolume entity -*`StorageVolume`* describes a persistent storage volume. +*StorageVolume* describes a persistent storage volume. -## AttachedStorage +## AttachedStorage relationship -*`AttachedStorage`* identifies the host(s) that the `StorageVolume` is connected to. +*AttachedStorage* identifies the host(s) that the StorageVolume is connected to. --8<-- "snippets/abbr.md" diff --git a/site/mkdocs.yml b/site/mkdocs.yml index cd76731146..52168caba7 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -50,6 +50,10 @@ nav: - Kafka Open Metadata Topic Connector: connectors/resource/kafka-open-metadata-topic-connector.md - In Memory Open Metadata Topic Connector: connectors/resource/in-mem-open-metadata-topic-connector.md - JDBC Connector: connectors/resource/jdbc-resource-connector.md + - Avro File Connector: connectors/resource/avro-file-resource-connector.md + - Basic File Connector: connectors/resource/basic-file-resource-connector.md + - CSV File Connector: connectors/resource/csv-file-resource-connector.md + - Data Folder Connector: connectors/resource/data-folder-resource-connector.md - Governance Actions: - Generic Element Watchdog: connectors/governance-action/generic-element-watchdog-governance-action-service.md - Generic Folder Watchdog: connectors/governance-action/generic-folder-watchdog-governance-action-service.md @@ -823,7 +827,7 @@ nav: - Governance Team: practices/coco-pharmaceuticals/scenarios/building-the-governance-team/overview.md - Information Supply Chains: practices/coco-pharmaceuticals/scenarios/defining-information-supply-chains/overview.md - Multi-Faceted Governance: practices/coco-pharmaceuticals/scenarios/defining-multi-faceted-governance/overview.md - - New Systems Archiecture: practices/coco-pharmaceuticals/scenarios/defining-new-systems-architecture-overview/overview.md + - New Systems Architecture: practices/coco-pharmaceuticals/scenarios/defining-new-systems-architecture-overview/overview.md - New Digital Service: practices/coco-pharmaceuticals/scenarios/new-clinical-trials-digital-service/overview.md - Receiving Patient Data: practices/coco-pharmaceuticals/scenarios/receiving-patient-data-from-a-hospital/overview.md - Subject Areas: practices/coco-pharmaceuticals/scenarios/defining-subject-areas/overview.md