From c35771a7d33892bd2c5f23e06a1e45dcfe440277 Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Tue, 12 Dec 2023 19:57:04 +0000 Subject: [PATCH] Update functional stack Signed-off-by: Mandy Chessell --- ...deployment-resources-functional-detail.svg | 4 ++-- .../deployment-runtimes-functional-detail.svg | 4 ++++ .../developer-platform-functional-detail.svg | 4 ++-- site/docs/release-notes/egeria-status.drawio | 2 +- site/docs/release-notes/roadmap.md | 24 ++++++++++++++++++- 5 files changed, 32 insertions(+), 6 deletions(-) create mode 100644 site/docs/release-notes/deployment-runtimes-functional-detail.svg diff --git a/site/docs/release-notes/deployment-resources-functional-detail.svg b/site/docs/release-notes/deployment-resources-functional-detail.svg index 97c0d2fcf4..c1aaec7181 100644 --- a/site/docs/release-notes/deployment-resources-functional-detail.svg +++ b/site/docs/release-notes/deployment-resources-functional-detail.svg @@ -1,4 +1,4 @@ - + -
Deployment Resources
Deployment...
Kubernetes Operator
Kubernetes Operator
Kubernetes Helm Charts
Kubernetes Helm ChartsText is not SVG - cannot display \ No newline at end of file +
Deployment Resources
Deployment...
Kubernetes Operator
Kubernetes Operator
Kubernetes Helm Charts
Kubernetes Helm Charts
Docker Image
Docker ImageText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/release-notes/deployment-runtimes-functional-detail.svg b/site/docs/release-notes/deployment-runtimes-functional-detail.svg new file mode 100644 index 0000000000..4d9c54dc0c --- /dev/null +++ b/site/docs/release-notes/deployment-runtimes-functional-detail.svg @@ -0,0 +1,4 @@ + + + +
Deployment Runtimes
Deployment...
Egeria UI Application
Egeria UI Application
OMAG Server
OMAG Server
OMAG Server Platform
OMAG Server PlatformText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/release-notes/developer-platform-functional-detail.svg b/site/docs/release-notes/developer-platform-functional-detail.svg index b30ed97a03..f3e2748eca 100644 --- a/site/docs/release-notes/developer-platform-functional-detail.svg +++ b/site/docs/release-notes/developer-platform-functional-detail.svg @@ -1,4 +1,4 @@ - + -
Developer Platform
Developer Platform
Open Metadata and Governance (OMAG) Registered Services
Open Metadata and Governance (OMAG) Registered Services
Open Metadata Frameworks
Open Metadata Frameworks
Open Connector
Framework (OCF)
Open Connector...
Open Discovery
Framework (ODF)
Open Discovery...
Governance Action Framework (GAF)
Governance Action Fram...
Audit Log
Framework (ALF)
Audit Log...
Open Metadata and Governance (OMAG) Server Platform
Open Metadata and Governance (OMAG) Server Platform
Content
Content
Open Metadata Types
Open Metadat...
Governance Server Services
Governance Server Services
Platform Services
Platform Services
Multi-tenancy Management
Multi-tenancy Management
Generic Handlers
Generic Handlers
Metadata Security
Metadata Security
Administration Services
Administration Services
Server Chassis
Server Chassis
Repository Services
Repository Services
Open Integration
Framework (OIF)
Open Integration...
Framework Services
Framework Services
Connected Asset
Connected Asset
Open Metadata Store
Open Metadata Store
Open Integration Service
Open Integration Service
Open Discovery Service
Open Discovery Service
Engine Services
Engine Services
Access Services
Access Services
Integration Services
Integration Services
View Services
View ServicesText is not SVG - cannot display \ No newline at end of file +
Developer Platform
Developer Platform
Open Metadata and Governance (OMAG) Registered Services
Open Metadata and Governance (OMAG) Registered Services
Open Metadata Frameworks
Open Metadata Frameworks
Open Metadata and Governance (OMAG) Server Platform
Open Metadata and Governance (OMAG) Server Platform
Engine Services
Engine Services
Content
Content
Open Metadata Types
Open Metada...
Access Services
Access Services
Integration Services
Integration Services
View Services
View Services
Governance Server Services
Governance Server Services
Ops and Platform Services
Ops and Platform Services
Multi-tenancy Management
Multi-tenancy Management
Generic Handlers
Generic Handlers
Metadata Security
Metadata Security
Administration Services
Administration Services
Platform/Server Chassis
Platform/Server Chassis
Repository Services
Repository Services
Framework Services
Framework Services
Connected Asset
Connected Asset
Open Metadata Store
Open Metadata Store
Open Integration Service
Open Integration Service
Open Connector Framework (OCF)
Open Connector Framework (OCF)
Audit Log Framework (ALF)
Audit Log Framework (ALF)
Open Integration Framework (OIF)
Open Integration Framework (OIF)
Open Discovery Framework (ODF)
Open Discovery Framework (ODF)
Governance Action Framework (GAF)
Governance Action Framework (GAF)
Engine Action Framework (EAF)
Engine Action Framework (EAF)
Open Governance Service
Open Governance Service
View Services
View ServicesText is not SVG - cannot display \ No newline at end of file diff --git a/site/docs/release-notes/egeria-status.drawio b/site/docs/release-notes/egeria-status.drawio index 8126fc9f63..4512927a9a 100644 --- a/site/docs/release-notes/egeria-status.drawio +++ b/site/docs/release-notes/egeria-status.drawio @@ -1,4 +1,4 @@ - + diff --git a/site/docs/release-notes/roadmap.md b/site/docs/release-notes/roadmap.md index 9c424cb108..428d9f8267 100644 --- a/site/docs/release-notes/roadmap.md +++ b/site/docs/release-notes/roadmap.md @@ -14,6 +14,7 @@ Egeria aims to deliver against 6 capability layers: [![UIs](ui-functional-detail.svg)](#user-interfaces) [![Integration Platform](integration-platform-functional-detail.svg)](#integration-platform) [![Developer Platform](developer-platform-functional-detail.svg)](#developer-platform) +[![Deployment Runtimes](deployment-runtimes-functional-detail.svg)](#deployment-runtimes) [![Deployment Resources](deployment-resources-functional-detail.svg)](#deployment-resources) ### Governance solutions @@ -76,17 +77,25 @@ Its use is described in the [developer's guide](/guides/developer). - The [open metadata types](/types) provide definitions for the different types of metadata needed by an organization. The open metadata type system is extendable; however, by providing a comprehensive starter set, and encouraging tools to use them, Egeria ensures metadata can be seamlessly shared amongst them. - The [framework services](/services/framework-services) provide Egeria clients to support metadata retrieval for connectors defined by the [frameworks](/frameworks). + + - [Connected Asset](/services/ocf-metadata-management) supports the creation of connectors and the retrieval of metadata about the attached asset. + - [Open Metadata Store](/services/gaf-metadata-management) supports the retrieval and maintenance of any type of open metadata. + - [Open Integration Service](/services/oif-metadata-management) supports integration connectors + - [Open Governance Service](/service/gaf-metadata-management) supports the execution of [engine actions](/concepts/engine-action) and [governance action processes](/concepts/governance-action-process). + - The [OMAG Server Platform](/concepts/omag-server-platform) provides a multi-tenant runtime platform for [OMAG Servers](/concepts/omag-server). Each OMAG Server hosts the connectors along with the Egeria services to integrate third party technology. - The [platform chassis](/services/platform-chassis) uses Spring Boot to provide the web server and REST API support for the platform. + - The [server chassis](/services/server-chassis) uses Spring Boot to provide the web server and REST API support for a single OMAG Server. - The [administration services](/services/admin-services/overview) supports configuring the OMAG Platform and Servers. Details of how to use the admin services are provided in the [administration guide](/guides/admin/guide) - - The [platform services](/services/platform-services/overview) provide the means to start, stop and query the OMAG Servers and services running on an OMAG Server Platform. + - The [server operations](/services/server-operations) and [platform services](/services/platform-services/overview) provide the means to start, stop and query the OMAG Servers and services running on an OMAG Server Platform. - The [multi-tenancy management](/services/multi-tenant) module supports multiple OMAG Servers running on an OMAG Server Platform. - The [repository services](/services/omrs) provide the basic ability to share metadata between metadata repositories. The metadata repositories are organized into [open metadata repository cohorts](/concepts/cohort-member). These cohorts define the scope of the metadata sharing and ensure metadata is available to all consumers within the cohort. - The [metadata security](/services/metadata-security) module provides customizable authorization checks for calls to the OMAG Server Platform, OMAG Server and the open metadata instances themselves. - A governance server makes use of open metadata to actively manage an aspect of the digital landscape. The [governance server services :material-dock-window:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/governance-servers){ terget=gh } each provide the principle subsystem of a [type of governance server](/concepts/governance-server). - The [generic handlers](/services/generic-handlers) provide support for the type specific maintenance and retrieval of metadata that follows the [open metadata types](/types). This includes managing visibility of metadata through the [Governance Zones](/concepts/governance-zone/), calls to [Open Metadata Security](/features/metadata-security/overview/) and [metadata management using templates](/features/templated-cataloguing/overview/). + - The [open metadata frameworks](/frameworks) define the interfaces implemented by components that "plug-in" to Egeria, either to integrate calls to third party technology or extend the function of Egeria. The frameworks are as follows: - [Audit Log Framework (ALF)](/frameworks/alf/overview) - extensions for all types of connectors to enable natural language diagnostics such as exceptions and audit log messages. @@ -94,6 +103,19 @@ Its use is described in the [developer's guide](/guides/developer). - [Open Integration Framework (OIF)](/frameworks/oif/overview) - specialized connectors for metadata exchange and synchronization with third party technologies. - [Open Discovery Framework (ODF)](/frameworks/odf/overview) - specialized connectors called discovery services that support automated metadata discovery, - [Governance Action Framework (GAF)](/frameworks/gaf/overview) - specialized connectors for the triage and remediation of issues found in the digital landscape. + - [Event Action Framework (EAF)](/frameworks/eaf/overview) - specialized connectors for event management. + +### Deployment runtimes + +The runtimes package up the services to simplify the process of deploying Egeria's capability. + +![Deployment Runtimes](deployment-runtimes-functional-detail.svg) + +There are three runtimes: + +* [OMAG Server Platform](/concepts/omag-server-platform) provides support for running multiple [OMAG Servers](/concepts/omag-server). +* OMAG Server runtime provides support for running a single [OMAG Servers](/concepts/omag-server). +* Egeria UI Application is a deprecated runtime for the backend services for the Egeria General User UI. ### Deployment resources