Skip to content

Commit

Permalink
Merge pull request #959 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history
Update to Lemmie Stage persona
  • Loading branch information
mandy-chessell authored Sep 26, 2024
2 parents c51d5dc + c256d6d commit 4e72baf
Show file tree
Hide file tree
Showing 20 changed files with 752 additions and 60 deletions.
63 changes: 55 additions & 8 deletions site/docs/connectors/connector-catalog.drawio
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<mxfile host="Electron" modified="2024-02-29T16:01:07.795Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/23.0.2 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="jSBiyM7fKfCQsmrP3Cdo" version="23.0.2" type="device" pages="26">
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.7.8 Chrome/128.0.6613.36 Electron/32.0.1 Safari/537.36" version="24.7.8" pages="27">
<diagram id="zwH0E6yuSuxNEa-D1nxI" name="compare-use-of-connectors">
<mxGraphModel dx="1242" dy="822" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
<root>
Expand Down Expand Up @@ -1212,6 +1212,41 @@
</root>
</mxGraphModel>
</diagram>
<diagram name="egeria-system-connectors" id="pWkxX-t_15Ol9sat2jne">
<mxGraphModel dx="1242" dy="806" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="pu5be3ToNUIvo1rdht3u-0" />
<mxCell id="pu5be3ToNUIvo1rdht3u-1" parent="pu5be3ToNUIvo1rdht3u-0" />
<mxCell id="pu5be3ToNUIvo1rdht3u-2" value="Integration Daemon" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="220" y="100" width="250" height="300" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-3" value="File Integrator OMIS" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="244" y="190" width="206" height="150" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="pu5be3ToNUIvo1rdht3u-1" source="pu5be3ToNUIvo1rdht3u-5" target="pu5be3ToNUIvo1rdht3u-7">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-5" value="Data Files Monitor&lt;br&gt;Integration Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="270" y="240" width="150" height="60" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-6" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="40" y="225" width="50" height="25" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-7" value="Monitored&lt;br&gt;Folder" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="40" y="240" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-8" value="Metadata Access Server" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="510" y="100" width="250" height="300" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-9" value="Data Manager OMAS" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" vertex="1" parent="pu5be3ToNUIvo1rdht3u-1">
<mxGeometry x="532" y="220" width="206" height="90" as="geometry" />
</mxCell>
<mxCell id="pu5be3ToNUIvo1rdht3u-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="pu5be3ToNUIvo1rdht3u-1" source="pu5be3ToNUIvo1rdht3u-3" target="pu5be3ToNUIvo1rdht3u-9">
<mxGeometry relative="1" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
<diagram id="Ojt3imM7iv8bhxuzIcUR" name="data-files-monitor-integration-connector">
<mxGraphModel dx="1242" dy="824" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
Expand Down Expand Up @@ -3720,28 +3755,40 @@
</mxGraphModel>
</diagram>
<diagram id="V6d9sc4AnHZE5M8D5nPL" name="secrets-store-connectors">
<mxGraphModel dx="1142" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<mxGraphModel dx="1242" dy="806" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="jxgSa6bsgg5_kzLXStgE-2" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
<mxCell id="jxgSa6bsgg5_kzLXStgE-2" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="125" y="260" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="jxgSa6bsgg5_kzLXStgE-3" value="Consuming Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#76608a;strokeColor=#432D57;fontColor=#ffffff;verticalAlign=top;" vertex="1" parent="1">
<mxCell id="jxgSa6bsgg5_kzLXStgE-3" value="Consuming Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#76608a;strokeColor=#432D57;fontColor=#ffffff;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="110" y="100" width="170" height="120" as="geometry" />
</mxCell>
<mxCell id="jxgSa6bsgg5_kzLXStgE-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="D11YjOCPVy-e2vAOVpYC-17" target="jxgSa6bsgg5_kzLXStgE-5">
<mxCell id="jxgSa6bsgg5_kzLXStgE-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="D11YjOCPVy-e2vAOVpYC-17" target="jxgSa6bsgg5_kzLXStgE-5" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="D11YjOCPVy-e2vAOVpYC-17" value="Environment Variable&lt;br&gt;Secrets Store Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
<mxCell id="D11YjOCPVy-e2vAOVpYC-17" value="Environment Variable&lt;br&gt;Secrets Store Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="124.88" y="140" width="140.25" height="65" as="geometry" />
</mxCell>
<mxCell id="jxgSa6bsgg5_kzLXStgE-5" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
<mxCell id="jxgSa6bsgg5_kzLXStgE-5" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="135" y="270" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="jxgSa6bsgg5_kzLXStgE-6" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
<mxCell id="jxgSa6bsgg5_kzLXStgE-6" value="Environment variable" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="145" y="280" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="smZqJnJgsjUjO1HoDnpI-2" value="Consuming Connector" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#76608a;strokeColor=#432D57;fontColor=#ffffff;verticalAlign=top;" vertex="1" parent="1">
<mxGeometry x="414" y="100" width="170" height="120" as="geometry" />
</mxCell>
<mxCell id="smZqJnJgsjUjO1HoDnpI-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="1" source="smZqJnJgsjUjO1HoDnpI-4" target="smZqJnJgsjUjO1HoDnpI-8">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="smZqJnJgsjUjO1HoDnpI-4" value="YAML File&lt;div&gt;Secrets Store Connector&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
<mxGeometry x="428.88" y="140" width="140.25" height="65" as="geometry" />
</mxCell>
<mxCell id="smZqJnJgsjUjO1HoDnpI-8" value="mySecrets.&lt;div&gt;omsecrets&lt;/div&gt;" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;" vertex="1" parent="1">
<mxGeometry x="459.01" y="260" width="80" height="100" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# PostgreSQL Database Survey Action Service

Surveys a PostgreSQL database, its tables and columns.

Its Jar file includes the PostgreSQL client driver.
21 changes: 21 additions & 0 deletions site/docs/connectors/egeria/omag-server-platform-connector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

--8<-- "snippets/content-status/tech-preview.md"

# OMAG Server Platform Connector

???+ info "Connector summary"
- Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector)
- Source Module: [egeria-system-connectors :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/system-connectors/egeria-system-connectors){ target=gh }
- Jar File Name: `egeria-system-connectors.jar`

Th OMAG Server Platform Connector is a [digital resource connector](/concepts/digital-resource-connector) that provides a Java interface to an [OMAG Server Platform](/concepts/omag-server-platform).

![Figure 1](apache-atlas-rest-connector.svg)
> **Figure 1:** Operation of the OMAG Server Platform Connector

--8<-- "snippets/abbr.md"

-
5 changes: 4 additions & 1 deletion site/docs/connectors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ The connectors that support the exchange and maintenance of metadata help to acc

### Secrets Stores

* The [Environment Variables Secret Store connector](/connectors/secrets/environment-variable-secrets-store-connector) retrieves secret values from environment variables.
[Secrets stores](/concepts/secrets-store-connector) externalize secrets such as passwords, tokens and certificates so they do not need to be stored in either the [configuration document](/concepts/configuration-document) or [open metadata repositories](/concepts/open-metadata-repository).

* The [Environment Variables Secret Store connector](/connectors/secrets/environment-variable-secrets-store-connector) retrieves secret values from environment variables.
* The [YAML File Secret Store connector](/connectors/secrets/yaml-secrets-store-connector) retrieves secret values from environment variables.

### Files

Expand Down
41 changes: 41 additions & 0 deletions site/docs/connectors/secrets/yaml-file-secrets-store-connector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->

--8<-- "snippets/content-status/tech-preview.md"

# YAML File Secrets Store Connector

!!! info "Connector details"
- Connector Category: [Secret Store Connector](/concepts/secrets-store-connector)
- Source Module: [yaml-secrets-store-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/secrets-store-connectors/yaml-secrets-store-connector){ target=gh }
- Jar File Name: `yaml-secrets-store-connector.jar`

## Overview

The *YAML File Secrets Store Connector* retrieves secrets from environment variables. The name of the secret requested is the name of the environment variable it tries to retrieve. It returns null if the environment variable is not defined.

![Figure 1](yaml-file-secrets-store-connector.svg)
> **Figure 1:** Operation of the YAML File Secrets Store Connector

## Configuration

This is its connection definition to embed into a connector's connection object.

!!! example "Connection configuration for the environment variable secrets store connector"
```json linenums="1" hl_lines="14"
{
"connection" :
{
"class" : "Connection",
"qualifiedName" : "Egeria:SecretsStoreConnector:YAML File Connection",
"connectorType" :
{
"class" : "ConnectorType",
"connectorProviderClassName" : "org.odpi.openmetadata.adapters.connectors.secretsstore.yaml.YAMLSecretsStoreProvider"
}
}
}
```

---8<-- "snippets/abbr.md"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions site/docs/content-packs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,41 @@

# Content Packs

The Egeria content packs provide a means to distribute standard metadata to different organizations. They are formatted as [Open Metadata Archives](/concepts/open-metadata-archive) and can be loaded using at server start up (see [Configuring the Start-up Archives](/guides/admin/servers/by-server-type/configuring-a-metadata-access-store)) or while the server is running (see [Runtime Manager OMVS](/services/omvs/runtime-manager/overview)).

The content packs are as follows:

* [CoreContentPack](/content-packs/core-content-pack/overview) - contains the connector definitions for the open connectors supplied in this distribution along with the valid metadata values for the technologies they support. 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.

* [CloudInformationModel](/content-packs/cim-content-pack/overview) - glossary from the Cloud Information Model's JSONLD formatted model. 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,

* [OpenMetadataTypes](/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.

* [CocoComboArchive](/content-packs/coco-content-pack/overview) - supplies metadata to support the Coco Pharmaceuticals scenarios. 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 where different subsets of this metadata are loading into each of the servers.

* CocoBusinessSystemsArchive provides a catalog of the business systems and the lineage between them and the load of their data into the data lake. This archive simulates the type of metadata expected from an ETL tool suite. It is intended for cocoMDS5 in the open metadata labs but can be used in any server.

* CocoOrganizationArchive - provides the profiles, user identifies and team of the featured personas of Coco Pharmaceuticals.

* CocoClinicalTrialsTemplatesArchive - provides the template assets used for onboarding weekly patient measurements during a clinical trial.

* CocoGovernanceProgramArchive - provides the metadata to describe Coco Pharmaceuticals governance program.

* CocoGovernanceEngineDefinitionsArchive - provides the metadata to describe Coco Pharmaceuticals three governance engines: AssetGovernance, AssetDiscovery and AssetQuality.

* CocoSustainabilityArchive - provides the base definitions for Coco Pharmaceutical's sustainability initiative.

* CocoTypesArchive - provides additional types for Coco Pharmaceuticals. These are BiopsyScope Enum, BiopsyReport Entity, BiopsySupportingEvidence Relationship and ReviewedByClinicalTrials Classification.

* [SimpleCatalog](/content-packs/simple-content-pack/overview) - 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. The archives are each loaded into a different server. It is then possible to show how the cohort integrates metadata from different catalogs. These archives are used in the Development labs which are part of the Open Metadata Labs.

* SimpleAPICatalog - API metadata typically found in an API catalog.

* SimpleDataCatalog - Database metadata typically found in an Data catalog.

* SimpleEventCatalog - Event metadata typically found in an API catalog.

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


--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Platform report for: https://localhost:9443
DevOps OMAS: Manage a DevOps pipeline
Software Developer OMAS: Interact with software development tools
Project Management OMAS: Manage governance related projects
Governance Engine OMAS: Set up an operational governance engine
Governance Server OMAS: Set up an operational governance engine
Data Privacy OMAS: Manage governance of privacy
Security Manager OMAS: Manages exchange of metadata with a security service
Repository Governance OMES: Maintains open metadata archives based on the activity in the connected cohorts.
Expand Down
Loading

0 comments on commit 4e72baf

Please sign in to comment.