Skip to content

Commit

Permalink
Add developer set up tutorial
Browse files Browse the repository at this point in the history
Signed-off-by: Mandy Chessell <[email protected]>
  • Loading branch information
mandy-chessell committed Sep 13, 2023
1 parent 7a90feb commit a3222aa
Show file tree
Hide file tree
Showing 46 changed files with 575 additions and 35 deletions.
2 changes: 1 addition & 1 deletion site/docs/education/egeria-dojo/developer/overview-old.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ After completing developer day of the egeria dojo you should feel comfortable wi
Many of the contributors to the Egeria project use the *[IntelliJ IDEA](https://www.jetbrains.com/idea/)* IDE. Jetbrains offers a [free community edition of IntelliJ](https://www.jetbrains.com/idea/download/) which is sufficient to work with Egeria. You are free to use any IDE during the dojo, however the instructions will focus on IntelliJ IDEA.

??? tip "Installing IntelliJ IDEA ..."
--8<-- "docs/education/tutorials/intellij-tutorial/task-installing-intellij.md"
--8<-- "snippets/tasks/task-installing-intellij.md"
Congratulations, you are ready to begin.

Expand Down
2 changes: 1 addition & 1 deletion site/docs/education/egeria-dojo/developer/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This dojo was last tested using Egeria release 3.14.
Many of the contributors to the Egeria project use the *[IntelliJ IDEA](https://www.jetbrains.com/idea/){ target=dojo-support }* IDE. Jetbrains offers a [free community edition of IntelliJ](https://www.jetbrains.com/idea/download/) which is sufficient to work with Egeria. You are free to use any IDE during the dojo, however the instructions will focus on IntelliJ IDEA.

??? tip "Installing IntelliJ IDEA ..."
--8<-- "docs/education/tutorials/intellij-tutorial/task-installing-intellij.md"
--8<-- "snippets/tasks/task-installing-intellij.md"
Congratulations, you are ready to begin.

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

Egeria is an open source project that is delivered both as source code as well as [Maven Central Repository](https://search.maven.org/) libraries.

This tutorial will guide you through the process of downloading the core Egeria source code from [GitHub](https://github.com/) and building it so that you can run it on your local machine.
This tutorial will guide you through the process of downloading the core Egeria source code from [GitHub](https://github.com/) and building it so that you can install and run it on your local machine.

Alternatively you can also use [Kubernetes](/guides/operations/kubernetes) to run Egeria. This uses the published builds of Egeria and does not require you to build Egeria on your machine.

## Prerequisite technology for building Egeria

??? tip "Installing Java"
--8<-- "snippets/tasks/task-installing-java.md"
??? tip "Installing Maven (rarely needed)"
--8<-- "snippets/tasks/task-installing-maven.md"

## Tutorial tasks

1. [Downloading the Egeria source from GitHub](#downloading-the-egeria-source-from-github)
2. [Building the Egeria source with Apache Maven](#building-the-egeria-source)
1. [Downloading the Egeria source from GitHub](#downloading-egeria-from-github-website)
2. [Building the Egeria source](#building-the-egeria-source)
3. [Installing Egeria](#installing-egeria)

--8<-- "snippets/tasks/task-cloning-egeria-source.md"
--8<-- "snippets/tasks/task-downloading-egeria-source.md"

You are now ready to [build the egeria source](#building-the-egeria-source).

Expand All @@ -32,11 +30,13 @@ You are now ready to [build the egeria source](#building-the-egeria-source).

## What next?

This is the end of the *Downloading and Building Egeria Tutorial*. You are now
This is the end of the *Downloading and Building Egeria Tutorial*. You are now
ready to [learn about the OMAG Server Platform](/education/tutorials/omag-server-tutorial/overview).

Alternatively ...

* [Set up IntelliJ ready to develop connectors or clients that use Egeria](/education/tutorials/developer-intellij-tutorial)
or
* [Run the open metadata labs to get experience with using Egeria](/education/open-metadata-labs/overview)
or
* [Learn about developing extensions to Egeria](/guides/developer)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
@@ -0,0 +1,61 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Platform report for: https://localhost:9443

## Platform deployment
* **Egeria version**: Egeria OMAG Server Platform (version 4.3)
* **Configuration document store connector**: *null*
* **Platform security connector**: *null*
## Registered services
* **Data Manager OMAS**: Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system.
* **Subject Area OMAS**: Document knowledge about a subject area
* **Glossary View OMAS**: Support glossary terms visualization
* **Design Model OMAS**: Exchange design model content with tools and standard packages
* **Security Officer OMAS**: Set up rules and security tags to protect data
* **Asset Manager OMAS**: Manage metadata from a third party asset manager
* **IT Infrastructure OMAS**: Manage information about the deployed IT infrastructure
* **Data Science OMAS**: Create and manage data science definitions and models
* **Community Profile OMAS**: Define personal profile and collaborate
* **Data Engine OMAS**: Exchange process models and lineage with a data engine
* **Discovery Engine OMAS**: Support for automated metadata discovery engines
* **Digital Architecture OMAS**: Design of the digital services for an organization
* **Asset Owner OMAS**: Manage an asset
* **Stewardship Action OMAS**: Manage exceptions and actions from open governance
* **Governance Program OMAS**: Manage the governance program
* **Digital Service OMAS**: Manage a digital service through its lifecycle
* **Asset Lineage OMAS**: Store asset lineage
* **Asset Consumer OMAS**: Access assets through connectors
* **Asset Catalog OMAS**: Search and understand your assets
* **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
* **Data Privacy OMAS**: Manage governance of privacy
* **Security Manager OMAS**: Manages exchange of metadata with a security service
* **Governance Action OMES**: Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts.
* **Repository Governance OMES**: Dynamically governance open metadata repositories in the connected cohorts.
* **Asset Analysis OMES**: Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories.
* **Infrastructure Integrator OMIS**: Exchange information relating to IT infrastructure such as hosts, platforms, servers, server capabilities and services.
* **Files Integrator OMIS**: Extract metadata about files stored in a file system or file manager.
* **Topic Integrator OMIS**: Exchange metadata with third party event-based brokers.
* **Security Integrator OMIS**: Distribute security properties to security enforcement points.
* **API Integrator OMIS**: Exchange metadata with third party API Gateways.
* **Search Integrator OMIS**: Store metadata with a third party technology that is focused on search efficiency.
* **Lineage Integrator OMIS**: Manage capture of lineage from a third party tool.
* **Database Integrator OMIS**: Extract metadata such as schema, tables and columns from database managers.
* **Catalog Integrator OMIS**: Exchange metadata with third party data catalogs.
* **Display Integrator OMIS**: Exchange metadata with applications that display data to users.
* **Analytics Integrator OMIS**: Exchange metadata with third party analytics tools.
* **Organization Integrator OMIS**: Load information about the teams and people in an organization and return collaboration activity.
* **Glossary Author OMVS**: View Service for glossary authoring.
* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem.
* **Repository Explorer OMVS**: Explore open metadata instances.
* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **My Profile OMVS**: Manage information about the logged on user as well as their preferences.
* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort.
* **Server Author OMVS**: Author servers.
* **Glossary Browser OMVS**: View glossary terms and categories within a glossary.
## Platform servers
None
--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Platform report for: https://localhost:9443

## Platform deployment
* **Egeria version**: Egeria OMAG Server Platform (version 4.3)
* **Configuration document store connector**: *null*
* **Platform security connector**: *null*
## Registered services
* **Data Manager OMAS**: Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system.
* **Subject Area OMAS**: Document knowledge about a subject area
* **Glossary View OMAS**: Support glossary terms visualization
* **Design Model OMAS**: Exchange design model content with tools and standard packages
* **Security Officer OMAS**: Set up rules and security tags to protect data
* **Asset Manager OMAS**: Manage metadata from a third party asset manager
* **IT Infrastructure OMAS**: Manage information about the deployed IT infrastructure
* **Data Science OMAS**: Create and manage data science definitions and models
* **Community Profile OMAS**: Define personal profile and collaborate
* **Data Engine OMAS**: Exchange process models and lineage with a data engine
* **Discovery Engine OMAS**: Support for automated metadata discovery engines
* **Digital Architecture OMAS**: Design of the digital services for an organization
* **Asset Owner OMAS**: Manage an asset
* **Stewardship Action OMAS**: Manage exceptions and actions from open governance
* **Governance Program OMAS**: Manage the governance program
* **Digital Service OMAS**: Manage a digital service through its lifecycle
* **Asset Lineage OMAS**: Store asset lineage
* **Asset Consumer OMAS**: Access assets through connectors
* **Asset Catalog OMAS**: Search and understand your assets
* **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
* **Data Privacy OMAS**: Manage governance of privacy
* **Security Manager OMAS**: Manages exchange of metadata with a security service
* **Governance Action OMES**: Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts.
* **Repository Governance OMES**: Dynamically governance open metadata repositories in the connected cohorts.
* **Asset Analysis OMES**: Analyses the content of an asset's real world counterpart, generates annotations in an open discovery report that is attached to the asset in the open metadata repositories.
* **Infrastructure Integrator OMIS**: Exchange information relating to IT infrastructure such as hosts, platforms, servers, server capabilities and services.
* **Files Integrator OMIS**: Extract metadata about files stored in a file system or file manager.
* **Topic Integrator OMIS**: Exchange metadata with third party event-based brokers.
* **Security Integrator OMIS**: Distribute security properties to security enforcement points.
* **API Integrator OMIS**: Exchange metadata with third party API Gateways.
* **Search Integrator OMIS**: Store metadata with a third party technology that is focused on search efficiency.
* **Lineage Integrator OMIS**: Manage capture of lineage from a third party tool.
* **Database Integrator OMIS**: Extract metadata such as schema, tables and columns from database managers.
* **Catalog Integrator OMIS**: Exchange metadata with third party data catalogs.
* **Display Integrator OMIS**: Exchange metadata with applications that display data to users.
* **Analytics Integrator OMIS**: Exchange metadata with third party analytics tools.
* **Organization Integrator OMIS**: Load information about the teams and people in an organization and return collaboration activity.
* **Glossary Author OMVS**: View Service for glossary authoring.
* **Dynamic Infrastructure and Operations OMVS**: Explore and operate an open metadata ecosystem.
* **Repository Explorer OMVS**: Explore open metadata instances.
* **Glossary Workflow OMVS**: Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.
* **My Profile OMVS**: Manage information about the logged on user as well as their preferences.
* **Type Explorer OMVS**: Explore the open metadata types in a repository or cohort.
* **Server Author OMVS**: Author servers.
* **Glossary Browser OMVS**: View glossary terms and categories within a glossary.
## Platform servers
### Server: test-metadata-store
* **Type**: *null*
* **Description**: Metadata Access Store called test-metadata-store running on platform https://localhost:9443
* **UserId**: cocoMDS1npa
#### Security Connector
* **Implementation**: org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider
* **Location**: *null*
#### Local Repository
* **Local Repository Mode**: Open Metadata Native
##### Local Repository Connector
* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider
* **Location**: *null*
##### Local Repository Remote Connector
* **Implementation**: org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider
* **Location**: https://localhost:9443/servers/test-metadata-store
#### Runtime Status
#### Services
##### Service: Asset Manager OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]
##### Service: Community Profile OMAS
###### Service Options
* **KarmaPointPlateau**: 10
* **SupportedZones**: [data-lake, personal-files]
* **DefaultZones**: [personal-files]
##### Service: Data Manager OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]
##### Service: Digital Architecture OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]
##### Service: Asset Consumer OMAS
###### Service Options
* **SupportedZones**: [data-lake, personal-files]
* **DefaultZones**: [personal-files]
##### Service: Governance Program OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]
##### Service: IT Infrastructure OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]
##### Service: Asset Owner OMAS
###### Service Options
* **SupportedZones**: [quarantine, trash-can, data-lake]
* **PublishZones**: [data-lake, personal-files]
* **DefaultZones**: [quarantine]

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

0 comments on commit a3222aa

Please sign in to comment.