Skip to content

Commit

Permalink
Merge pull request #907 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history
Remove dojos, add informal blogs
  • Loading branch information
mandy-chessell authored Mar 7, 2024
2 parents caf148d + e4c7292 commit 7a9dcd4
Show file tree
Hide file tree
Showing 7 changed files with 223 additions and 102 deletions.
181 changes: 177 additions & 4 deletions site/docs/concepts/governance-action-processes.drawio

Large diffs are not rendered by default.

66 changes: 33 additions & 33 deletions site/docs/connectors/apache-atlas/apache-atlas-connectors.drawio

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ The Apache Atlas Survey Action Service provides a summary of the contents of the

It has three analysis steps:

1. STATS - Retrieves the overall metrics from the Apache Atlas server. These are stored in a [*DataSourceMeasurementAnnotation*](/types/0660-Data-Source-Measurement) entity linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity generated for each run of the Apache Atlas Survey Action Service.
2. SCHEMA - Retrieves the types from Apache Atlas and organizes them in a linked graph of [*Schema Attributes*](/types/5/0533-Graph-Schemas) entities. All the graph schema attributes are linked to a [*GraphSchemaType*](/types/5/0533-Graph-Schemas) entity which is in turn linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity.
3. PROFILE - Retrieves each entity in the Apache Atlas server and adds the following counts to [*DataProfileAnnotation*](/types/6/0620-Data-Profiling) entities linked from the appropriate data field entities:
1. Measure Resource - Retrieves the overall metrics from the Apache Atlas server. These are stored in a [*DataSourceMeasurementAnnotation*](/types/0660-Data-Source-Measurement) entity linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity generated for each run of the Apache Atlas Survey Action Service.
2. Schema Extraction - Retrieves the types from Apache Atlas and organizes them in a linked graph of [*Schema Attributes*](/types/5/0533-Graph-Schemas) entities. All the graph schema attributes are linked to a [*GraphSchemaType*](/types/5/0533-Graph-Schemas) entity which is in turn linked to the [*SurveyReport*](/types/6/0603-Survey-Reports) entity.
3. Profile Data - Retrieves each entity in the Apache Atlas server and adds the following counts to [*DataProfileAnnotation*](/types/6/0620-Data-Profiling) entities linked from the appropriate data field entities:

* The number of instances of each entity type.
* The number of classifications of a particular type attached to each type of entity.
Expand All @@ -46,7 +46,7 @@ It has three analysis steps:

Each analysis step builds on the work of its predecessor. The processing requirements increase with each step, so you can choose to stop the processing after any step using the `finalAnalysisStep` property. This can be set as a configuration property in the connection object for this survey action service, or as a request parameter passed when the Apache Atlas Survey Action Service is run.

The default value for `finalAnalysisStep` is `PROFILE`.
The default value for `finalAnalysisStep` is `Profile Data`.

## Metadata Setup

Expand All @@ -71,7 +71,7 @@ Figure 4 shows the structure of the survey report. The annotations are labelled
### Data Source Measurements Annotation

The data source measurements annotation is created in the STATS analysis step. It sets up the following properties in the *dataSourceProperties* map:
The data source measurements annotation is created in the *Measure Resource* analysis step. It sets up the following properties in the *dataSourceProperties* map:

* entityInstanceCount - number of active entity instances
* entityInstanceCount:*typeName* - number of active entity instance of this type
Expand All @@ -84,11 +84,11 @@ This analysis is achieved using two REST API calls and so has minimum impact on

### Schema Analysis Annotation

The schema analysis annotation is created in the SCHEMA analysis step. It identifies the name/type of the schema created.
The schema analysis annotation is created in the *Schema Extraction* analysis step. It identifies the name/type of the schema created.

### Apache Atlas Types as a schema

In the SCHEMA analysis step, the apache atlas types extracted from the Apache Atlas server are used to create a schema that describes the graph structure of the metadata found in the Apache Atlas server:
In the *Schema Extraction* analysis step, the apache atlas types extracted from the Apache Atlas server are used to create a schema that describes the graph structure of the metadata found in the Apache Atlas server:

* A [*GraphVertex*](/types/5/0533-Graph-Schemas) entity is created for each Apache Atlas entity type, business metadata type and classification type.
* A [*GraphEdge*](/types/5/0533-Graph-Schemas) entity is created for each Apache Atlas relationship type, and each permitted use of a classification type by an entity type.
Expand All @@ -113,7 +113,7 @@ This survey action service attaches multiple data profile annotations to each gr
It sets up the following fields in each data profile annotation:

* *analysisStep* - this is always set to "PROFILE".
* *analysisStep* - this is always set to *Profile Data*.
* *annotationType* - this identifies the type of values that the annotation contains.
* *explanation* - this provides more information about the annotation type.
* *valueCount* - this is a map of typeName to count. For example, if this annotation was counting the classifications attached to the *DataSet* entity type, then the map would include an entry for each type of classification attached to this type of entity and a count of how many times it is used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ These are the responses that origin seeker produces:
- `CompletionStatus.INVALID` with guard `multiple-origins-detected` if multiple, different origins are detected in the lineage graph.
- `CompletionStatus.INVALID` with guard `no-origins-detected` if no origin classifications are found in the lineage graph.
- `CompletionStatus.INVALID` with guard `no-targets-detected` if there is no asset set up as an action target.
- `CompletionStatus.FAILED` with guard `multiple-targets-detected` if there are multiple assets set up as action targets.
- `CompletionStatus.INVALID` with guard `multiple-targets-detected` if there are multiple assets set up as action targets.
- `CompletionStatus.FAILED` with guard `origin-seeking-failed` for an unrecoverable error such as a not authorized response from the metadata repository.

## Examples of use
Expand Down
2 changes: 1 addition & 1 deletion site/docs/release-notes/5-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Release 5.0 is a major functional release focused on usability, both from the po
[Asset Catalog OMVS](/services/omvs/asset-catalog/overview) is a new view service that supports the `/assets` and `/lineage` services from Egeria UI Application. There are two versions of each call, one of which is deprecated. The deprecated version exactly matches the API supported by the Egeria UI application, however, it does not manage exceptions in the way expected by an Egeria API. It will remain in place until the existing UI components are updated to support Egeria's standard exception handling.

??? functional "Updates to Glossary Browser OMVS"
Glossary Browser OMVS has been extended to support the `/glossary` services from the Egeria UI application. They are deprecated because they do not support the standard exception handling, but are in place to support existing UI components. Once the UI components have been updated to support the main API then these new services will be removed.
[Glossary Browser OMVS](/services/omvs/glossary-browser/overview) has been extended to support the `/glossary` services from the Egeria UI application. They are deprecated because they do not support the standard exception handling, but are in place to support existing UI components. Once the UI components have been updated to support the main API then these new services will be removed.

??? danger "Changes to view service REST API URLs"
The following Open Metadata View Services (OMVSs) (and all future OMVSs) support the new URL pattern of `{{baseURL}}/servers/{{server}}/api/open-metadata/{{serviceURLRoot}}/...`
Expand Down
56 changes: 2 additions & 54 deletions site/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -246,65 +246,13 @@ nav:
- Using IntelliJ: education/tutorials/intellij-tutorial/overview.md
- Using Postman: education/tutorials/postman-tutorial/overview.md
- Using Kafka: education/tutorials/kafka-tutorial/overview.md
- Informal Guide to Getting Started: https://getting-started-with-egeria.pdr-associates.com/introduction.html
- Webinars: education/webinar-program/overview.md
- Comparisons:
- Apache Atlas: education/comparisons/apache-atlas.md
- Scenarios:
- Data Manager Integration: scenarios/data-manager-integration/overview.md
- File Lineage: scenarios/file-lineage/overview.md
- Dojos:
- Dojo Overview: education/egeria-dojo/index.md
- Running Egeria Day :
- Introduction to 'Running Egeria' day: education/egeria-dojo/running-egeria/running-egeria-intro.md
- Egeria introduction : education/egeria-dojo/running-egeria/egeria-introduction.md
- Setup of the environment: education/egeria-dojo/running-egeria/setup-environment.md
- Simple Install of Egeria: education/egeria-dojo/running-egeria/simple-install.md
- User Interfaces:
- Introduction to the Egeria UIs: education/egeria-dojo/running-egeria/user-interfaces/ui-introduction.md
- Ecosystem UI:
- Using the Egeria Ecosystem UI: education/egeria-dojo/running-egeria/user-interfaces/ecosystem-ui/ecosystem-ui-start.md
- Configuring and Operating a Server: education/egeria-dojo/running-egeria/configuring-and-operating-a-server.md
- Coco Pharmaceuticals Lab: education/egeria-dojo/running-egeria/coco-labs-environment.md
- Summary of 'Running Egeria' day : education/egeria-dojo/running-egeria/running-egeria-summary.md
- Developer Day : education/egeria-dojo/developer/overview.md
- Metadata Governance Day : education/egeria-dojo/metadata-governance/overview.md
- Egeria Contributor Day : education/egeria-dojo/egeria-contributor.md
- Egeria in Production Day : education/egeria-dojo/egeria-in-production.md
- Old Dojo (deprecated):
- Dojo Introduction: getting-started/dojo/index.md
- Day 1:
- Egeria Introduction: getting-started/dojo/egeria-dojo-day-1-1-introduction.md
- Egeria Project Introduction: getting-started/dojo/egeria-dojo-day-1-2-project-introduction.md
- Running Egeria:
- Overview: getting-started/dojo/egeria-dojo-day-1-3-running-egeria.md
- Platform Setup and Configuration:
- Overview: getting-started/dojo/egeria-dojo-day-1-3-1-platform-set-up-and-configuration.md
- Prerequisites: getting-started/dojo/egeria-dojo-day-1-3-1-1-platform-set-up-prerequisites.md
- Configuring the Platform: getting-started/dojo/egeria-dojo-day-1-3-1-2-configuring-the-platform.md
- Configuring a Server: getting-started/dojo/egeria-dojo-day-1-3-1-3-configuring-a-server.md
- Running Metadata Access Servers:
- Overview: getting-started/dojo/egeria-dojo-day-1-3-2-running-metadata-servers.md
- Starting Server: getting-started/dojo/egeria-dojo-day-1-3-2-1-starting-the-server.md
- Calling Server API: getting-started/dojo/egeria-dojo-day-1-3-2-2-calling-server-api.md
- Working with Archives: getting-started/dojo/egeria-dojo-day-1-3-2-3-working-with-archives.md
- Second Server: getting-started/dojo/egeria-dojo-day-1-3-2-4-second-server.md
- Running Metadata Ecosystems:
- Overview: getting-started/dojo/egeria-dojo-day-1-3-3-running-metadata-ecosystems.md
- Running User Interfaces: getting-started/dojo/egeria-dojo-day-1-3-3-1-running-ui.md
- Running Governance Servers: getting-started/dojo/egeria-dojo-day-1-3-3-2-running-governance-servers.md
- Running Kubernetes and Labs: getting-started/dojo/egeria-dojo-day-1-3-3-3-kubernetes-and-labs.md
- Participating in the Community: getting-started/dojo/egeria-dojo-day-1-4-participating-in-the-community.md
- Day 2:
- Open Source Philosophy: getting-started/dojo/egeria-dojo-day-2-1-open-source-philosophy.md
- Tools for Contributors: getting-started/dojo/egeria-dojo-day-2-2-tools-for-contributors.md
- Contributing to Egeria: getting-started/dojo/egeria-dojo-day-2-3-contribution-to-egeria.md
- Type of Contribution: getting-started/dojo/egeria-dojo-day-2-4-types-of-contribution.md
- Becoming a Contributor: getting-started/dojo/egeria-dojo-day-2-5-becoming-a-contributor.md
- Day 3:
- Becoming an Advocate: getting-started/dojo/egeria-dojo-day-3-1-becoming-an-advocate.md
- Becoming a Maintainer: getting-started/dojo/egeria-dojo-day-3-2-becoming-a-maintainer.md
- Egeria Architecture: getting-started/dojo/egeria-dojo-day-3-3-egeria-architecture.md
- Egeria Social: getting-started/dojo/egeria-dojo-day-3-4-egeria-social.md
- Community:
- Community Recognition: community/index.md
- Community Guide: guides/community.md
Expand Down Expand Up @@ -342,7 +290,7 @@ nav:
- Markdown: guides/contributor/markdown.md
- Releases:
- Overview: release-notes/overview.md
- Monthly News:
- Newsletters:
- August 2023: release-notes/august-2023.md
- April 2023: release-notes/april-2023.md
- February 2023: release-notes/february-2023.md
Expand Down

0 comments on commit 7a9dcd4

Please sign in to comment.