From 8bf659e138b2b1ad92792897a5780556ebc93619 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Sat, 22 Jun 2024 17:22:09 +0100 Subject: [PATCH] Add Runtime Manager OMVS page Signed-off-by: Mandy Chessell --- .../user-interfaces/{index.md => overview.md} | 0 site/docs/services/omvs/index.md | 33 +++++++------- .../egeria-system-connectors.drawio | 43 +++++++++++++++++++ .../services/omvs/runtime-manager/overview.md | 21 +++++++++ site/mkdocs.yml | 2 +- 5 files changed, 82 insertions(+), 17 deletions(-) rename site/docs/guides/planning/user-interfaces/{index.md => overview.md} (100%) create mode 100644 site/docs/services/omvs/runtime-manager/egeria-system-connectors.drawio create mode 100644 site/docs/services/omvs/runtime-manager/overview.md diff --git a/site/docs/guides/planning/user-interfaces/index.md b/site/docs/guides/planning/user-interfaces/overview.md similarity index 100% rename from site/docs/guides/planning/user-interfaces/index.md rename to site/docs/guides/planning/user-interfaces/overview.md diff --git a/site/docs/services/omvs/index.md b/site/docs/services/omvs/index.md index 8f672dabdb..120723d215 100644 --- a/site/docs/services/omvs/index.md +++ b/site/docs/services/omvs/index.md @@ -7,22 +7,23 @@ The Open Metadata View Services (OMVS) provide task oriented, domain-specific se The view services are as follows: -| OMVS | Summary | Description | -|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [My Profile](/services/omvs/my-profile/overview) | **Locate, retrieve and update information relating to the calling user's profile.** | The My Profile OMVS is for user interfaces supporting a personalized experience. A registered user is able to maintain information about themselves, their roles and their network. | -| [Asset Catalog](/services/omvs/asset-catalog/overview) | **Search for assets.** | The Asset Catalog OMVS provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. | -| [Feedback Manager](/services/omvs/feedback-manager/overview) | **Maintain feedback such as comments, tags, reviews, likes and note logs.** | The Feedback Manager OMVS is for user interfaces supporting feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. | -| [Collection Manager](/services/omvs/collection-manager/overview) | **Manage collections of assets and other elements.** | The Collection Manager OMVS provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a *DigitalProduct* that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. | -| [Automated Curation](/services/omvs/automated-curation/overview) | **Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. | -| [Data Discovery](/services/omvs/data-discovery/overview) | **Documenting specifications that describe the data needed for a project.** | The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches. | -| [Action Author](/services/omvs/action-author/overview) | **Create and maintain governance actions.** | The Action Author OMVS is for user interfaces supporting the governance team to set up governance definitions and actions. | -| [Notification Manager](/services/omvs/notification-manager/overview) | **Locate, retrieve and update the types of user notifications that should be produced.** | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. | -| [Project Manager](/services/omvs/project-manager/overview) | **Locate, retrieve and update information relating to projects.** | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. | -| [Reference Data](/services/omvs/reference-data/overview) | **Create and maintain reference data values and their mappings.** | The Reference Data Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings. | | -| [Valid Metadata](/services/omvs/valid-metadata/overview) | **Create and maintain metadata valid values.** | The Valid Metadata Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that query and maintain lists of valid values for open metadata attributes as well as query open metadata type definitions. | | -| [Template Manager](/services/omvs/template-manager/overview) | **Create and maintain templates used to create new metadata elements.** | The Template Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata. | -| [Glossary Browser](/services/omvs/glossary-browser/overview) | **Search and view the contents of specific glossaries and their links to governance definitions and assets.** | The Glossary Browser OMVS is for user interfaces that wish to provide search facilities within a single glossary (or glossaries) along with the ability to browse the structure of the glossary and view an element within a glossary along with connected governance classifications, governance definitions, user feedback and attached assets. | -| [Glossary Manager](/services/omvs/glossary-manager/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Manager OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. | +| OMVS | Summary | Description | +|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [My Profile](/services/omvs/my-profile/overview) | **Locate, retrieve and update information relating to the calling user's profile.** | The My Profile OMVS is for user interfaces supporting a personalized experience. A registered user is able to maintain information about themselves, their roles and their network. | +| [Asset Catalog](/services/omvs/asset-catalog/overview) | **Search for assets.** | The Asset Catalog OMVS provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. | +| [Feedback Manager](/services/omvs/feedback-manager/overview) | **Maintain feedback such as comments, tags, reviews, likes and note logs.** | The Feedback Manager OMVS is for user interfaces supporting feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. | +| [Collection Manager](/services/omvs/collection-manager/overview) | **Manage collections of assets and other elements.** | The Collection Manager OMVS provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a *DigitalProduct* that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. | +| [Automated Curation](/services/omvs/automated-curation/overview) | **Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying.** | The Automated Curation OMVS is for user interfaces that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. | +| [Data Discovery](/services/omvs/data-discovery/overview) | **Documenting specifications that describe the data needed for a project.** | The Data Discovery Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) for documenting specifications that describe the data needed for a project. These are known as DataSpecs and they can be used to specify schemas for data pipelines as well as saved searches. | +| [Action Author](/services/omvs/action-author/overview) | **Create and maintain governance actions.** | The Action Author OMVS is for user interfaces supporting the governance team to set up governance definitions and actions. | +| [Notification Manager](/services/omvs/notification-manager/overview) | **Locate, retrieve and update the types of user notifications that should be produced.** | The Notification Manager OMVS is for user interfaces supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. | +| [Project Manager](/services/omvs/project-manager/overview) | **Locate, retrieve and update information relating to projects.** | The Project Manager OMVS is for user interfaces supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. | +| [Reference Data](/services/omvs/reference-data/overview) | **Create and maintain reference data values and their mappings.** | The Reference Data Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that maintain reference data values and their mappings. | | +| [Runtime Manager](/services/omvs/runtime-manager/overview) | **Retrieve status information about Egeria's OMAG Server Platform and OMAG Servers.** | The Runtime Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that displays operational status about Egeria. | | +| [Valid Metadata](/services/omvs/valid-metadata/overview) | **Create and maintain metadata valid values.** | The Valid Metadata Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that query and maintain lists of valid values for open metadata attributes as well as query open metadata type definitions. | | +| [Template Manager](/services/omvs/template-manager/overview) | **Create and maintain templates used to create new metadata elements.** | The Template Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that support the management of templates that are used when creating new metadata. | +| [Glossary Browser](/services/omvs/glossary-browser/overview) | **Search and view the contents of specific glossaries and their links to governance definitions and assets.** | The Glossary Browser OMVS is for user interfaces that wish to provide search facilities within a single glossary (or glossaries) along with the ability to browse the structure of the glossary and view an element within a glossary along with connected governance classifications, governance definitions, user feedback and attached assets. | +| [Glossary Manager](/services/omvs/glossary-manager/overview) | **Develop new glossary terms and categories in a controlled workflow process.** | The Glossary Manager OMVS is for user interfaces supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. | diff --git a/site/docs/services/omvs/runtime-manager/egeria-system-connectors.drawio b/site/docs/services/omvs/runtime-manager/egeria-system-connectors.drawio new file mode 100644 index 0000000000..be29d78c8b --- /dev/null +++ b/site/docs/services/omvs/runtime-manager/egeria-system-connectors.drawio @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/services/omvs/runtime-manager/overview.md b/site/docs/services/omvs/runtime-manager/overview.md new file mode 100644 index 0000000000..96db3f6da2 --- /dev/null +++ b/site/docs/services/omvs/runtime-manager/overview.md @@ -0,0 +1,21 @@ +--- +hide: +- toc +--- + + + + +--8<-- "snippets/content-status/in-development.md" + +# Runtime Manager OMVS + +The Runtime Manager Open Metadata View Services (OMVS) is a REST API designed to support user interfaces (UIs) that display status information about the Egeria infrastructure. + +---8<-- "snippets/abbr.md" + + + + + + diff --git a/site/mkdocs.yml b/site/mkdocs.yml index deae0af7a6..3829fe4dc4 100644 --- a/site/mkdocs.yml +++ b/site/mkdocs.yml @@ -27,7 +27,7 @@ nav: - Planning Deployment: - Planning Runtime: guides/planning/runtime/overview.md - Security: guides/planning/security/overview.md - - User Interfaces: guides/planning/user-interfaces/index.md + - User Interfaces: guides/planning/user-interfaces/overview.md - Preparing Metadata Ecosystem: - Metadata Valid Values: guides/planning/valid-values/overview.md - Language Translations: guides/planning/translations/overview.md