Skip to content

Commit

Permalink
Merge pull request #6442 from mandy-chessell/egeria-code
Browse files Browse the repository at this point in the history
Remove security-officer-connectors and links to access-services/docs and admin-services/docs
  • Loading branch information
mandy-chessell authored Apr 23, 2022
2 parents ccbd23f + 12f407e commit f9158a2
Show file tree
Hide file tree
Showing 105 changed files with 258 additions and 669 deletions.
10 changes: 5 additions & 5 deletions Content-Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The Egeria core repository contains the core Egeria functionality, and is organi
* **[ocf-metadata-management](open-metadata-implementation/common-services/ocf-metadata-management)** - provides metadata management for the [Open Connector Framework (OCF)](open-metadata-implementation/frameworks/open-connector-framework) properties and APIs.
* **[repository-handler](open-metadata-implementation/common-services/repository-handler)** - provides an enhanced set of services for accessing metadata from the [repository services](open-metadata-implementation/repository-services).

* **[engine-services](open-metadata-implementation/engine-services)** - services that host data management and governance engines. These run in the [Engine Host](open-metadata-implementation/admin-services/docs/concepts/engine-host.md) OMAG Server.
* **[engine-services](open-metadata-implementation/engine-services)** - services that host data management and governance engines. These run in the [Engine Host](https://egeria-project.org/concepts/engine-host) OMAG Server.
* **[asset-analysis](open-metadata-implementation/engine-services/asset-analysis)** - services that host [Open Discovery Framework (ODF)](open-metadata-implementation/frameworks/open-discovery-framework) discovery services.
* **[repository-governance](open-metadata-implementation/engine-services/repository-governance)** - services that host dynamic governance services for open metadata repositories.
* **[governance-action](open-metadata-implementation/engine-services/governance-action)** - services that host [Governance Action Framework (GAF)](open-metadata-implementation/frameworks/governance-action-framework) governance action services.
Expand All @@ -90,11 +90,11 @@ The Egeria core repository contains the core Egeria functionality, and is organi

* **[governance-servers](open-metadata-implementation/governance-servers)** - servers and daemons to run open metadata and governance function.
* **[data-engine-proxy-services](open-metadata-implementation/governance-servers/data-engine-proxy-services)** - supports automated metadata cataloguing from data engines.
* **[engine-host-services](open-metadata-implementation/governance-servers/engine-host-services)** - supports the core function of the [Engine Host](open-metadata-implementation/admin-services/docs/concepts/engine-host.md) OMAG Server.
* **[integration-daemon-services](open-metadata-implementation/governance-servers/integration-daemon-services)** - supports the core function of the [Integration Daemon](open-metadata-implementation/admin-services/docs/concepts/integration-daemon.md) OMAG Server.
* **[engine-host-services](open-metadata-implementation/governance-servers/engine-host-services)** - supports the core function of the [Engine Host](https://egeria-project.org/concepts/engine-host) OMAG Server.
* **[integration-daemon-services](open-metadata-implementation/governance-servers/integration-daemon-services)** - supports the core function of the [Integration Daemon](https://egeria-project.org/concepts/integration-daemon) OMAG Server.
* **[open-lineage-services](open-metadata-implementation/governance-servers/open-lineage-services)** - provides historic warehouse for lineage.

* **[integration-services](open-metadata-implementation/integration-services)** - services that host integration connectors. These run in the [Integration Daemon](open-metadata-implementation/admin-services/docs/concepts/integration-daemon.md) OMAG Server.
* **[integration-services](open-metadata-implementation/integration-services)** - services that host integration connectors. These run in the [Integration Daemon](https://egeria-project.org/concepts/integration-daemon) OMAG Server.
* **[analytics-integrator](open-metadata-implementation/integration-services/analytics-integrator)** - services to catalog analytics services.
* **[api-integrator](open-metadata-implementation/integration-services/api-integrator)** - services to catalog APIs supported by API Managers.
* **[catalog-integrator](open-metadata-implementation/integration-services/catalog-integrator)** - services to exchange metadata with asset managers and catalogs.
Expand All @@ -115,7 +115,7 @@ The Egeria core repository contains the core Egeria functionality, and is organi

* **[user-interfaces](open-metadata-implementation/user-interfaces)** - browser based user interfaces.

* **[view-services](open-metadata-implementation/view-services)** - services that provide services for user interfaces. These run in the [View Server](open-metadata-implementation/admin-services/docs/concepts/view-server.md) OMAG Server.
* **[view-services](open-metadata-implementation/view-services)** - services that provide services for user interfaces. These run in the [View Server](https://egeria-project.org/concepts/view-server) OMAG Server.

* **[open-metadata-resources](open-metadata-resources)** - contains the open metadata demos and samples.
* **[open-metadata-archives](open-metadata-resources/open-metadata-archives)** - contains pre-canned collections of metadata for loading into an open metadata server.
Expand Down
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Egeria Conformance program is supported by the
![Egeria Conformant Mark](open-metadata-conformance-suite/docs/egeria-conformance-mark.png)

The operation of the Egeria project is overseen by the
[ODPi's technical steering committee (TSC)](https://github.com/odpi/tsc).
[Egeria's technical steering committee (TSC)](https://wiki.lfaidata.foundation/display/EG/Egeria+Technical+Steering+Committee+%28TSC%29+Home).

If you are interested in joining the Egeria community,
see the [community guide](https://egeria-project.org/guides/community/) to find out more.
Expand Down
8 changes: 4 additions & 4 deletions content-packs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
The Egeria content packs provide a means to distribute standard metadata to different organizations.
They are formatted as [Open Metadata Archives](../open-metadata-resources/open-metadata-archives)
and can be loaded using the Administration Services
[at server start up](../open-metadata-implementation/admin-services/docs/user/configuring-the-startup-archives.md)
or [while the server is running](../open-metadata-implementation/admin-services/docs/user/operating-omag-server.md).
[at server start up](https://egeria-project.org/guides/admin/servers/configuring-the-startup-archives)
or [while the server is running](https://egeria-project.org/guides/operations/adding-archive-to-running-server).

They are as follows:

* **CloudInformationModel.json** - extracted metadata from the [Cloud Information Model](https://cloudinformationmodel.org)'s
* **CloudInformationModel.json** - extracted metadata from the **Cloud Information Model**'s
[JSONLD formatted model](https://raw.githubusercontent.com/cloudinformationmodel/cloudinformationmodel/master/dist/model.jsonld).

* **OpenConnectorsArchive** - Connector type metadata for connecting to data sources and other third party technology.

* **OpenMetadataTypes** - Archive of all of the open metadata types defined by Egeria.
* **OpenMetadataTypes** - Archive of the open metadata types defined by Egeria.

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

Expand Down
2 changes: 1 addition & 1 deletion developer-resources/languages/Java.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The JVM is supported on most operating systems and so Java programs can run
with the same behavior on almost any machine.
This portability of code is why Java is used
for the Egeria runtime -
the [OMAG Server Platform](../../open-metadata-implementation/admin-services/docs/concepts/omag-server-platform.md) -
the [OMAG Server Platform](https://egeria-project.org/concepts/omag-server-platform) -
and the clients.

If you want to run Egeria you need to install the **Java Runtime Environment (JRE)**.
Expand Down
2 changes: 1 addition & 1 deletion developer-resources/tools/Swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Swagger

Swagger automatically generates a website that documents the REST APIs supported by the
[OMAG Server Platform](../../open-metadata-implementation/admin-services/docs/concepts/omag-server-platform.md).
[OMAG Server Platform](https://egeria-project.org/omag-server-platform).
It is based on the [Open API Specification (V3)](http://spec.openapis.org/oas/v3.0.3).

The website is found at `<serverURLroot>/swagger-ui.html`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,13 @@ January 9th and 10th: Egeria Working Group meeting to discuss projects and archi
- Community Profile OMAS `REVIEW DOC` see below.
- MDM brings information in.

### Dev process for building OMAS (Mandy) See: [github](https://egeria.odpi.org/open-metadata-implementation/access-services/community-profile/docs/scenarios/)
### Dev process for building OMAS (Mandy)

- [A Rational Design Process: how and why to Fake it.](https://users.ece.utexas.edu/~perry/education/SE-Intro/fakeit.pdf)
- Review doc from mandy.
- [Design doc](https://egeria.odpi.org/open-metadata-implementation/access-services/docs/design/)
- [Design doc](https://egeria-project.org/guides/developer/#adding-registered-services)
- How to write a local connector? ask Graham
- [Concepts](https://egeria.odpi.org/open-metadata-implementation/access-services/docs/concepts)
- [Concepts](https://egeria-project.org/concepts)

### Subject Area (David)

Expand Down Expand Up @@ -178,7 +178,7 @@ January 9th and 10th: Egeria Working Group meeting to discuss projects and archi

### Role of Spine objects: (Maryna)

- [Tag Propagation](../../../../open-metadata-implementation/access-services/governance-engine/docs/TagPropogation/TagPropogation.md).
- Tag Propagation.
- typedBy in the role of spine objects.
- 9 Concepts/subjects (customer, sales, finance, operations, legal,... )
- Semantic modeling vs. structural modeling w/spine objects.
Expand Down
2 changes: 1 addition & 1 deletion open-metadata-conformance-suite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ behavior of an open metadata repository and the OMAG Platform.
There is a dedicated workbench for each of these test focuses:

* **[Platform Workbench](docs/platform-workbench)** - which tests the REST API of an
[Open Metadata and Governance (OMAG) Server Platform](../open-metadata-implementation/admin-services/docs/concepts/omag-server-platform.md)
[Open Metadata and Governance (OMAG) Server Platform](https://egeria-project.org/concepts/omag-server-platform)

* **[Repository Workbench](docs/repository-workbench)** - which tests both the repository services
[REST API](../open-metadata-implementation/repository-services/docs/component-descriptions/omrs-rest-services.md)
Expand Down
4 changes: 2 additions & 2 deletions open-metadata-conformance-suite/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The actual tests are run by an **open metadata conformance workbench** within th
Each workbench focuses on testing a specific type of technology.
Today there are 2 workbenches:
* **[Platform Workbench](platform-workbench)** - which tests the REST API of an
[Open Metadata and Governance (OMAG) Server Platform](../../open-metadata-implementation/admin-services/docs/concepts/omag-server-platform.md)
[Open Metadata and Governance (OMAG) Server Platform](https://egeria-project.org/concepts/omag-server-platform)

* **[Repository Workbench](repository-workbench)** - which tests both the repository services
[REST API](../../open-metadata-implementation/repository-services/docs/component-descriptions/omrs-rest-services.md)
Expand All @@ -34,7 +34,7 @@ The requested workbenches will begin to execute their tests as soon as the OMAG

For example, to run a metadata repository through the Repository Workbench, first configure a CTS
server in the OMAG Server Platform by [configuring its general properties like server type, event bus, cohort,
etc](../../open-metadata-implementation/admin-services/docs/user/README.md). Before starting the CTS server instance,
etc](https://egeria-project.org/guides/admin/servers). Before starting the CTS server instance,
configure the repository workbench within it by POSTing to:

```
Expand Down
24 changes: 7 additions & 17 deletions open-metadata-implementation/access-services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ the subject area definition.

## Using the OMASs

The OMASs run in either a [Metadata Access Point](../admin-services/docs/concepts/metadata-access-point.md)
or a [Metadata Server](../admin-services/docs/concepts/metadata-server.md).
The OMASs run in either a [Metadata Access Point](https://egeria-project.org/concepts/metadata-access-point)
or a [Metadata Access Store](https://egeria-project.org/concepts/metadata-access-store).
They can be configured and activated individually or as a complete set.
The [administration services](../admin-services/README.md) provide
The [administration services](../admin-services) provide
the ability to configure, start and stop the access services.

Each OMAS typically supports a REST API, a topic where it publishes notifications
Expand All @@ -196,22 +196,12 @@ OMAS.

It also has a Java client that provides access to its API and topics.
This java client is embedded in the
[Governance Servers](../admin-services/docs/concepts/governance-server-types.md) and
[View Servers](../admin-services/docs/concepts/view-server.md).
[Governance Servers](https://egeria-project.org/concepts/governance-server) and
[View Servers](https://egeria-project.org/concepts/view-server).
They can also be downloaded and used independently with the
**[Egeria Client Package](../../open-metadata-distribution/README.md)**.
**[Egeria Client Package](../../open-metadata-distribution)**.

This is illustrated in Figure 1:

![Figure 1](docs/design/access-services-overview.png)
> Figure 1: Structure of an Open Metadata Access Service (OMAS)

## Digging deeper

* [OMAS Concepts](docs/concepts)
* [User Guides for each OMAS](docs/user)
* [OMAS Design Documentation](docs/design)
More information on the OMASs can be found in the [Egeria Documentation](https://egeria-project.org/services/omas).

----
Return to [open-metadata-implementation](..).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ There is a single client called `AssetCatalog`. It has two constructors:
* No authentication embedded in the HTTP request - for test systems.
* Basic authentication using a userId and password embedded in the HTTP request.

Both constructors take the [URL root for the server platform](../../../../docs/concepts/client-server/omas-server-url-root.md)
where the Data Engine OMAS is running and its [server name](../../../../docs/concepts/client-server/omas-server-name.md).
Both constructors take the [URL root for the server platform](https://egeria-project.org/concepts/platform-url-root/)
where the Data Engine OMAS is running and its [server name](https://egeria-project.org/concepts/server-name/).

Here is a code example with the user id and password specified:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,14 @@
# Asset Consumer Open Metadata Access Service (OMAS)

The Asset Consumer OMAS provides services to an individual who wants to work
with [assets](../docs/concepts/assets) such as:
with [digital resources](https://egeria-project.org/concepts/resources) such as:

* data stores, data sets and data feeds
* reports
* APIs
* functions such as analytical services

* [Documentation](https://egeria-project.org/services/omas/asset-consumer/overview)

It supports:

* the retrieval of [connection](../../frameworks/open-connector-framework/docs/concepts/connection.md)
objects from the open metadata repositories. A connection object is used to create a connector to an asset.
* the creation of a [connector](../../frameworks/open-connector-framework/docs/concepts/connector.md)
based on the properties in a connection object.
* the retrieval of properties about an asset. These properties are called the
[connected asset properties](../../frameworks/open-connector-framework/docs/concepts/connected-asset-properties.md).
* the adding of feedback (comments, ratings and likes) to an asset.
* the attachment of [informal tags](../docs/concepts/attachments/informal-tags.md) to an asset.
* the adding of an audit log record for an asset.
* the publishing of notifications about assets on Asset Consumer OMAS's [out topic](../docs/concepts/client-server/out-topic.md).

Adding feedback through the Asset Consumer OMAS results in [Karma Points](../community-profile/docs/concepts/karma-point.md) being awarded
to the individual. These are maintained in the individual's profile.
A karma point is awarded for each contribution of feedback
through the API. (The awarding of Karma points is managed by the
[Community Profile OMAS](../community-profile).)

The connectors returned by the Asset Consumer OMAS are [Open Connector
Framework (OCF)](../../frameworks/open-connector-framework) connectors.
The caller can use the connector to access
the contents of the asset itself and the properties about the
asset it is accessing. This service is provided by the
[OCF Metadata Management Common Service](../../common-services/ocf-metadata-management).

## Digging Deeper

* [User Documentation](docs/user)
* [Design Documentation](docs/design)

* [User Documentation](https://egeria-project.org/services/omas/asset-consumer/overview)

----
Return to the [access-services](..) module.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Asset Consumer's Asset Interface (AssetConsumerAssetInterface)

AssetConsumerAssetInterface provides the ability to query information about an
[asset](../../../../docs/concepts/assets).
[asset](https://egeria-project.org/concepts/asset).

The first 3 methods provide the ability to locate assets by names and descriptions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

AssetConsumerConnectorFactoryInterface supports the creation of connectors from connections.

[Connectors](../../../../../frameworks/open-connector-framework/docs/concepts/connector.md)
are client-side objects for interacting with [Assets](../../../../docs/concepts/assets)
[Connectors](https://egeria-project.org/concepts/connector)
are client-side objects for interacting with [Assets](https://egeria-project.org/concepts/asset)
such as databases, APIs and files.

The configuration for a specific connectors is managed as open metadata in
a [Connection](../../../../../frameworks/open-connector-framework/docs/concepts/connection.md) definition.
a [Connection](https://egeria-project.org/concepts/connection) definition.

The caller to the Asset Consumer OMAS passes either a Connection object, or the name or GUID for the
connection stored in the open metadata repositories. The Asset Consumer OMAS creates an appropriate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Asset Consumer's Feedback Interface (AssetConsumerFeedbackInterface)

AssetConsumerFeedbackInterface provides the ability to attach reviews, likes and
comments to an [asset](../../../../docs/concepts/assets).
comments to an [asset](https://egeria-project.org/concepts/asset).
These elements can only be attached to one asset so the methods to
add one of these types of feedback elements includes a create of the element
as well as the attachment of it to the identified asset.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
# Asset Consumer OMAS Java Client

The Asset Consumer OMAS Java client interface `AssetConsumer` supports the creation of
[connectors](../../../../../../frameworks/open-connector-framework/docs/concepts/connector.md) to access
[assets](../../../../../docs/concepts/assets). It also supports feedback and tagging of assets.
[connectors](https://egeria-project.org/concepts/connector) to access
[assets](https://egeria-project.org/concepts/asset). It also supports feedback and tagging of assets.

It has two constructors:

* No authentication embedded in the HTTP request - for test systems.
* Basic authentication using a userId and password embedded in the HTTP request.

Both constructors take the [URL root for the server platform](../../../../../docs/concepts/client-server/omas-server-url-root.md)
where the Asset Consumer OMAS is running and its [server name](../../../../../docs/concepts/client-server/omas-server-name.md).
Both constructors take the [URL root for the server platform](https://egeria-project.org/concepts/platform-url-root/)
where the Asset Consumer OMAS is running and its [server name](https://egeria-project.org/concepts/server-name/).

Here is a code example with the user id and password specified:

Expand Down
Loading

0 comments on commit f9158a2

Please sign in to comment.