Skip to content

Commit

Permalink
Merge pull request #8568 from mandy-chessell/oak2025
Browse files Browse the repository at this point in the history 
Updates to content pack readmes
  • Loading branch information
@mandy-chessell
mandy-chessell authored Jan 4, 2025
2 parents 32e113e + 6300164 commit bdfc759
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 57 deletions.
33 changes: 29 additions & 4 deletions content-packs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,42 @@ or [while the server is running](https://egeria-project.org/guides/operations/ad

They are as follows:

* **CoreContentPack** - contains the connector definitions for the open connectors supplied in this distribution along with the valid metadata values for the technologies they support.
* **[CoreContentPack](https://egeria-project.org/content-packs/core-content-pack/overview)** - contains the definitions for the file and open lineage connectors supplied in this distribution along with the valid metadata values for the technologies they support and useful governance action processes.
This content pack is designed to provide a good starting point for a new Egeria deployment.
It is loaded automatically in the *active-metadata-store* sample server.
As it loads, the integration connectors defined in its content start up in the *integration-daemon* server, and the governance engines it defines will start up in the *engine-host*.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **CloudInformationModel** - glossary from the **Cloud Information Model**'s
* **[ApacheAtlasContentPack](https://egeria-project.org/content-packs/apache-atlas-content-pack/overview)** - contains the connector definitions for the Apache Atlas connectors and governance services supplied in the *omag-server-platform* distribution along with the valid metadata values for the technologies they support. This content pack is designed to provide a good starting point for connecting Egeria to Apache Atlas.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[ApacheKafkaContentPack](https://egeria-project.org/content-packs/apache-kafka-content-pack/overview)** - contains the connector definitions for the Apache Kafka connectors and governance services supplied in the *omag-server-platform* distribution along with the valid metadata values for the technologies they support. This content pack is designed to provide a good starting point for connecting Egeria to Apache Kafka.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[APIsContentPack](https://egeria-project.org/content-packs/apis-content-pack/overview)** - contains the connector definitions for the connector the catalogs an open API through its swagger REST API. This connector is supplied in the *omag-server-platform* distribution. This content pack is designed to provide a good starting point for connecting Egeria to applications supporting the open API specification in order to build an API catalog.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[ObservabilityContentPack](https://egeria-project.org/content-packs/observability-content-pack/overview)** - contains the connector definitions for the connectors that capture observations about the open metadata ecosystem. These connectors are supplied in the *omag-server-platform* distribution. This content pack is designed to load a PostgreSQL database with key observations that can be used for building a dashboard.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[PostgreSQLContentPack](https://egeria-project.org/content-packs/postgres-content-pack/overview)** - contains the connector definitions for the PostgreSQL connectors and governance services supplied in the *omag-server-platform* distribution along with the valid metadata values for the technologies they support. This content pack is designed to provide a good starting point for connecting Egeria to PostgreSQL databases.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[UnityCatalogContentPack](https://egeria-project.org/content-packs/unity-catalog-content-pack/overview)** - contains the connector definitions for the Unity Catalog connectors and governance services supplied in the *omag-server-platform* distribution along with the valid metadata values for the technologies they support. This content pack is designed to provide a good starting point for connecting Egeria to Unity Catalog.
This content pack is built by the [core-content-pack](../open-metadata-resources/open-metadata-archives/core-content-pack) module.

* **[CloudInformationModel](https://egeria-project.org/content-packs/cim-content-pack/overview)** - glossary from the **Cloud Information Model**'s
[JSONLD formatted model](https://raw.githubusercontent.com/cloudinformationmodel/cloudinformationmodel/master/dist/model.jsonld).
The content covers basic commerce concepts such as Party, Product, Invoice and Shipping.
The cloud information project has been archived. However, this is a useful starter set glossary,
This content pack is built by the [cloud-information-model](../open-metadata-resources/open-metadata-samples/sample-metadata/cloud-information-model) module.

* **OpenMetadataTypes** - Archive of the open metadata types defined by Egeria.
* **[OpenMetadataTypes](https://egeria-project.org/content-packs/types-content-pack/overview)** - Archive of the open metadata types defined by Egeria.
This archive contains all the open metadata type definitions provided by Egeria.
It is supplied for external utilities since each OMAG server capable of being a cohort member will load these types on start up.
This content pack is built by the [open-metadata-types-utility](../open-metadata-resources/open-metadata-archives/open-metadata-types-utility) module using the definitions in the [open-metadata-types](../open-metadata-resources/open-metadata-archives/open-metadata-types) module.

* **CocoComboArchive** - supplies metadata to support the [Coco Pharmaceuticals scenarios](https://egeria-project.org/practices/coco-pharmaceuticals/).
* **[CocoComboArchive](https://egeria-project.org/content-packs/coco-content-pack/overview)** - supplies metadata to support the [Coco Pharmaceuticals scenarios](https://egeria-project.org/practices/coco-pharmaceuticals/).
It is a useful content pack to load when experimenting with Egeria's capabilities since it provides examples of many
types of open metadata. In addition, this metadata is also available in the following archives that are used in the
[Open Metadata Labs](https://egeria-project.org/education/open-metadata-labs/overview/)
Expand All @@ -49,6 +71,8 @@ where different subsets of this metadata are loading into each of the servers.
* **CocoTypesArchive** - provides additional types for Coco Pharmaceuticals. These are `BiopsyScope` Enum, `BiopsyReport` Entity, `BiopsySupportingEvidence` Relationship and
`ReviewedByClinicalTrials` Classification.

These content packs are built by the [coco-metadata-archives](../open-metadata-resources/open-metadata-samples/sample-metadata/coco-metadata-archives) module.

* **SimpleCatalog** - provides an example of a database, an API and an event structure linked to a glossary term.
It is loaded automatically in the *simple-metadata-store* sample server.
SimpleCatalog is also supplied as four archives for use in a demo showing 4 metadata access servers connected together in a single cohort.
Expand All @@ -64,6 +88,7 @@ These archives are used in the *Development labs* which are part of the [Open Me

* **SimpleGovernanceCatalog** - A glossary term linked to metadata elements in the API, Event, Data catalogs.

These content packs are built by the [simple-catalogs](../open-metadata-resources/open-metadata-samples/sample-metadata/simple-catalogs) module.

----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Expand Down
14 changes: 13 additions & 1 deletion open-metadata-resources/open-metadata-archives/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@
The [open metadata archives](https://egeria-project.org/concepts/open-metadata-archive) provide pre-canned content (open metadata types and instances) to load into an open metadata
repository.

There are three basic use cases:

### 1) Load canned content from standards organizations or other suppliers
![Load canned content from standards organizations or other suppliers](docs/open-metadata-archives-use-cases-1.png)

### 2) Export metadata to send with data so it can be imported at data's destination
![Export metadata to send with data so it can be imported at data's destination](docs/open-metadata-archives-use-cases-2.png)

### 3) Selective back up of metadata
![Selective back up of metadata](docs/open-metadata-archives-use-cases-3.png)


## Supported utilities for open metadata archives

Egeria supports the following open metadata archives. Associated with each archive
Expand All @@ -20,7 +32,7 @@ There is also a utility to create the archive file for these open metadata types
The find out more about the Open Metadata Types [click here](https://egeria-project.org/types).

* [Core Content Pack](core-content-pack) - provides utilities for building the
open metadata archive containing reference information information about one or more connectors that
open metadata archives containing reference information information about one or more connectors that
follow the [Open Connector Framework (OCF)](../../open-metadata-implementation/frameworks/open-connector-framework).

* [Design Model Archives](design-model-archives) - provides utilities to manage common/standard model content from third parties.
Expand Down
1 change: 1 addition & 0 deletions open-metadata-resources/open-metadata-archives/core-content-pack/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This module implements a utility to build the technology-specific [open metadata

These archives contain the metadata descriptions for each of the connectors supplied by Egeria, along with associated templates and reference data.

Full details of the contents of these archives can be found in the [Content Pack Catalog](https://egeria-project.org/content-packs/).

----

Expand Down
15 changes: 4 additions & 11 deletions open-metadata-resources/open-metadata-archives/design-model-archives/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,18 @@
# Design Model Archives

The Design Model Archives provide utilities for loading common/standard design models from third parties.
Currently Egeria has two examples:

* [The Cloud Information Model](https://cloudinformationmodel.org) that provides an open source data model and glossary
related to commerce activities.
* [The Owl Canonical Glossary model](glossary-canonical-model/docs/owlcanonicalglossarymodel/README.md) that The Owl Canonical Glossary model that provides the ability to
create an Egeria Archive from a Canonical Glossary defined using open standards like [Owl](https://www.w3.org/OWL/).

Each model has a `writer` class that generates an [Open Metadata Archive](..)
This can be loaded into an open metadata repository either at each server start
(by adding the archive to the configuration document) or a one time load
while the server is running.
The [OWL Canonical Glossary model](glossary-canonical-model/docs/owlcanonicalglossarymodel/README.md) provides the ability to
create an Egeria Archive from a Canonical Glossary defined using [OWL](https://www.w3.org/OWL/).
This is an experimental archive builder using a restricted dialect of OWL. There is an example in `test/resources`.

If the design model is being maintained and developed, the writer
class may be scheduled to periodically recreate the open metadata archive
with the latest content. This can then be reloaded once the server is running,
or at next server restart if the archive is configured in the server's configuration
document.

The same archive can be loaded multiple times in the server because
The same archive can be loaded multiple times in the server without ill-effect because
the writer records the unique identifiers ([GUIDs](https://egeria-project.org/concepts/guid))
for each element in the archive in a file. As long as that file is available
to the writer, it will use the same GUID for each element and the
Expand Down
51 changes: 10 additions & 41 deletions open-metadata-resources/open-metadata-archives/open-metadata-types/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,51 +13,20 @@ It uses the Open Metadata Repository Services (OMRS) archive building
classes `OMRSArchiveBuilder` and `OMRSArchiveHelper` found in the `repository-services-archive-utilities` module.

The types for each release are managed in separate classes. For example:
* `OpenMetadataTypesArchive` - new candidate types for current release
* `OpenMetadataTypesArchive2_11` - approved types added for [2.11 release](../../../release-notes/release-notes-2-11.md)
* `OpenMetadataTypesArchive2_10` - approved types added for [2.10 release](../../../release-notes/release-notes-2-10.md)
* `OpenMetadataTypesArchive2_9` - approved types added for [2.9 release](../../../release-notes/release-notes-2-9.md)
* `OpenMetadataTypesArchive2_8` - approved types added for [2.8 release](../../../release-notes/release-notes-2-8.md)
* `OpenMetadataTypesArchive2_7` - approved types added for [2.7 release](../../../release-notes/release-notes-2-7.md)
* `OpenMetadataTypesArchive2_6` - approved types added for [2.6 release](../../../release-notes/release-notes-2-6.md)
* `OpenMetadataTypesArchive2_5` - approved types added for [2.5 release](../../../release-notes/release-notes-2-5.md)
* `OpenMetadataTypesArchive2_4` - approved types added for [2.4 release](../../../release-notes/release-notes-2-4.md)
* `OpenMetadataTypesArchive2_0` - approved types added for [2.0 release](../../../release-notes/release-notes-2-0.md)
* `OpenMetadataTypesArchive1_7` - approved types added for [1.7 release](../../../release-notes/release-notes-1-7.md)
* `OpenMetadataTypesArchive1_6` - approved types added for [1.6 release](../../../release-notes/release-notes-1-6.md)
* `OpenMetadataTypesArchive1_5` - approved types added for [1.5 release](../../../release-notes/release-notes-1-5.md)
* `OpenMetadataTypesArchive1_4` - approved types added for [1.4 release](../../../release-notes/release-notes-1-4.md)
* `OpenMetadataTypesArchive1_3` - approved types added for [1.3 release](../../../release-notes/release-notes-1-3.md)
* `OpenMetadataTypesArchive1_2` - approved types added for releases before 1.3

* `OpenMetadataTypesArchive` - new candidate types for current release
* `OpenMetadataTypesArchive5_2` - approved types added for 5.2 release
* `OpenMetadataTypesArchive5_1` - approved types added for 5.2 release
* :
* `OpenMetadataTypesArchive1_3` - approved types added for 1.3 release
* `OpenMetadataTypesArchive1_2` - approved types added for releases before 1.3

The approved types can only be changed through official patches.

It is possible to add new types by creating a similar Java class to `OpenMetadataTypesArchive` that defines
and maintains the additional types that you would like to define.

If you would like your new types to extend the open metadata types, set the open metadata archive as an
archive that your new archive depends on ...

```
List<OpenMetadataArchive> dependentOpenMetadataArchives = new ArrayList<>();
dependentOpenMetadataArchives.add(new OpenMetadataTypesArchive().getOpenMetadataArchive());
this.archiveBuilder = new OMRSArchiveBuilder(archiveGUID,
archiveName,
archiveDescription,
archiveType,
originatorName,
originatorLicense,
creationDate,
dependentOpenMetadataArchives);
```

This approach is used in the `design-model-archives` that create archives with glossary and model content
that follow the open metadata types.
and maintains the additional types that you would like to define. This is described in [Defining new types](https://egeria-project.org/guides/developer/open-metadata-archives/defining-new-types/).

You can create a JSON formatted archive file containing the open metadata types by running the
[`OpenMetadataTypesArchiveWriterUtility`](../open-metadata-types-utility).
You can create a JSON formatted archive file containing the open metadata types by running the
[`OpenMetadataTypesArchiveWriterUtility`](../open-metadata-types-utility). The output is located in the `content-packs` directory and is included in the next build.

----

Expand Down

0 comments on commit bdfc759

Please sign in to comment.