From 5f040b87db19d0fcea4e60676470241ca2a9cdcd Mon Sep 17 00:00:00 2001 From: Mandy Chessell Date: Wed, 13 Sep 2023 16:58:34 +0100 Subject: [PATCH] Update native egeria tutorials Signed-off-by: Mandy Chessell --- .../create-test-metadata-store.md | 45 + .../tutorials/docker-tutorial/overview.md | 54 +- site/docs/education/tutorials/index.md | 55 +- .../omag-server-tutorial/overview.md | 1308 +---------------- ...-platform-tutorial.postman_collection.json | 5 +- .../starting-the-omag-server-platform.md | 81 - site/snippets/supported-platforms.md | 76 +- .../task-building-customized-docker-image.md | 52 + .../tasks}/task-calling-omag-apis.md | 4 +- .../task-creating-configuration-documents.md | 26 +- .../tasks}/task-deleting-omag-server.md | 6 +- ...starting-omag-server-platform-from-jar.md} | 32 +- .../tasks}/task-starting-omag-server.md | 13 +- .../task-stopping-omag-server-platform.md | 2 +- .../tasks}/task-stopping-omag-server.md | 16 +- .../tasks/task-understanding-rest-apis.md | 22 + .../tasks}/task-working-with-postman.md | 2 +- .../tasks/terminal-installing-egeria.md | 2 +- 18 files changed, 243 insertions(+), 1558 deletions(-) create mode 100644 site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.md delete mode 100644 site/docs/education/tutorials/omag-server-tutorial/starting-the-omag-server-platform.md create mode 100644 site/snippets/tasks/task-building-customized-docker-image.md rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-calling-omag-apis.md (91%) rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-creating-configuration-documents.md (98%) rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-deleting-omag-server.md (65%) rename site/{docs/education/tutorials/omag-server-tutorial/task-starting-the-omag-server-platform.md => snippets/tasks/task-starting-omag-server-platform-from-jar.md} (72%) rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-starting-omag-server.md (97%) rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-stopping-omag-server-platform.md (93%) rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-stopping-omag-server.md (90%) create mode 100644 site/snippets/tasks/task-understanding-rest-apis.md rename site/{docs/education/tutorials/omag-server-tutorial => snippets/tasks}/task-working-with-postman.md (98%) diff --git a/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.md b/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.md new file mode 100644 index 0000000000..8cf9de80d8 --- /dev/null +++ b/site/docs/education/tutorials/developer-intellij-tutorial/create-test-metadata-store.md @@ -0,0 +1,45 @@ + + + +```bash +/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dstrict.ssl=false -Dfile.encoding=UTF-8 -jar /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/etc/utilities/egeria-config-utility-4.3.jar +================================== +OMAG Server Configuration Utility: Wed Sep 13 12:48:44 BST 2023 +================================== +Running against platform: https://localhost:9443 - Egeria OMAG Server Platform (version 4.3) +Using userId: garygeeke + +Enter a command along with the server name and any optional parameters. Press enter to execute request. + - create-metadata-store + - create-integration-daemon + - add-api-connector + - add-infra-connector + - add-topic-connector + - log-event-contents + - add-cohort-member + - add-startup-archive + - update-server-user-id + - delete-server + - exit +``` +```bash +create-metadata-store test-metadata-store +``` +```bash +Configuring metadata store: test-metadata-store + +Enter a command along with the server name and any optional parameters. Press enter to execute request. + - create-metadata-store + - create-integration-daemon + - add-api-connector + - add-infra-connector + - add-topic-connector + - log-event-contents + - add-cohort-member + - add-startup-archive + - update-server-user-id + - delete-server + - exit +``` + + diff --git a/site/docs/education/tutorials/docker-tutorial/overview.md b/site/docs/education/tutorials/docker-tutorial/overview.md index 6ec832b272..171a524b60 100644 --- a/site/docs/education/tutorials/docker-tutorial/overview.md +++ b/site/docs/education/tutorials/docker-tutorial/overview.md @@ -13,58 +13,8 @@ This page takes you through the different options for building and running egeri ## Building your own docker image -When you [build the main egeria repository](/docs/education/tutorials/building-egeria-tutorial/overview) a new `build` directory is created under `open-metadata-distribution/omag-server-platform`. +--8<-- "snippets/tasks/task-building-customized-docker-image.md" -Open up this directory and you will see two directories of interest: - -* *distributions* contains the packaged "assembly" of the [OMAG Server Platform](/concepts/omag-server-platform). -* *unpacked* contains the same content as the "assembly" but it is not packaged into a tar file. - -Take a copy of the "assembly" from either directory: - -* Copy and unpack the tar file or -* Copy all the files under `unpacked` - -Change into the assembly's top-level directory. When you list the contents - -```bash -$ ls -Dockerfile LICENSE NOTICE README.md assembly dist -``` - -Run the docker command: - -```bash -docker build -t egeria-platform:{myversion} -f Dockerfile . -``` -replacing `{myversion}` with a tag name for this docker image. The example below used `latest` as the tag name. - -```bash -? docker build -t egeria-platform:latest -f Dockerfile . -[+] Building 44.9s (5/5) FINISHED docker:desktop-linux - => [internal] load build definition from Dockerfile 0.0s - => => transferring dockerfile: 3.28kB 0.0s - => [internal] load .dockerignore 0.0s - => => transferring context: 2B 0.0s - => [internal] load metadata for registry.access.redhat.com/ubi9/openjdk-17:latest 1.5s - => [1/1] FROM registry.access.redhat.com/ubi9/openjdk-17@sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 43.3s - => => resolve registry.access.redhat.com/ubi9/openjdk-17@sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 0.0s - => => sha256:5cbda490fcb7ab72e85cfba7098858cd3ed6bb15f95687e86979f6d4ac7b2f15 596B / 596B 0.0s - => => sha256:5b5deb1288720666a590472d9a506500df9ebe3c817e9710327162ccd24c4e22 24.19kB / 24.19kB 0.0s - => => sha256:62742f27dce5ebff467a57ad6bfa680820f3bc534cc313627f8113246276bf0f 37.83MB / 37.83MB 17.9s - => => sha256:f008a4f4b21c818e8bbd4e2521eb30ab0f8a43dc259e9e51c0d134641e343acd 110.80MB / 110.80MB 37.5s - => => sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 1.47kB / 1.47kB 0.0s - => => extracting sha256:62742f27dce5ebff467a57ad6bfa680820f3bc534cc313627f8113246276bf0f 2.0s - => => extracting sha256:f008a4f4b21c818e8bbd4e2521eb30ab0f8a43dc259e9e51c0d134641e343acd 5.5s - => exporting to image 0.0s - => => exporting layers 0.0s - => => writing image sha256:5a2c784ed7558dc625d109c04c8b5e78534b270a29d3011eb771fd01724c097f 0.0s - => => naming to docker.io/library/egeria-platform:latest 0.0s - -What's Next? - View summary of image vulnerabilities and recommendations → docker scout quickview - -``` ## Using the standard docker container on docker hub @@ -124,7 +74,7 @@ It may take a little while to complete its start up so check it is running befor For example, on macOS, the docker desktop can be found on the **Launchpad**. Once it is running, the docker whale icon appears on the top menu bar. Clicking on the docker whale icon reveals a menu and the status of the desk top is visible. -This menu is used to shutdown docker at the end of the dojo. +This menu is used to shut down docker at the end of the dojo. ![macOS running Docker desktop](docker-desktop-running.png) diff --git a/site/docs/education/tutorials/index.md b/site/docs/education/tutorials/index.md index cd3ad21fc1..7fbf6089bb 100644 --- a/site/docs/education/tutorials/index.md +++ b/site/docs/education/tutorials/index.md @@ -3,29 +3,53 @@ # Tutorials -The tutorials provide step-by-step guides that help you work with Egeria and its associated technology. They provide help to: +--8<-- "snippets/supported-platforms.md" -* **Those that just want to run and use Egeria**. This includes how to download and build Egeria, install it in a convenient directory, customise it and use containers for cloud deployment. -* **Those that want to develop code with Egeria** (such as building new connectors or calling Egeria's APIs). This includes setting Egeria up in IntelliJ ready for your development work. -* **Those that wish to contribute to Egeria's code base**. This includes fixing bugs and adding new features to Egeria. +The tutorials provide step-by-step guides that help you work with Egeria and its associated technology. They provide help to: ---8<-- "snippets/supported-platforms.md" +* **[Those that just want to run and use Egeria](#tutorials-for-running-egeria)**. This includes how to download and build Egeria, install it in a convenient directory, customise it and use containers for cloud deployment. +* **[Those that want to develop code with Egeria](#tutorials-for-developing-with-egeria)** (such as building new connectors or calling Egeria's APIs). This includes setting Egeria up in IntelliJ ready for your development work. +* **[Those that wish to contribute to Egeria's code base](#tutorials-for-contributing-to-egeria)**. This includes fixing bugs and adding new features to Egeria. ## Tutorials for running Egeria Egeria is an open source project that can be: -* Started up ready to run the open metadata labs. These labs show Egeria in an operational mode serving different users in the Coco Pharmaceuticals business. Egeria is integrated with a variety of technologies in this environment, and it is set up to specifically support the scenarios within the labs. The implementation of this approach is using Kubernetes. Follow [this approach if you want to run the labs](/education/open-metadata-labs/overview). +* Run to support the open metadata labs. These labs show Egeria in an operational mode serving different users in the Coco Pharmaceuticals business. Egeria is integrated with a variety of technologies in this environment, and it is set up to specifically support the scenarios within the labs. The implementation of the labs uses Kubernetes. Follow [this link if you want to run the labs](/education/open-metadata-labs/overview). * Used directly from a prebuilt docker image from either [DockerHub](https://hub.docker.com/r/odpi/egeria) or [Quay.io](https://quay.io/repository/odpi/egeria). This docker image includes all the Egeria runtimes and can be used to experiment with different features of Egeria. If this option is for you, [go to the docker tutorial](/education/tutorials/docker-tutorial/overview). -* Downloaded and built to create your own customized version of Egeria. Egeria is highly customizable, use this method if you wish to develop and deploy a customized Egeria for your organization. Go to [Starting with the code](#starting-with-the-code) if this is for you. +* Downloaded and built to create your own customized version of Egeria. Egeria is highly customizable, use this method if you wish to deploy a customized Egeria for your organization. Go to [Starting with the code](#starting-with-the-code) if this is for you. + +Customizing Egeria typically begins with downloading and building Egeria's source code. This requires Java. + +??? tip "Installing Java" + --8<-- "snippets/tasks/task-installing-java.md" + +Once you have Java installed, you are ready to begin: + +??? education "Downloading Egeria's source code" + --8<-- "snippets/tasks/task-downloading-egeria-source.md" + +??? education "Building Egeria" + --8<-- "snippets/tasks/task-building-egeria-source.md" + +??? education "Installing Egeria" + --8<-- "snippets/tasks/task-installing-egeria.md" + +Once Egeria is installed, it is ready to be used. ## Tutorials for using Egeria -There are two choices in learning about Egeria. +The [open metadata labs](/education/open-metadata-labs/overview) show how Egeria can be used in multiple scenarios. The labs are organized by user role, allowing you to focus on the aspects of Egeria that interests you. + +The installed assembly gives you the option to run the platform directly from this assembly and/or customize the assembly and build it into a Docker image that can be used as part of a cloud-deployment. -The open metadata labs show how Egeria can be used in multiple scenarios. They are organized by user role, allowing you to focus on the aspects of Egeria that interests you. +??? education "Working with the OMAG Server Platform" + The [OMAG Server Platform tutorial](/education/tutorials/omag-server-tutorial) takes you through the process of starting and stopping the platform; configuring, starting and stopping servers and querying the status of the platform and its servers. + +??? education "Building a customized docker image" + --8<-- "snippets/tasks/task-building-customized-docker-image.md" ## Tutorials for developing with Egeria @@ -39,17 +63,6 @@ Each change should have a [GitHub issue](https://github.com/odpi/egeria/issues) Every contribution is signed to say that the contributor has the rights to make the contribution and agrees with the [Developer Certificate of Origin (DCO) :material-github:](https://github.com/odpi/egeria/blob/main/developer-resources/why-the-dco.md){ target=gh } -## Starting with the code - -??? education "Downloading Egeria's source code" - --8<-- "snippets/tasks/task-downloading-egeria-source.md" -??? education "Installing Java" - --8<-- "snippets/tasks/task-installing-java.md" - -??? education "Building Egeria" - --8<-- "snippets/tasks/task-building-egeria-source.md" - -??? education "Installing Egeria" - --8<-- "snippets/tasks/task-installing-egeria.md" + diff --git a/site/docs/education/tutorials/omag-server-tutorial/overview.md b/site/docs/education/tutorials/omag-server-tutorial/overview.md index 5357ee6ba8..b5601bd5c9 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/overview.md +++ b/site/docs/education/tutorials/omag-server-tutorial/overview.md @@ -25,1316 +25,32 @@ At the end of this tutorial you will be able to perform the following tasks. ## Tutorial Tasks ??? education "Starting the OMAG Server Platform" - - ### Starting the OMAG Server Platform - - The [OMAG Server Platform's installation directory](/education/tutorials/building-egeria-tutorial/task-installing-egeria) contains a Java Archive (Jar) file for the [OMAG Server Platform](/concepts/omag-server-platform) itself along with a directory of libraries. - - The name of the Java Archive (Jar) file will depend on the release of Egeria that you have installed. In this example, the release is **4.2**. - - ```bash - $ ls platform - lib omag-server-platform-4.2.jar - ``` - - The OMAG Server Platform is started with the `java` command. - - ??? tip "Checking your Java installation" - Ensure you have a Java runtime at Version 17 or above installed on your machine. Check the version of Java you have with the command **java -version** and [install the appropriate version](/education/tutorials/building-egeria-tutorial/task-installing-java) if needed. You only need the JRE but select the JDK if you expect to also write some Java code.) - - Start the OMAG server platform with the following command: - - ```bash - java -Dloader.path=platform/lib -jar platform/omag-server-platform*.jar - ``` - - This starts the platform listening on port `9443`. Add the `-Dserver.port` parameter before the `-jar` parameter if you wish the platform to listen on a different port. For example, the following command starts the platform listening on port `9444`. Multiple instances of the same OMAG Server Platform may run in a single machine (or in the same container). However, they each need to listen on a different port. - - ```bash - java -Dloader.path=platform/lib -Dserver.port=9444 -jar platform/omag-server-platform*.jar - ``` - - When the OMAG Server Platform starts up, it displays the `OMAG Server Platform` banner and then details of its configuration. - - ```text - Project Egeria - Open Metadata and Governance - ____ __ ___ ___ ______ _____ ____ _ _ ___ - / __ \ / |/ // | / ____/ / ___/ ___ ____ _ __ ___ ____ / _ \ / / __ / / / _ /__ ____ _ _ - / / / // /|_/ // /| | / / __ \__ \ / _ \ / __/| | / // _ \ / __/ / /_/ // // | / _\ / /_ / | / _// || | - / /_/ // / / // ___ |/ /_/ / ___/ // __// / | |/ // __// / / __ // // / \ / /_ / _// / // / / / / / - \____//_/ /_//_/ |_|\____/ /____/ \___//_/ |___/ \___//_/ /_/ /_/ \__/\//___//_/ \__//_/ /_/ /_/ - - :: Powered by Spring Boot (v3.0.6) :: - - 2023-06-11T13:13:57.959+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 85411 (/Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz/platform/omag-server-platform-4.2-SNAPSHOT.jar started by mandy-chessell in /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz) - 2023-06-11T13:13:57.962+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : No active profile set, falling back to 1 default profile: "default" - 2023-06-11T13:14:01.186+01:00 INFO 85411 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9443 (https) - 2023-06-11T13:14:02.400+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz - 2023-06-11T13:14:02.400+01:00 WARN 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Java trust store 'javax.net.ssl.trustStore' is null - this is needed by Tomcat - using 'server.ssl.trust-store' - 2023-06-11T13:14:04.687+01:00 INFO 85411 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 9443 (https) with context path '' - 2023-06-11T13:14:04.704+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Started OMAGServerPlatform in 7.591 seconds (process running for 8.325) - Sun Jun 11 13:14:04 BST 2023 No OMAG servers listed in startup configuration - Sun Jun 11 13:14:04 BST 2023 OMAG server platform ready for more configuration - ``` - - When you see the `OMAG server platform ready for more configuration` message, it means the OMAG Server Platform has completed its start up and it ready to use. - - If you get an error that the port is in use, check for any applications using the same port and make sure they are each using unique ports. - - Try the following command (replace 9443 accordingly if using a non standard port): - - ```bash - curl --insecure -X GET https://localhost:9443/open-metadata/platform-services/users/test/server-platform/origin - ``` - Returns - ```text - Egeria OMAG Server Platform (version 4.2) - ``` - - This calls the OMAG server platform using a REST API call. The response `Egeria OMAG Server Platform (release X.x)` means the curl command communicated with a running OMAG Server Platform instance. - - The OMAG Server Platform has many REST APIs. Enter **https://localhost:9443/swagger-ui/index.html** into your browser to see the list of available REST APIs. - - Broadly speaking, the OMAG Server Platform supports: - - * Services to operate the platform. - * Open metadata and governance services to manage the open metadata ecosystem. - - The services operating the platform (primarily the [Administration Services](/services/admin-services/overview) and [Platform Services](/services/platform-services/overview)) are available all the time the OMAG Server Platform is running. The open metadata and governance services include a server name in the URL and they are routed to the named OMAG Server running on the OMAG Server Platform. - - OMAG Servers are started on the OMAG Server Platform through the Platform Services using a [configuration document](/concepts/configuration-document). This configuration document is configured in the OMAG Server Platform using the Administration Services. - - Understanding how to create a configuration document using the administration services is the next task in this tutorial. + --8<-- "snippets/tasks/task-starting-omag-server-platform-from-jar.md" + --8<-- "snippets/tasks/task-understanding-rest-apis.md" ??? education "Creating Configuration Documents" - ### Creating configuration documents for the OMAG Server Platform - - The [OMAG Server Platform](/concepts/omag-server-platform) provides a software platform for running [OMAG Servers](/concepts/omag-server). - - Each OMAG Server supports selected open metadata and governance services based on its configuration. - - #### What is a configuration document? - - A [configuration document](/concepts/configuration-document) defines the configuration properties for an OMAG server. It includes the properties for an OMAG server including the services that it supports. - - Configuration documents are typically created using the OMAG Server Platform [Administration Services](/services/admin-services/overview). In order to experiment with these services, this tutorial uses the [Postman](/education/tutorials/omag-server-tutorial/task-working-with-postman) test tool. This is a tool that enables you to type in REST API calls and execute them against the OMAG server platform. - - There is also a postman collection [omag-server-platform-tutorial.postman_collection.json](https://github.com/odpi/egeria-docs/blob/main/site/docs/education/tutorials/omag-server-tutorial/resources/omag-server-platform-tutorial.postman_collection.json) that you can download and import into postman to support this tutorial. (see **Import** button top left of the Postman user interface). - - This tutorial will also use `curl` commands to illustrate calls to the administration services as well as refer to the pre-canned calls in the postman collection. - - - #### Creating the configuration document - - Before there is a configuration document, requesting the server configuration creates and returns a default document. The command is: - - ``` - GET {platformURLRoot}/open-metadata/admin-services/users/{adminUserId}/servers/{serverName}/configuration - ``` - - where: + --8<-- "snippets/tasks/task-creating-configuration-documents.md" - * `{platformURLRoot}` is the host name and port number of the OMAG Server Platform (eg https://localhost:9443). - * `{adminUserId}` is the user id of the administrator making the calls. - * `{serverName}` is the name of the OMAG server that is being configured. - - Try the following command (this is request **2.** in Postman): - - ``` - GET https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/configuration - ``` - - The response is in JSON format and contains the following information: - - ```json - { - "class": "OMAGServerConfigResponse", - "relatedHTTPCode": 200, - "omagserverConfig": { - "class": "OMAGServerConfig", - "versionId": "V2.0", - "localServerId": "b49ab686-7b3b-4429-97fd-8d964ef3a4ff", - "localServerName": "myMetadataServer", - "localServerType": "Open Metadata and Governance Server", - "localServerURL": "https://localhost:9443", - "localServerUserId": "OMAGServer", - "maxPageSize": 1000 - } - } - ``` - - * The **localServerId** property is a unique identifier given to the server and is used internally to improve the performance of its interaction with external components such as Apache Kafka. - * The **localServerName** is the name of the OMAG server supplied on the command. - * The **localServerType**, **localServerURL**, **localServerUserId** and **maxPageSize** are set to their default values and can be changed. - - For example, try the following command (this is request **3.** in Postman): - - ``` - POST https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/server-type?typeName="Metadata Access Store" - ``` - - Then query the configuration again (this is request **2.** in Postman): - - ```json - { - "class": "OMAGServerConfigResponse", - "relatedHTTPCode": 200, - "omagserverConfig": { - "class": "OMAGServerConfig", - "versionId": "V2.0", - "localServerId": "b49ab686-7b3b-4429-97fd-8d964ef3a4ff", - "localServerName": "myMetadataServer", - "localServerType": "Metadata Access Store", - "localServerURL": "https://localhost:9443", - "localServerUserId": "OMAGServer", - "maxPageSize": 1000, - "auditTrail": [ - "Sun Jun 11 20:49:09 BST 2023 garygeeke updated configuration for local server type name to Metadata Access Store." - ] - } - } - ``` - - Notice that the localServerType has changed and an audit trail has also appeared. This allows you to keep track of the changes being made to the configuration document. - - The next command configures in type of metadata repository (this is request **4.** in Postman). In this example, we are using a simple in-memory repository which is useful for testing. - - ``` - POST https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/local-repository/mode/in-memory-repository - ``` - - This has added the configuration for the local repository using default values. If you query the configuration again (this is request **2.** in Postman) you see a lot has been added. This includes the definition for the repository as well as a default audit logging destination which ensures that the server writes it audit log messages to the console when it starts up. - - ```json - { - "class": "OMAGServerConfigResponse", - "relatedHTTPCode": 200, - "omagserverConfig": { - "class": "OMAGServerConfig", - "versionId": "V2.0", - "localServerId": "b49ab686-7b3b-4429-97fd-8d964ef3a4ff", - "localServerName": "myMetadataServer", - "localServerType": "Metadata Access Store", - "localServerURL": "https://localhost:9443", - "localServerUserId": "OMAGServer", - "maxPageSize": 1000, - "repositoryServicesConfig": { - "class": "RepositoryServicesConfig", - "auditLogConnections": [ - { - "class": "Connection", - "headerVersion": 0, - "qualifiedName": "Console- default", - "displayName": "Console", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "4afac741-3dcc-4c60-a4ca-a6dede994e3f", - "qualifiedName": "Egeria:AuditLogDestinationConnector:Console", - "displayName": "Console Audit Log Destination Connector", - "description": "Connector supports logging of audit log messages to stdout.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.console.ConsoleAuditLogStoreProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogStore" - ], - "recognizedConfigurationProperties": [ - "supportedSeverities" - ] - }, - "configurationProperties": { - "supportedSeverities": [ - "", - "Information", - "Event", - "Decision", - "Action", - "Error", - "Exception", - "Security", - "Startup", - "Shutdown", - "Asset", - "Types", - "Cohort" - ] - } - } - ], - "localRepositoryConfig": { - "class": "LocalRepositoryConfig", - "metadataCollectionId": "02694e83-a284-4f03-ac0c-34bfa2ce5c65", - "localRepositoryMode": "OPEN_METADATA_NATIVE", - "localRepositoryLocalConnection": { - "class": "Connection", - "headerVersion": 0, - "displayName": "In Memory Local Repository Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "65cc9091-757f-4bcd-b937-426160be8bc2", - "qualifiedName": "Egeria:OMRSRepositoryConnector:InMemory", - "displayName": "In Memory OMRS Repository Connector", - "description": "Native open metadata repository connector that maps open metadata calls to a set of in memory hash maps - demo use only.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" - ] - } - }, - "localRepositoryRemoteConnection": { - "class": "Connection", - "headerVersion": 0, - "displayName": "Local Repository Remote Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "75ea56d1-656c-43fb-bc0c-9d35c5553b9e", - "qualifiedName": "Egeria:OMRSRepositoryConnector:CohortMemberClient:REST", - "displayName": "REST Cohort Member Client Connector", - "description": "Cohort member client connector that provides access to open metadata located in a remote repository via REST calls.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" - ] - }, - "endpoint": { - "class": "Endpoint", - "headerVersion": 0, - "address": "https://localhost:9443/servers/myMetadataServer" - } - }, - "eventsToSaveRule": "ALL", - "eventsToSendRule": "ALL" - } - }, - "auditTrail": [ - "Sun Jun 11 20:49:09 BST 2023 garygeeke updated configuration for local server type name to Metadata Access Store.", - "Sun Jun 11 20:52:09 BST 2023 garygeeke updated configuration for the local repository." - ] - } - } - ``` - - The next command to configure the server is to enable the [Open Metadata Access Services (OMASs)](/services/omas). These are specialized open metadata and governance services. - - It is possible to activate each OMAS individually, but the the sake of this exercise we are going to activate them all using this command (request **5.** in Postman). - - ``` - GET https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/access-services/no-topics - ``` - - The OMASs provide both REST APIs and notifications. The `no-topics` part of the command turns off the notifications so we don't need to set up Apache Kafka for this exercise. - - The final command requests that an [Open Metadata Archive](/concepts/open-metadata-archive) is loaded to provide some sample metadata. The name of the open metadata archive file (`content-packs/SimpleDataCatalog.json`) is sent in the request body. - - ``` - GET https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/open-metadata-archives/file - ``` - - When the configuration is next queried (this is request **2.** in Postman), the complete configuration document is shown. - - ```json - { - "class": "OMAGServerConfigResponse", - "relatedHTTPCode": 200, - "omagserverConfig": { - "class": "OMAGServerConfig", - "versionId": "V2.0", - "localServerId": "b49ab686-7b3b-4429-97fd-8d964ef3a4ff", - "localServerName": "myMetadataServer", - "localServerType": "Metadata Access Store", - "localServerURL": "https://localhost:9443", - "localServerUserId": "OMAGServer", - "maxPageSize": 1000, - "accessServicesConfig": [ - { - "class": "AccessServiceConfig", - "accessServiceId": 210, - "accessServiceDevelopmentStatus": "TECHNICAL_PREVIEW", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.datamanager.admin.DataManagerAdmin", - "accessServiceName": "Data Manager", - "accessServiceFullName": "Data Manager OMAS", - "accessServiceURLMarker": "data-manager", - "accessServiceDescription": "Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system.", - "accessServiceWiki": "https://egeria-project.org/services/omas/data-manager/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 226, - "accessServiceDevelopmentStatus": "TECHNICAL_PREVIEW", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.subjectarea.admin.SubjectAreaAdmin", - "accessServiceName": "Subject Area", - "accessServiceFullName": "Subject Area OMAS", - "accessServiceURLMarker": "subject-area", - "accessServiceDescription": "Document knowledge about a subject area", - "accessServiceWiki": "https://egeria-project.org/services/omas/subject-area/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 218, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.glossaryview.server.admin.GlossaryViewAdmin", - "accessServiceName": "Glossary View", - "accessServiceFullName": "Glossary View OMAS", - "accessServiceURLMarker": "glossary-view", - "accessServiceDescription": "Support glossary terms visualization", - "accessServiceWiki": "https://egeria-project.org/services/omas/glossary-view/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 213, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.designmodel.admin.DesignModelAdmin", - "accessServiceName": "Design Model", - "accessServiceFullName": "Design Model OMAS", - "accessServiceURLMarker": "design-model", - "accessServiceDescription": "Exchange design model content with tools and standard packages", - "accessServiceWiki": "https://egeria-project.org/services/omas/design-model/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 223, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.securityofficer.server.admin.SecurityOfficerAdmin", - "accessServiceName": "Security Officer", - "accessServiceFullName": "Security Officer OMAS", - "accessServiceURLMarker": "security-officer", - "accessServiceDescription": "Set up rules and security tags to protect data", - "accessServiceWiki": "https://egeria-project.org/services/omas/security-officer/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 204, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetmanager.admin.AssetManagerAdmin", - "accessServiceName": "Asset Manager", - "accessServiceFullName": "Asset Manager OMAS", - "accessServiceURLMarker": "asset-manager", - "accessServiceDescription": "Manage metadata from a third party asset manager", - "accessServiceWiki": "https://egeria-project.org/services/omas/asset-manager/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 208, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.itinfrastructure.admin.ITInfrastructureAdmin", - "accessServiceName": "IT Infrastructure", - "accessServiceFullName": "IT Infrastructure OMAS", - "accessServiceURLMarker": "it-infrastructure", - "accessServiceDescription": "Manage information about the deployed IT infrastructure", - "accessServiceWiki": "https://egeria-project.org/services/omas/it-infrastructure/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 212, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.datascience.admin.DataScienceAdmin", - "accessServiceName": "Data Science", - "accessServiceFullName": "Data Science OMAS", - "accessServiceURLMarker": "data-science", - "accessServiceDescription": "Create and manage data science definitions and models", - "accessServiceWiki": "https://egeria-project.org/services/omas/data-science/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 207, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.communityprofile.admin.CommunityProfileAdmin", - "accessServiceName": "Community Profile", - "accessServiceFullName": "Community Profile OMAS", - "accessServiceURLMarker": "community-profile", - "accessServiceDescription": "Define personal profile and collaborate", - "accessServiceWiki": "https://egeria-project.org/services/omas/community-profile/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 209, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.dataengine.server.admin.DataEngineAdmin", - "accessServiceName": "Data Engine", - "accessServiceFullName": "Data Engine OMAS", - "accessServiceURLMarker": "data-engine", - "accessServiceDescription": "Exchange process models and lineage with a data engine", - "accessServiceWiki": "https://egeria-project.org/services/omas/data-engine/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 217, - "accessServiceDevelopmentStatus": "TECHNICAL_PREVIEW", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.discoveryengine.admin.DiscoveryEngineAdmin", - "accessServiceName": "Discovery Engine", - "accessServiceFullName": "Discovery Engine OMAS", - "accessServiceURLMarker": "discovery-engine", - "accessServiceDescription": "Support for automated metadata discovery engines", - "accessServiceWiki": "https://egeria-project.org/services/omas/discovery-engine/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 215, - "accessServiceDevelopmentStatus": "TECHNICAL_PREVIEW", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.digitalarchitecture.admin.DigitalArchitectureAdmin", - "accessServiceName": "Digital Architecture", - "accessServiceFullName": "Digital Architecture OMAS", - "accessServiceURLMarker": "digital-architecture", - "accessServiceDescription": "Design of the digital services for an organization", - "accessServiceWiki": "https://egeria-project.org/services/omas/digital-architecture/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 205, - "accessServiceDevelopmentStatus": "STABLE", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetowner.admin.AssetOwnerAdmin", - "accessServiceName": "Asset Owner", - "accessServiceFullName": "Asset Owner OMAS", - "accessServiceURLMarker": "asset-owner", - "accessServiceDescription": "Manage an asset", - "accessServiceWiki": "https://egeria-project.org/services/omas/asset-owner/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 225, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.stewardshipaction.admin.StewardshipActionAdmin", - "accessServiceName": "Stewardship Action", - "accessServiceFullName": "Stewardship Action OMAS", - "accessServiceURLMarker": "stewardship-action", - "accessServiceDescription": "Manage exceptions and actions from open governance", - "accessServiceWiki": "https://egeria-project.org/services/omas/stewardship-action/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 220, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.governanceprogram.admin.GovernanceProgramAdmin", - "accessServiceName": "Governance Program", - "accessServiceFullName": "Governance Program OMAS", - "accessServiceURLMarker": "governance-program", - "accessServiceDescription": "Manage the governance program", - "accessServiceWiki": "https://egeria-project.org/services/omas/governance-program/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 216, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.digitalservice.admin.DigitalServiceAdmin", - "accessServiceName": "Digital Service", - "accessServiceFullName": "Digital Service OMAS", - "accessServiceURLMarker": "digital-service", - "accessServiceDescription": "Manage a digital service through its lifecycle", - "accessServiceWiki": "https://egeria-project.org/services/omas/digital-service/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 203, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetlineage.admin.AssetLineageAdmin", - "accessServiceName": "Asset Lineage", - "accessServiceFullName": "Asset Lineage OMAS", - "accessServiceURLMarker": "asset-lineage", - "accessServiceDescription": "Store asset lineage", - "accessServiceWiki": "https://egeria-project.org/services/omas/asset-lineage/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 201, - "accessServiceDevelopmentStatus": "STABLE", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetconsumer.admin.AssetConsumerAdmin", - "accessServiceName": "Asset Consumer", - "accessServiceFullName": "Asset Consumer OMAS", - "accessServiceURLMarker": "asset-consumer", - "accessServiceDescription": "Access assets through connectors", - "accessServiceWiki": "https://egeria-project.org/services/omas/asset-consumer/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 200, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetcatalog.admin.AssetCatalogAdmin", - "accessServiceName": "Asset Catalog", - "accessServiceFullName": "Asset Catalog OMAS", - "accessServiceURLMarker": "asset-catalog", - "accessServiceDescription": "Search and understand your assets", - "accessServiceWiki": "https://egeria-project.org/services/omas/asset-catalog/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 214, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.devops.admin.DevOpsAdmin", - "accessServiceName": "DevOps", - "accessServiceFullName": "DevOps OMAS", - "accessServiceURLMarker": "devops", - "accessServiceDescription": "Manage a DevOps pipeline", - "accessServiceWiki": "https://egeria-project.org/services/omas/dev-ops/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 224, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.softwaredeveloper.admin.SoftwareDeveloperAdmin", - "accessServiceName": "Software Developer", - "accessServiceFullName": "Software Developer OMAS", - "accessServiceURLMarker": "software-developer", - "accessServiceDescription": "Interact with software development tools", - "accessServiceWiki": "https://egeria-project.org/services/omas/software-developer/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 221, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.projectmanagement.admin.ProjectManagementAdmin", - "accessServiceName": "Project Management", - "accessServiceFullName": "Project Management OMAS", - "accessServiceURLMarker": "project-management", - "accessServiceDescription": "Manage governance related projects", - "accessServiceWiki": "https://egeria-project.org/services/omas/project-management/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 219, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.governanceengine.admin.GovernanceEngineAdmin", - "accessServiceName": "Governance Engine", - "accessServiceFullName": "Governance Engine OMAS", - "accessServiceURLMarker": "governance-engine", - "accessServiceDescription": "Set up an operational governance engine", - "accessServiceWiki": "https://egeria-project.org/services/omas/governance-engine/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 211, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.dataprivacy.admin.DataPrivacyAdmin", - "accessServiceName": "Data Privacy", - "accessServiceFullName": "Data Privacy OMAS", - "accessServiceURLMarker": "data-privacy", - "accessServiceDescription": "Manage governance of privacy", - "accessServiceWiki": "https://egeria-project.org/services/omas/data-privacy/overview/", - "accessServiceOperationalStatus": "ENABLED" - }, - { - "class": "AccessServiceConfig", - "accessServiceId": 222, - "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", - "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.securitymanager.admin.SecurityManagerAdmin", - "accessServiceName": "Security Manager", - "accessServiceFullName": "Security Manager OMAS", - "accessServiceURLMarker": "security-manager", - "accessServiceDescription": "Manages exchange of metadata with a security service", - "accessServiceWiki": "https://egeria-project.org/services/omas/security-manager/overview/", - "accessServiceOperationalStatus": "ENABLED" - } - ], - "repositoryServicesConfig": { - "class": "RepositoryServicesConfig", - "auditLogConnections": [ - { - "class": "Connection", - "headerVersion": 0, - "qualifiedName": "Console- default", - "displayName": "Console", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "4afac741-3dcc-4c60-a4ca-a6dede994e3f", - "qualifiedName": "Egeria:AuditLogDestinationConnector:Console", - "displayName": "Console Audit Log Destination Connector", - "description": "Connector supports logging of audit log messages to stdout.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.console.ConsoleAuditLogStoreProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogStore" - ], - "recognizedConfigurationProperties": [ - "supportedSeverities" - ] - }, - "configurationProperties": { - "supportedSeverities": [ - "", - "Information", - "Event", - "Decision", - "Action", - "Error", - "Exception", - "Security", - "Startup", - "Shutdown", - "Asset", - "Types", - "Cohort" - ] - } - } - ], - "openMetadataArchiveConnections": [ - { - "class": "Connection", - "headerVersion": 0, - "displayName": "Open Metadata Archive File content-packs/SimpleDataCatalog.json Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "f4b49aa8-4f8f-4e0d-a725-fef8fa6ae722", - "qualifiedName": "Egeria:OpenMetadataArchiveStoreConnector:File", - "displayName": "File-based Open Metadata Archive Store Connector", - "description": "Connector supports storing of an open metadata archive as a single file stored using JSON format.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.file.FileBasedOpenMetadataArchiveStoreProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStore" - ] - }, - "endpoint": { - "class": "Endpoint", - "headerVersion": 0, - "address": "content-packs/SimpleDataCatalog.json" - } - } - ], - "localRepositoryConfig": { - "class": "LocalRepositoryConfig", - "metadataCollectionId": "02694e83-a284-4f03-ac0c-34bfa2ce5c65", - "localRepositoryMode": "OPEN_METADATA_NATIVE", - "localRepositoryLocalConnection": { - "class": "Connection", - "headerVersion": 0, - "displayName": "In Memory Local Repository Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "65cc9091-757f-4bcd-b937-426160be8bc2", - "qualifiedName": "Egeria:OMRSRepositoryConnector:InMemory", - "displayName": "In Memory OMRS Repository Connector", - "description": "Native open metadata repository connector that maps open metadata calls to a set of in memory hash maps - demo use only.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" - ] - } - }, - "localRepositoryRemoteConnection": { - "class": "Connection", - "headerVersion": 0, - "displayName": "Local Repository Remote Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "75ea56d1-656c-43fb-bc0c-9d35c5553b9e", - "qualifiedName": "Egeria:OMRSRepositoryConnector:CohortMemberClient:REST", - "displayName": "REST Cohort Member Client Connector", - "description": "Cohort member client connector that provides access to open metadata located in a remote repository via REST calls.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" - ] - }, - "endpoint": { - "class": "Endpoint", - "headerVersion": 0, - "address": "https://localhost:9443/servers/myMetadataServer" - } - }, - "eventsToSaveRule": "ALL", - "eventsToSendRule": "ALL" - }, - "enterpriseAccessConfig": { - "class": "EnterpriseAccessConfig", - "enterpriseMetadataCollectionName": "myMetadataServer Enterprise Metadata Collection", - "enterpriseMetadataCollectionId": "78fbc21f-ffff-45ad-9466-310fc70337d0", - "enterpriseOMRSTopicConnection": { - "class": "VirtualConnection", - "headerVersion": 0, - "displayName": "Enterprise OMRS Topic Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "qualifiedName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", - "displayName": "OMRS Topic Connector", - "description": "Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.", - "connectorProviderClassName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicListener", - "org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension", - "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopic" - ] - }, - "embeddedConnections": [ - { - "class": "EmbeddedConnection", - "headerVersion": 0, - "position": 0, - "displayName": "Enterprise OMRS Events", - "embeddedConnection": { - "class": "Connection", - "headerVersion": 0, - "displayName": "Kafka Event Bus Connection", - "connectorType": { - "class": "ConnectorType", - "headerVersion": 0, - "type": { - "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", - "typeName": "ConnectorType", - "typeVersion": 1, - "typeDescription": "A set of properties describing a type of connector." - }, - "guid": "ed8e682b-2fec-4403-b551-02f8c46322ef", - "qualifiedName": "Egeria:OpenMetadataTopicConnector:InMemory", - "displayName": "In Memory Open Metadata Topic Connector", - "description": "In Memory Open Metadata Topic Connector supports string based events over an in memory event bus.", - "connectorProviderClassName": "org.odpi.openmetadata.adapters.eventbus.topic.inmemory.InMemoryOpenMetadataTopicProvider", - "connectorFrameworkName": "Open Connector Framework (OCF)", - "connectorInterfaceLanguage": "Java", - "connectorInterfaces": [ - "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", - "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", - "java.lang.Runnable", - "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic" - ] - }, - "endpoint": { - "class": "Endpoint", - "headerVersion": 0, - "address": "myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic" - }, - "configurationProperties": { - "local.server.id": "b49ab686-7b3b-4429-97fd-8d964ef3a4ff" - } - } - } - ] - }, - "enterpriseOMRSTopicProtocolVersion": "V1" - } - }, - "auditTrail": [ - "Sun Jun 11 20:49:09 BST 2023 garygeeke updated configuration for local server type name to Metadata Access Store.", - "Sun Jun 11 20:52:09 BST 2023 garygeeke updated configuration for the local repository.", - "Sun Jun 11 20:58:16 BST 2023 garygeeke updated configuration for access services.", - "Sun Jun 11 20:58:16 BST 2023 garygeeke updated configuration for enterprise repository services (used by access services).", - "Sun Jun 11 21:07:23 BST 2023 garygeeke updated list of open metadata archives loaded at server start up." - ] - } - } - ``` - - You have probably noticed how quickly the configuration document grew into a complex structure. The commands you used made use of all of the configuration default values. There are other commands that enable you to customize the configuration document to - adapt it to specific environment. However, the defaults provide a good starting point. - - !!! education "Further reading" - The contents of this tutorial cover a very simple OMAG server configuration. For guidance on configuring more complex OMAG servers see the [Administration Services User Guide](/guides/admin) - ??? education "Activating an OMAG Server in the OMAG Server Platform" - ### Activating OMAG servers in the OMAG server platform - - Once you have [created a configuration document for an OMAG server](task-creating-configuration-documents.md) - it is started in the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is request **7.** in Postman). - - ``` - POST https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platformservers/myMetadataServer/instance - ``` - - The response from the command lists the subsystems that have been activated in the OMAG server: - - ```json - { - "class": "SuccessMessageResponse", - "relatedHTTPCode": 200, - "successMessage": "Sun Jun 11 21:19:16 BST 2023 myMetadataServer is running the following services: [Open Metadata Repository Services (OMRS), Connected Asset Services, Open Metadata Store Services, Open Integration Service, Data Manager OMAS, Subject Area OMAS, Glossary View OMAS, Design Model OMAS, Security Officer OMAS, Asset Manager OMAS, IT Infrastructure OMAS, Data Science OMAS, Community Profile OMAS, Data Engine OMAS, Discovery Engine OMAS, Digital Architecture OMAS, Asset Owner OMAS, Stewardship Action OMAS, Governance Program OMAS, Digital Service OMAS, Asset Lineage OMAS, Asset Consumer OMAS, Asset Catalog OMAS, DevOps OMAS, Software Developer OMAS, Project Management OMAS, Governance Engine OMAS, Data Privacy OMAS, Security Manager OMAS]" - } - ``` - - The window where your OMAG Server Platform is running will show the start-up - audit log messages, something like this: - - ```text - Project Egeria - Open Metadata and Governance - ____ __ ___ ___ ______ _____ ____ _ _ ___ - / __ \ / |/ // | / ____/ / ___/ ___ ____ _ __ ___ ____ / _ \ / / __ / / / _ /__ ____ _ _ - / / / // /|_/ // /| | / / __ \__ \ / _ \ / __/| | / // _ \ / __/ / /_/ // // | / _\ / /_ / | / _// || | - / /_/ // / / // ___ |/ /_/ / ___/ // __// / | |/ // __// / / __ // // / \ / /_ / _// / // / / / / / - \____//_/ /_//_/ |_|\____/ /____/ \___//_/ |___/ \___//_/ /_/ /_/ \__/\//___//_/ \__//_/ /_/ /_/ - - :: Powered by Spring Boot (v3.0.6) :: - - 2023-06-11T20:48:53.256+01:00 INFO 4805 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 4805 (/Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz/platform/omag-server-platform-4.2-SNAPSHOT.jar started by mandy-chessell in /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz) - 2023-06-11T20:48:53.259+01:00 INFO 4805 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : No active profile set, falling back to 1 default profile: "default" - 2023-06-11T20:48:56.607+01:00 INFO 4805 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9443 (https) - 2023-06-11T20:48:57.924+01:00 INFO 4805 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz - 2023-06-11T20:48:57.924+01:00 WARN 4805 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Java trust store 'javax.net.ssl.trustStore' is null - this is needed by Tomcat - using 'server.ssl.trust-store' - 2023-06-11T20:49:00.519+01:00 INFO 4805 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 9443 (https) with context path '' - 2023-06-11T20:49:00.539+01:00 INFO 4805 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Started OMAGServerPlatform in 7.942 seconds (process running for 8.699) - Sun Jun 11 20:49:00 BST 2023 No OMAG servers listed in startup configuration - Sun Jun 11 20:49:00 BST 2023 OMAG server platform ready for more configuration - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0064 The Open Metadata Repository Services (OMRS) has initialized the audit log for the Metadata Access Store called myMetadataServer - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMAG-ADMIN-0001 The myMetadataServer server is configured with a max page size of 1000 - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0001 The Open Metadata Repository Services (OMRS) is initializing the subsystems to support a new server - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0002 Enterprise access through the Enterprise Repository Services is initializing - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0003 The local repository is initializing the metadata collection named myMetadataServer with an id of 02694e83-a284-4f03-ac0c-34bfa2ce5c65 - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0029 The local repository outbound event manager is initializing - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0030 Registering the Local Repository to Local Enterprise event consumer with the local repository outbound event manager - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0044 The connector for the local repository is being started in mode Open Metadata Native using connector provider org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider and configuration properties null - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0045 The connector for the local repository has been initialized - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0046 The connector for the local repository is about to be started - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Startup OMRS-AUDIT-0047 The connector for the local repository has been started - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Information OMRS-AUDIT-0050 The Open Metadata Repository Services (OMRS) is about to process open metadata archive Open Metadata Types - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Types OMRS-AUDIT-0301 The local server has added a new type called object with a unique identifier of 1c4b21f4-0b67-41a7-a6ed-2af185eb9b3b and a version number of 1 from Egeria (4.2) - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Types OMRS-AUDIT-0301 The local server has added a new type called boolean with a unique identifier of 3863f010-611c-41fe-aaae-5d4d427f863b and a version number of 1 from Egeria (4.2) - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Types OMRS-AUDIT-0301 The local server has added a new type called byte with a unique identifier of 6b7d410a-2e8a-4d12-981a-a806449f9bdb and a version number of 1 from Egeria (4.2) - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Types OMRS-AUDIT-0301 The local server has added a new type called char with a unique identifier of b0abebe5-cf85-4065-86ad-f3c6360ed9c7 and a version number of 1 from Egeria (4.2) - Sun Jun 11 21:19:14 BST 2023 myMetadataServer Types OMRS-AUDIT-0301 The local server has added a new type called short with a unique identifier of 8e95b966-ab60-46d4-a03f-40c5a1ba6c2a and a version number of 1 from Egeria (4.2) - : : : : : : : : : : : : : : : - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Types OMRS-AUDIT-0303 The local server has updated an existing type called DigitalProduct with a unique identifier of 4aaaa7ca-6b4b-4c4b-997f-d5dfd42917b0 to version number of 3 using a patch from Egeria (4.1) - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Types OMRS-AUDIT-0303 The local server has updated an existing type called Process with a unique identifier of d8f33bd7-afa9-4a11-a8c7-07dcec83c050 to version number of 3 using a patch from Egeria (4.1) - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Information OMRS-AUDIT-0053 The Open Metadata Repository Services (OMRS) has processed 1025 types and 0 instances from open metadata archive Open Metadata Types - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OCF-FILE-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0001 Opening file "content-packs/SimpleDataCatalog.json" for Open Metadata Archive Store - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Information OMRS-AUDIT-0050 The Open Metadata Repository Services (OMRS) is about to process open metadata archive SimpleDataCatalog - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Information OMRS-AUDIT-0053 The Open Metadata Repository Services (OMRS) has processed 0 types and 15 instances from open metadata archive SimpleDataCatalog - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Repository REST Services - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Repository REST Services has started - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0007 The Open Metadata Repository Services (OMRS) has initialized - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0031 The local repository outbound event manager is starting with 1 type definition event consumer(s) and 1 instance event consumer(s) - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0032 The local repository outbound event manager is sending out the 1025 type definition events that were generated and buffered during server initialization - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Connected Asset Services - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Connected Asset Services has started - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup CONNECTED-ASSET-SERVICES-0001 The Open Connector Framework (OCF) Metadata Management Service is initializing the connected asset services in a new server instance - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup CONNECTED-ASSET-SERVICES-0003 The Open Connector Framework (OCF) Metadata Management Service has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OPEN-METADATA-STORE-0001 The Open Metadata Store Services are initializing a new server instance - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OPEN-METADATA-STORE-0005 The Open Metadata Store Services has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OPEN-INTEGRATION-SERVICE-0001 The Open Integration Service is initializing a new server instance - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OPEN-INTEGRATION-SERVICE-0005 The Open Integration Service has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMAG-ADMIN-0010 The Open Metadata Access Services (OMASs) are starting - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Data Manager OMAS - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Data Manager OMAS has started - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMAS-DATA-MANAGER-0001 The Data Manager Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMAS-DATA-MANAGER-0004 The Data Manager Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Subject Area OMAS - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Subject Area OMAS has started - Sun Jun 11 21:19:15 BST 2023 myMetadataServer Startup OMAS-SUBJECT_AREA-0001 The Subject Area Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SUBJECT_AREA-0003 The Subject Area Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Glossary View OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Glossary View OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GLOSSARY-VIEW-0001 The Glossary View Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GLOSSARY-VIEW-0002 The Glossary View Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Design Model OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Design Model OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DESIGN-MODEL-0001 The Design Model Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DESIGN-MODEL-0003 The Design Model Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Security Officer OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Security Officer OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SECURITY-OFFICER-0001 The Security Officer Open Metadata Access Service (OMAS) is initializing - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0209 The Security Officer OMAS Open Metadata Access Service (OMAS) is registering a listener with the enterprise OMRS Topic for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SECURITY-OFFICER-0003 The Security Officer Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Asset Manager OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Asset Manager OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-MANAGER-0001 The Asset Manager Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-MANAGER-0005 The Asset Manager Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the IT Infrastructure OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the IT Infrastructure OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-IT-INFRASTRUCTURE-0001 The IT Infrastructure Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-IT-INFRASTRUCTURE-0003 The IT Infrastructure Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Data Science OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Data Science OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-SCIENCE-0001 The Data Science Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-SCIENCE-0003 The Data Science Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Community Profile OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Community Profile OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-COMMUNITY-PROFILE-0001 The Community Profile Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0205 The Community Profile Open Metadata Access Service (OMAS) is not collecting karma points in this server - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0207 The Community Profile Open Metadata Access Service (OMAS) is using the default threshold for reporting Karma Point Plateaus: 500 - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-COMMUNITY-PROFILE-0004 The Community Profile Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Data Engine OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Data Engine OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-ENGINE-0001 The Data Engine Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-ENGINE-0002 The Data Engine Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Discovery Engine OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Discovery Engine OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DISCOVERY-ENGINE-0001 The Discovery Engine Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DISCOVERY-ENGINE-0003 The Discovery Engine Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Digital Architecture OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Digital Architecture OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DIGITAL-ARCHITECTURE-0001 The Digital Architecture Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DIGITAL-ARCHITECTURE-0003 The Digital Architecture Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Asset Owner OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Asset Owner OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-OWNER-0001 The Asset Owner Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-OWNER-0003 The Asset Owner Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Stewardship Action OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Stewardship Action OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-STEWARDSHIP-ACTION-0001 The Stewardship Action Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-STEWARDSHIP-ACTION-0003 The Stewardship Action Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Governance Program OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Governance Program OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GOVERNANCE-PROGRAM-0001 The Governance Program Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GOVERNANCE-PROGRAM-0002 The Governance Program Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Digital Service OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Digital Service OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DIGITAL-SERVICE-0001 The Digital Service Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DIGITAL-SERVICE-0003 The Digital Service Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Asset Lineage OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Asset Lineage OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-LINEAGE-0001 The Asset Lineage Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-LINEAGE-0002 The Asset Lineage Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Asset Consumer OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Asset Consumer OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-CONSUMER-0001 The Asset Consumer Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-CONSUMER-0003 The Asset Consumer Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Asset Catalog OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Asset Catalog OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-CATALOG-0002 The Asset Catalog Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-ASSET-CATALOG-0001 The Asset Catalog Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the DevOps OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the DevOps OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DEV-OPS-0001 The DevOps Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DEV-OPS-0003 The DevOps Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Software Developer OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Software Developer OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SOFTWARE-DEVELOPER-0001 The Software Developer Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SOFTWARE-DEVELOPER-0003 The Software Developer Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Project Management OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Project Management OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-PROJECT-MANAGEMENT-0001 The Project Management Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-PROJECT-MANAGEMENT-0003 The Project Management Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Governance Engine OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Governance Engine OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GOVERNANCE-ENGINE-0001 The Governance Engine Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-GOVERNANCE-ENGINE-0005 The Governance Engine Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Data Privacy OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Data Privacy OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-PRIVACY-0001 The Data Privacy Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-DATA-PRIVACY-0003 The Data Privacy Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0040 An enterprise OMRS connector has been created for the Security Manager OMAS - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0041 The enterprise OMRS connector for the Security Manager OMAS has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SECURITY-MANAGER-0001 The Security Manager Open Metadata Access Service (OMAS) is initializing a new server instance - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAS-SECURITY-MANAGER-0005 The Security Manager Open Metadata Access Service (OMAS) has initialized a new instance for server myMetadataServer - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0012 25 out of 25 configured Open Metadata Access Services (OMASs) have started. - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0019 An OMRS Topic Connector has registered with an event bus connector for topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0020 An OMRS Topic Connector is ready to send and receive events on topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0015 The listener thread for an OMRS Topic Connector for topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic has started - Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0004 The myMetadataServer server has successfully completed start up. The following services are running: [Open Metadata Repository Services (OMRS), Connected Asset Services, Open Metadata Store Services, Open Integration Service, Data Manager OMAS, Subject Area OMAS, Glossary View OMAS, Design Model OMAS, Security Officer OMAS, Asset Manager OMAS, IT Infrastructure OMAS, Data Science OMAS, Community Profile OMAS, Data Engine OMAS, Discovery Engine OMAS, Digital Architecture OMAS, Asset Owner OMAS, Stewardship Action OMAS, Governance Program OMAS, Digital Service OMAS, Asset Lineage OMAS, Asset Consumer OMAS, Asset Catalog OMAS, DevOps OMAS, Software Developer OMAS, Project Management OMAS, Governance Engine OMAS, Data Privacy OMAS, Security Manager OMAS] - ``` - - The start-up messages show the [open metadata types](/types) being loaded, followed by the open metadata archive `content-packs/SimpleDataCatalog.json`. Then the local repository is initialized and finally the OMASs are started. + --8<-- "snippets/tasks/task-starting-omag-server.md" ??? education "Calling the Open Metadata and Governance APIs" - ### Calling Open Metadata and Governance Services - - Now that the metadata server is started, it is possible to query the metadata. - - Egeria offers many different REST APIs to retrieve and maintain metadata. In this exercise it is not possible to try them all out. The aim is to show an example of how metadata is retrieved. The command below finds [assets](/concepts/asset). Assets represent resources such as data sets and servers used by the organization. - - ```text - POST https://localhost:9443/servers/myMetadataServer/open-metadata/access-services/asset-owner/users/peterprofile/assets/by-search-string?startFrom=0&pageSize=10 - ``` - The request body contains the search parameters. - ```json - { - "class" : "SearchStringRequestBody", - "searchString" : ".*." - } - ``` - The results show there are two assets in the metadata repository - a database and a database schema. - ```json - { - "class": "AssetElementsResponse", - "relatedHTTPCode": 200, - "startingFromElement": 0, - "assets": [ - { - "elementHeader": { - "class": "ElementHeader", - "headerVersion": 0, - "status": "ACTIVE", - "type": { - "typeId": "eab811ec-556a-45f1-9091-bc7ac8face0f", - "typeName": "DeployedDatabaseSchema", - "superTypeNames": [ - "DataSet", - "Asset", - "Referenceable", - "OpenMetadataRoot" - ], - "typeVersion": 1, - "typeDescription": "A collection of database tables and views running in a database server." - }, - "origin": { - "sourceServer": "myMetadataServer", - "originCategory": "DEREGISTERED_REPOSITORY", - "homeMetadataCollectionId": "2216ab62-176a-46c0-b889-9aa081754b54", - "homeMetadataCollectionName": "SimpleDataCatalog" - }, - "versions": { - "createdBy": "Egeria", - "createTime": "2021-09-19T10:10:51.579+00:00", - "version": 1 - }, - "guid": "4782e08b-043c-4017-9b2f-d63163f67fd8" - }, - "assetProperties": { - "class": "AssetProperties", - "qualifiedName": "V37B8752.FH567.sys/BRANCH.RETAILSCHEMA", - "typeName": "DeployedDatabaseSchema", - "displayName": "RETAILSCHEMA", - "name": "RETAILSCHEMA", - "description": "Retail banking schema.", - "ownerType": "OTHER" - } - }, - { - "elementHeader": { - "class": "ElementHeader", - "headerVersion": 0, - "status": "ACTIVE", - "type": { - "typeId": "0921c83f-b2db-4086-a52c-0d10e52ca078", - "typeName": "Database", - "superTypeNames": [ - "DataStore", - "Asset", - "Referenceable", - "OpenMetadataRoot" - ], - "typeVersion": 2, - "typeDescription": "A data store containing relational data." - }, - "origin": { - "sourceServer": "myMetadataServer", - "originCategory": "DEREGISTERED_REPOSITORY", - "homeMetadataCollectionId": "2216ab62-176a-46c0-b889-9aa081754b54", - "homeMetadataCollectionName": "SimpleDataCatalog" - }, - "versions": { - "createdBy": "Egeria", - "createTime": "2021-09-19T10:10:51.579+00:00", - "version": 1 - }, - "guid": "076b4498-a099-4c6b-9243-73e816b28504" - }, - "assetProperties": { - "class": "AssetProperties", - "qualifiedName": "V37B8752.FH567.sys/BRANCH", - "typeName": "Database", - "displayName": "BRANCH Database", - "name": "BRANCH Database", - "description": "Main branch system database.", - "ownerType": "OTHER" - } - } - ] - } - ``` - - !!! education "Further APIs" - * The [Open Metadata Access Services (OMASs)](/services/omas) show the range of APIs offered by Egeria. - * [Finding Metadata](/guides/developer/finding-metadata/overview) explains how metadata retrieval requests work. - + --8<-- "snippets/tasks/task-calling-omag-apis.md" + ??? education "Shutting down a server" - ### Shutting down OMAG servers in the OMAG server platform - - Once you have finished calling the open metadata and governance APIs you can stop your server in the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is command **8.** in Postman). - - ``` - POST https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers/myMetadataServer/instance - ``` - - The window where your OMAG server platform is running will show the shutdown messages - - ```text - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAG-ADMIN-0005 The myMetadataServer server has begun the shutdown process - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DATA-MANAGER-0005 The Data Manager Open Metadata Access Service (OMAS) is shutting down server instance myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-SUBJECT_AREA-0004 The Subject Area Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-GLOSSARY-VIEW-0003 The Glossary View Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DESIGN-MODEL-0004 The Design Model Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-SECURITY-OFFICER-0005 The Security Officer Open Metadata Access Service (OMAS) has completed shutdown of server instance myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-ASSET-MANAGER-0006 The Asset Manager Open Metadata Access Service (OMAS) is shutting down server instance myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-IT-INFRASTRUCTURE-0004 The IT Infrastructure Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DATA-SCIENCE-0004 The Data Science Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-COMMUNITY-PROFILE-0005 The Community Profile Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DATA-ENGINE-0003 The Data Engine Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DISCOVERY-ENGINE-0008 The Discovery Engine Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DIGITAL-ARCHITECTURE-0004 The Digital Architecture Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-ASSET-OWNER-0004 The Asset Owner Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-STEWARDSHIP-ACTION-0004 The Stewardship Action Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-GOVERNANCE-PROGRAM-0004 The Governance Program Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DIGITAL-SERVICE-0004 The Digital Service Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-ASSET-LINEAGE-0003 The Asset Lineage Open Metadata Access Service (OMAS) is shutting down server instance myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-ASSET-CONSUMER-0004 The Asset Consumer Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-ASSET-CATALOG-0004 The Asset Catalog Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DEV-OPS-0004 The DevOps Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-SOFTWARE-DEVELOPER-0004 The Software Developer Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-PROJECT-MANAGEMENT-0004 The Project Management Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-GOVERNANCE-ENGINE-0012 The Governance Engine Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-DATA-PRIVACY-0004 The Data Privacy Open Metadata Access Service (OMAS) is shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAS-SECURITY-MANAGER-0006 The Security Manager Open Metadata Access Service (OMAS) is shutting down server instance myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown CONNECTED-ASSET-SERVICES-0004 The Open Connector Framework (OCF) Metadata Management Service is shutting down its instance of the connected asset services for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OPEN-METADATA-STORE-0012 The Open Metadata Store Services are shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OPEN-INTEGRATION-SERVICE-0012 The Open Integration Service are shutting down its instance for server myMetadataServer - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMRS-AUDIT-0010 The Open Metadata Repository Services (OMRS) is disconnecting the open metadata repositories - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMRS-AUDIT-0021 The OMRS Topic Listener has disconnected the event bus connectors for topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMRS-AUDIT-0011 The Open Metadata Repository Services (OMRS) has disconnected from the open metadata repositories - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAG-ADMIN-0006 The myMetadataServer server has completed shutdown - Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMRS-AUDIT-0016 The listener thread for the OMRS Topic Connector for topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic has shutdown - ``` - - Even though the server has stopped, the platform is still running and it is possible to query the platform about the server. The next command queries the status of the server (this is command **9.** in Postman). - - ``` - GET https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers/myMetadataServer/status - ``` - - You can see that it is not currently active and the times when it was active. - - ```json - { - "class": "ServerStatusResponse", - "relatedHTTPCode": 200, - "serverName": "myMetadataServer", - "serverType": "Metadata Access Store", - "serverEndTime": "2023-06-11T20:52:43.631+00:00", - "serverHistory": [ - { - "startTime": "2023-06-11T20:19:15.181+00:00", - "endTime": "2023-06-11T20:52:43.631+00:00" - } - ], - "active": false - } - ``` - - You can experiment by starting and stopping your server and trying this status command both while it is running and after it is stopped to see the different statuses. - - !!! education "The platform operation services" - Explore the [Platform Services](/services/platform-services/overview) to discover more commands to monitor and control the OMAG Server Platform. + --8<-- "snippets/tasks/task-stopping-omag-server.md" ??? education "Deleting a server's configuration" - ### Deleting an OMAG server's configuration - - An [OMAG Server](/concepts/omag-server)'s configuration document can be deleted from the configuration store using the following command. - - ``` - DELETE https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/cocoMDS1/instance - ``` + --8<-- "snippets/tasks/task-deleting-omag-server.md" ??? education "Shutting down the platform" - ### Stopping the OMAG server platform - - Once you have Stopped your OMAG server you can stop the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is request **10.** in Postman). - - ``` - POST https://localhost:9443/open-metadata/admin-services/users/garygeeke/server-platform/instance - ``` - - There is no response from the request because the platform exits before it sends the response. + --8<-- "snippets/tasks/task-stopping-omag-server-platform.md" ## Digging Deeper -* [Running the Egeria samples](/education/tutorials/running-samples-tutorial/overview) -to understand more about the different Egeria APIs. -* [Calling the OMAG Clients from Java](/education/tutorials/omag-client-tutorial/overview) -to understand how to call Egeria APIs from your code. -* [Running the Open Metadata Conformance Suite](/guides/cts/overview) -to understand how a technology/software product can demonstrate -its conformance to the Egeria standards. +* [Running the Egeria samples](/education/tutorials/running-samples-tutorial/overview) to understand more about the different Egeria APIs. +* [Calling the OMAG Clients from Java](/education/tutorials/omag-client-tutorial/overview) to understand how to call Egeria APIs from your code. +* [Running the Open Metadata Conformance Suite](/guides/cts/overview) to understand how a technology/software product can demonstrate its conformance to the Egeria standards. --8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/education/tutorials/omag-server-tutorial/resources/omag-server-platform-tutorial.postman_collection.json b/site/docs/education/tutorials/omag-server-tutorial/resources/omag-server-platform-tutorial.postman_collection.json index 9f7960ddb9..88cb0177bb 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/resources/omag-server-platform-tutorial.postman_collection.json +++ b/site/docs/education/tutorials/omag-server-tutorial/resources/omag-server-platform-tutorial.postman_collection.json @@ -3,7 +3,8 @@ "_postman_id": "e45edfe1-cfa1-4423-807f-11d34701da47", "name": "omag-server-platform-tutorial", "description": "This postman collection covers the exercises described in the ODPi Egeria tutorial about the [OMAG Server Platform](https://egeria.odpi.org/open-metadata-resources/open-metadata-tutorials/omag-server-tutorial/)", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28623075" }, "item": [ { @@ -151,7 +152,7 @@ "header": [], "body": { "mode": "raw", - "raw": "content-packs/SimpleDataCatalog.json", + "raw": "content-packs/SimpleCatalog.json", "options": { "raw": { "language": "text" diff --git a/site/docs/education/tutorials/omag-server-tutorial/starting-the-omag-server-platform.md b/site/docs/education/tutorials/omag-server-tutorial/starting-the-omag-server-platform.md deleted file mode 100644 index 63a696f878..0000000000 --- a/site/docs/education/tutorials/omag-server-tutorial/starting-the-omag-server-platform.md +++ /dev/null @@ -1,81 +0,0 @@ - - - - -The [OMAG Server Platform's installation directory](/education/tutorials/building-egeria-tutorial/task-installing-egeria) contains a Java Archive (Jar) file for the [OMAG Server Platform](/concepts/omag-server-platform) itself along with a directory of libraries. - -The name of the Java Archive (Jar) file will depend on the release of Egeria that you have installed. In this example, the release is **4.2**. - -```bash -$ ls platform -lib omag-server-platform-4.2.jar -``` - -The OMAG Server Platform is started with the `java` command. - -??? tip "Checking your Java installation" - Ensure you have a Java runtime at Version 17 or above installed on your machine. Check the version of Java you have with the command **java -version** and [install the appropriate version](/education/tutorials/building-egeria-tutorial/task-installing-java) if needed. You only need the JRE but select the JDK if you expect to also write some Java code.) - -Start the OMAG server platform with the following command: - -```bash -java -Dloader.path=platform/lib -jar platform/omag-server-platform*.jar -``` - -This starts the platform listening on port `9443`. Add the `-Dserver.port` parameter before the `-jar` parameter if you wish the platform to listen on a different port. For example, the following command starts the platform listening on port `9444`. Multiple instances of the same OMAG Server Platform may run in a single machine (or in the same container). However, they each need to listen on a different port. - -```bash -java -Dloader.path=platform/lib -Dserver.port=9444 -jar platform/omag-server-platform*.jar -``` - -When the OMAG Server Platform starts up, it displays the `OMAG Server Platform` banner and then details of its configuration. - -```text - Project Egeria - Open Metadata and Governance - ____ __ ___ ___ ______ _____ ____ _ _ ___ - / __ \ / |/ // | / ____/ / ___/ ___ ____ _ __ ___ ____ / _ \ / / __ / / / _ /__ ____ _ _ - / / / // /|_/ // /| | / / __ \__ \ / _ \ / __/| | / // _ \ / __/ / /_/ // // | / _\ / /_ / | / _// || | - / /_/ // / / // ___ |/ /_/ / ___/ // __// / | |/ // __// / / __ // // / \ / /_ / _// / // / / / / / - \____//_/ /_//_/ |_|\____/ /____/ \___//_/ |___/ \___//_/ /_/ /_/ \__/\//___//_/ \__//_/ /_/ /_/ - - :: Powered by Spring Boot (v3.0.6) :: - -2023-06-11T13:13:57.959+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 85411 (/Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz/platform/omag-server-platform-4.2-SNAPSHOT.jar started by mandy-chessell in /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz) -2023-06-11T13:13:57.962+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : No active profile set, falling back to 1 default profile: "default" -2023-06-11T13:14:01.186+01:00 INFO 85411 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9443 (https) -2023-06-11T13:14:02.400+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: /Users/mandy-chessell/CloudStation/Drive/Code/ODPi/egeria-code/egeria/open-metadata-distribution/open-metadata-assemblies/build/unpacked/egeria-4.2-SNAPSHOT-distribution.tar.gz -2023-06-11T13:14:02.400+01:00 WARN 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Java trust store 'javax.net.ssl.trustStore' is null - this is needed by Tomcat - using 'server.ssl.trust-store' -2023-06-11T13:14:04.687+01:00 INFO 85411 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 9443 (https) with context path '' -2023-06-11T13:14:04.704+01:00 INFO 85411 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Started OMAGServerPlatform in 7.591 seconds (process running for 8.325) -Sun Jun 11 13:14:04 BST 2023 No OMAG servers listed in startup configuration -Sun Jun 11 13:14:04 BST 2023 OMAG server platform ready for more configuration -``` - -When you see the `OMAG server platform ready for more configuration` message, it means the OMAG Server has completed its start up and it ready to use. - -If you get an error that the port is in use, check for any applications using the same port and make sure they are each using unique ports. - -Try the following command (replace 9443 accordingly if using a non standard port): - -```bash -curl --insecure -X GET https://localhost:9443/open-metadata/platform-services/users/test/server-platform/origin -``` -```text -Egeria OMAG Server Platform (version 4.2) -``` - -This calls the OMAG server platform using a REST API call. The response `Egeria OMAG Server Platform (release X.x)` means the curl command communicated with a running OMAG Server Platform instance. - -The OMAG server platform has many REST APIs. Enter **https://localhost:9443/swagger-ui/index.html** into your browser to see the list of available REST APIs. - -Broadly speaking, the OMAG Server Platform supports: - -* Services to operate the platform. -* Open metadata and governance services to manage the open metadata ecosystem. - -The services operating the platform (primarily the [Administration Services](/services/admin-services/overview) and [Platform Services](/services/platform-services/overview)) are available all the time the OMAG Server Platform is running. The open metadata and governance services include a server name in the URL and they are routed to the named OMAG Server running on the OMAG Server Platform. - -OMAG Servers are started on the OMAG Server Platform through the Platform Services using a [configuration document](/concepts/configuration-document). This configuration document is configured in the OMAG Server Platform using the Administration Services. - -Understanding how to create a configuration document using the administration services [is the next task in this tutorial](/education/tutorials/omag-server-tutorial/task-creating-configuration-documents). - diff --git a/site/snippets/supported-platforms.md b/site/snippets/supported-platforms.md index 220a651ae9..d2d5ad7120 100644 --- a/site/snippets/supported-platforms.md +++ b/site/snippets/supported-platforms.md @@ -1,40 +1,42 @@ -=== "Supported Platforms - linux, macOS" - - Egeria currently supports building on *nix, Linux & Linux-like operating systems such as MacOS. - - Our official build pipelines are based on x86_64 architecture, but it is expected the build will run on other architectures, subject to the availability of the required tools and interpreters/jvms/runtimes on that platform (for example Java, Python, Docker/containerd/k8s etc). - -=== "Additional Platforms - Windows" - - Currently, the Egeria team does not regularly test or use Windows, so there may be areas that are not documented as well, or not work. We would welcome any interested developers who use Windows on a daily basis to join us and help improve this area! - - On Windows, you should use [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) Version 2 or above, and install a Linux distribution such as Ubuntu. This avoids issues we have seen with path separators, symbolic links, slow I/O performance, long path names. WSL version 2 should be used, not version 1, due to differences in file I/O (emulation). The docs above explain how to switch from v1 to v2. - - From the command line everything should work just as for macOS & linux, including building and running Egeria since a full linux distribution is being used, with a linux kernel. - - However, IDE use may be a little different. Some IDEs can run the GUI in Windows natively, and then use the WSL environment to perform build and execution. - - With IntelliJ the following process is most likely to work: - - * Ensure an Ubuntu environment is setup using WSL2 - * Install a java sdk, and maven as for mac/linux - * ensure a build at the command line works ok - * Install IntelliJ community edition on Windows. Using the latest version (2022.1 at time of writing) is recommended as WSL support is a new area - * Create a new project 'from existing sources' and ensure you point to //wsl$/..... (path in linux environment) - * After a few warnings as IntelliJ detects the code, your SDK should be set automatically to the linux java version - - Jetbrains have a [WSL2 support article](https://www.jetbrains.com/help/idea/how-to-use-wsl-development-environment-in-product.html){ target=jb } which elaborates these instructions in more detail - - Another option would be to run the IDE itself directly within the linux environment, and share the display via X11, VNC, or another form of remote desktop. This is likely to work, but could perform sluggishly. Microsoft are improving this area with [WSLg](https://www.google.com/search?client=safari&rls=en&q=wslg&ie=UTF-8&oe=UTF-8){ target=gh } , but this requires very new software, and dedicated graphics to work well. It's also outside the scope of this summary. - - Egeria provides both maven and gradle build scripts. On Windows we've seen issues with maven which can cause IntelliJ to be busy or unresponsive for hours. If this happens you could try to use the gradle build instead. To do this in IntelliJ: - - * Navigate to your maven tool window,click the top level maven project 'Egeria' & 'Unlink Maven Projects' - and confirm. - * In the left project tree right-click on the top level build.gradle and 'Link gradle project' - - Yet another option to use IntelliJ is to make use of [Remote Development](https://www.jetbrains.com/remote-development/){ target=jb }. With this configuration you would use a seperate linux system, and connect remotely. This is beyond the scope of these docs. - - Feedback on Windows, offers to help, clarification on the steps can be directed to [odpi/egeria-docs#335](https://github.com/odpi/egeria-docs/issues/335){ target=gh } +??? tip "Supported Platforms" + === "Linux, macOS" + + Egeria currently supports building on *nix, Linux and Linux-like operating systems such as MacOS. + + Our official build pipelines are based on x86_64 architecture, but it is expected the build will run on other architectures, subject to the availability of the required tools and interpreters/jvms/runtimes on that platform (for example Java, Python, Docker/containerd/k8s etc). + + === "Windows" + + Currently, the Egeria team does not regularly test or use Windows, so there may be areas that are not documented as well, or not work. We would welcome any interested developers who use Windows on a daily basis to join us and help improve this area! + + On Windows, you should use [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/) Version 2 or above, and install a Linux distribution such as Ubuntu. This avoids issues we have seen with path separators, symbolic links, slow I/O performance, long path names. WSL version 2 should be used, not version 1, due to differences in file I/O (emulation). The docs above explain how to switch from v1 to v2. + + From the command line everything should work just as for macOS & linux, including building and running Egeria since a full linux distribution is being used, with a linux kernel. + + However, IDE use may be a little different. Some IDEs can run the GUI in Windows natively, and then use the WSL environment to perform build and execution. + + With IntelliJ the following process is most likely to work: + + * Ensure an Ubuntu environment is setup using WSL2 + * Install a java sdk, and maven as for mac/linux + * ensure a build at the command line works ok + * Install IntelliJ community edition on Windows. Using the latest version (2022.1 at time of writing) is recommended as WSL support is a new area + * Create a new project 'from existing sources' and ensure you point to //wsl$/..... (path in linux environment) + * After a few warnings as IntelliJ detects the code, your SDK should be set automatically to the linux java version + + Jetbrains have a [WSL2 support article](https://www.jetbrains.com/help/idea/how-to-use-wsl-development-environment-in-product.html){ target=jb } which elaborates these instructions in more detail + + Another option would be to run the IDE itself directly within the linux environment, and share the display via X11, VNC, or another form of remote desktop. This is likely to work, but could perform sluggishly. Microsoft are improving this area with [WSLg](https://www.google.com/search?client=safari&rls=en&q=wslg&ie=UTF-8&oe=UTF-8){ target=gh } , but this requires very new software, and dedicated graphics to work well. It's also outside the scope of this summary. + + Egeria provides both maven and gradle build scripts. On Windows we've seen issues with maven which can cause IntelliJ to be busy or unresponsive for hours. If this happens you could try to use the gradle build instead. To do this in IntelliJ: + + * Navigate to your maven tool window,click the top level maven project 'Egeria' & 'Unlink Maven Projects' - and confirm. + * In the left project tree right-click on the top level build.gradle and 'Link gradle project' + + Yet another option to use IntelliJ is to make use of [Remote Development](https://www.jetbrains.com/remote-development/){ target=jb }. With this configuration you would use a seperate linux system, and connect remotely. This is beyond the scope of these docs. + + Feedback on Windows, offers to help, clarification on the steps can be directed to [odpi/egeria-docs#335](https://github.com/odpi/egeria-docs/issues/335){ target=gh } + \ No newline at end of file diff --git a/site/snippets/tasks/task-building-customized-docker-image.md b/site/snippets/tasks/task-building-customized-docker-image.md new file mode 100644 index 0000000000..263b392615 --- /dev/null +++ b/site/snippets/tasks/task-building-customized-docker-image.md @@ -0,0 +1,52 @@ + + + + +### Building a customized docker image + +The top-level directory of the Egeria omag-server-platform assembly contains the following files: + +```bash +$ ls +Dockerfile LICENSE NOTICE README.md assembly dist +``` + +The `Dockerfile` contains the properties for building a docker image of all the files under `assembly/platform`. + +Once you have the contents of `assembly/platform` as you want them, run the docker command: + +```bash +docker build -t egeria-platform:{myversion} -f Dockerfile . +``` +replacing `{myversion}` with a tag name for this docker image. The example below used `latest` as the tag name. + +```bash +? docker build -t egeria-platform:latest -f Dockerfile . +[+] Building 44.9s (5/5) FINISHED docker:desktop-linux + => [internal] load build definition from Dockerfile 0.0s + => => transferring dockerfile: 3.28kB 0.0s + => [internal] load .dockerignore 0.0s + => => transferring context: 2B 0.0s + => [internal] load metadata for registry.access.redhat.com/ubi9/openjdk-17:latest 1.5s + => [1/1] FROM registry.access.redhat.com/ubi9/openjdk-17@sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 43.3s + => => resolve registry.access.redhat.com/ubi9/openjdk-17@sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 0.0s + => => sha256:5cbda490fcb7ab72e85cfba7098858cd3ed6bb15f95687e86979f6d4ac7b2f15 596B / 596B 0.0s + => => sha256:5b5deb1288720666a590472d9a506500df9ebe3c817e9710327162ccd24c4e22 24.19kB / 24.19kB 0.0s + => => sha256:62742f27dce5ebff467a57ad6bfa680820f3bc534cc313627f8113246276bf0f 37.83MB / 37.83MB 17.9s + => => sha256:f008a4f4b21c818e8bbd4e2521eb30ab0f8a43dc259e9e51c0d134641e343acd 110.80MB / 110.80MB 37.5s + => => sha256:3eded7b50a5ff8a55895c7b70c9dfc6e320363e5812a68747f281f8f4bb323ac 1.47kB / 1.47kB 0.0s + => => extracting sha256:62742f27dce5ebff467a57ad6bfa680820f3bc534cc313627f8113246276bf0f 2.0s + => => extracting sha256:f008a4f4b21c818e8bbd4e2521eb30ab0f8a43dc259e9e51c0d134641e343acd 5.5s + => exporting to image 0.0s + => => exporting layers 0.0s + => => writing image sha256:5a2c784ed7558dc625d109c04c8b5e78534b270a29d3011eb771fd01724c097f 0.0s + => => naming to docker.io/library/egeria-platform:latest 0.0s + +What's Next? + View summary of image vulnerabilities and recommendations → docker scout quickview +``` + +The resulting docker image is published to the docker service configured on your local machine. + + + diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-calling-omag-apis.md b/site/snippets/tasks/task-calling-omag-apis.md similarity index 91% rename from site/docs/education/tutorials/omag-server-tutorial/task-calling-omag-apis.md rename to site/snippets/tasks/task-calling-omag-apis.md index 727b5249eb..2edd5f2158 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-calling-omag-apis.md +++ b/site/snippets/tasks/task-calling-omag-apis.md @@ -5,7 +5,7 @@ Now that the metadata server is started, it is possible to query the metadata. -Egeria offers many different REST APIs to retrieve and maintain metadata. In this exercise it is not possible to try them all out. The aim is to show an example of how metadata is retrieved. The command below finds [assets](/concepts/asset). Assets represent resources such as data sets and servers used by the organization. +Egeria offers a choice REST APIs to retrieve and maintain metadata. In this exercise it is not possible to try them all out. The aim is to show an example of how metadata is retrieved. The command below finds [assets](/concepts/asset). Assets represent resources such as data sets and servers used by the organization. ```text POST https://localhost:9443/servers/myMetadataServer/open-metadata/access-services/asset-owner/users/peterprofile/assets/by-search-string?startFrom=0&pageSize=10 @@ -108,7 +108,7 @@ The results show there are two assets in the metadata repository - a database an } ``` -!!! education "Further APIs" +!!! tip "Further APIs" * The [Open Metadata Access Services (OMASs)](/services/omas) show the range of APIs offered by Egeria. * [Finding Metadata](/guides/developer/finding-metadata/overview) explains how metadata retrieval requests work. diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-creating-configuration-documents.md b/site/snippets/tasks/task-creating-configuration-documents.md similarity index 98% rename from site/docs/education/tutorials/omag-server-tutorial/task-creating-configuration-documents.md rename to site/snippets/tasks/task-creating-configuration-documents.md index 1680efa841..0e7de56836 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-creating-configuration-documents.md +++ b/site/snippets/tasks/task-creating-configuration-documents.md @@ -1,13 +1,13 @@ -# Creating configuration documents for the OMAG Server Platform +### Creating configuration documents for the OMAG Server Platform The [OMAG Server Platform](/concepts/omag-server-platform) provides a software platform for running [OMAG Servers](/concepts/omag-server). Each OMAG Server supports selected open metadata and governance services based on its configuration. -## What is a configuration document? +#### What is a configuration document? A [configuration document](/concepts/configuration-document) defines the configuration properties for an OMAG server. It includes the properties for an OMAG server including the services that it supports. @@ -18,7 +18,7 @@ There is also a postman collection [omag-server-platform-tutorial.postman_collec This tutorial will also use `curl` commands to illustrate calls to the administration services as well as refer to the pre-canned calls in the postman collection. -## Creating the configuration document +#### Creating the configuration document Before there is a configuration document, requesting the server configuration creates and returns a default document. The command is: @@ -241,15 +241,15 @@ This has added the configuration for the local repository using default values. The next command to configure the server is to enable the [Open Metadata Access Services (OMASs)](/services/omas). These are specialized open metadata and governance services. -It is possible to activate each OMAS individually, but the the sake of this exercise we are going to activate them all using this command (request **5.** in Postman). +It is possible to activate each OMAS individually, but for the sake of this exercise we are going to activate them all using this command (request **5.** in Postman). ``` GET https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/access-services/no-topics ``` -The OMASs provide both REST APIs and notifications. The `no-topics` part of the command turns off the notifications so we don't need to set up Apache Kafka for this exercise. +The OMASs provide both REST APIs and notifications. The `no-topics` part of the command turns off the notifications, so we don't need to set up Apache Kafka for this exercise. -The final command requests that an [Open Metadata Archive](/concepts/open-metadata-archive) is loaded to provide some sample metadata. The name of the open metadata archive file (`content-packs/SimpleDataCatalog.json`) is sent in the request body. +The final command requests that an [Open Metadata Archive](/concepts/open-metadata-archive) is loaded to provide some sample metadata. The name of the open metadata archive file (`content-packs/SimpleCatalog.json`) is sent in the request body. ``` GET https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/myMetadataServer/open-metadata-archives/file @@ -627,7 +627,7 @@ When the configuration is next queried (this is request **2.** in Postman), the { "class": "Connection", "headerVersion": 0, - "displayName": "Open Metadata Archive File content-packs/SimpleDataCatalog.json Connection", + "displayName": "Open Metadata Archive File content-packs/SimpleCatalog.json Connection", "connectorType": { "class": "ConnectorType", "headerVersion": 0, @@ -653,7 +653,7 @@ When the configuration is next queried (this is request **2.** in Postman), the "endpoint": { "class": "Endpoint", "headerVersion": 0, - "address": "content-packs/SimpleDataCatalog.json" + "address": "content-packs/SimpleCatalog.json" } } ], @@ -813,17 +813,11 @@ When the configuration is next queried (this is request **2.** in Postman), the } ``` -You have probably noticed how quickly the configuration document grew into a complex structure. The commands you used made use of all of the configuration default values. There are other commands that enable you to customize the configuration document to +You have probably noticed how quickly the configuration document grew into a complex structure. The commands you used made use of all the configuration default values. There are other commands that enable you to customize the configuration document to adapt it to specific environment. However, the defaults provide a good starting point. !!! education "Further reading" - The contents of this tutorial cover a very simple OMAG server configuration. For guidance on configuring more complex OMAG servers see the [Administration Services User Guide](/guides/admin) - - - -## Next steps - -Next, this tutorial covers how to [stop the OMAG Server](/education/tutorials/omag-server-tutorial/task-stopping-omag-server). + The contents of this tutorial cover a very simple OMAG server configuration. For guidance on configuring more complex OMAG servers see the [Administration Services User Guide](/guides/admin). --8<-- "snippets/abbr.md" diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-deleting-omag-server.md b/site/snippets/tasks/task-deleting-omag-server.md similarity index 65% rename from site/docs/education/tutorials/omag-server-tutorial/task-deleting-omag-server.md rename to site/snippets/tasks/task-deleting-omag-server.md index 3b6d35dd06..ca98c6da3e 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-deleting-omag-server.md +++ b/site/snippets/tasks/task-deleting-omag-server.md @@ -1,7 +1,7 @@ -# Deleting an OMAG server's configuration +### Deleting an OMAG server's configuration An [OMAG Server](/concepts/omag-server)'s configuration document can be deleted from the configuration store using the following command. @@ -9,9 +9,5 @@ An [OMAG Server](/concepts/omag-server)'s configuration document can be deleted DELETE https://localhost:9443/open-metadata/admin-services/users/garygeeke/servers/cocoMDS1/instance ``` -## Next steps - -Now the OMAG Server is running you are ready to start -[calling the open metadata and governance services](task-calling-omag-apis.md). diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-starting-the-omag-server-platform.md b/site/snippets/tasks/task-starting-omag-server-platform-from-jar.md similarity index 72% rename from site/docs/education/tutorials/omag-server-tutorial/task-starting-the-omag-server-platform.md rename to site/snippets/tasks/task-starting-omag-server-platform-from-jar.md index 70fe44e7ea..68e6516c4a 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-starting-the-omag-server-platform.md +++ b/site/snippets/tasks/task-starting-omag-server-platform-from-jar.md @@ -1,9 +1,9 @@ - + -# Starting the OMAG Server Platform +### Starting the OMAG Server Platform -The [OMAG Server Platform's installation directory](/education/tutorials/building-egeria-tutorial/task-installing-egeria) contains a Java Archive (Jar) file for the [OMAG Server Platform](/concepts/omag-server-platform) itself along with a directory of libraries. +The OMAG Server Platform's `assembly/platform` directory contains a Java Archive (Jar) file for the [OMAG Server Platform](/concepts/omag-server-platform) itself along with a directory of libraries. The name of the Java Archive (Jar) file will depend on the release of Egeria that you have installed. In this example, the release is **4.2**. @@ -12,15 +12,15 @@ $ ls platform lib omag-server-platform-4.2.jar ``` -The OMAG Server Platform is started with the `java` command. +The OMAG Server Platform is started with the `java` command. ??? tip "Checking your Java installation" - Ensure you have a Java runtime at Version 17 or above installed on your machine. Check the version of Java you have with the command **java -version** and [install the appropriate version](/education/tutorials/building-egeria-tutorial/task-installing-java) if needed. You only need the JRE but select the JDK if you expect to also write some Java code.) + Ensure you have a Java runtime at Version 17 or above installed on your machine. Check the version of Java you have with the command **java -version** and [install the appropriate version](/education/tutorials/building-egeria-tutorial/task-installing-java) if needed. You only need the JRE but select the JDK if you expect to also write some Java code. Start the OMAG server platform with the following command: ```bash -java -Dloader.path=platform/lib -jar platform/omag-server-platform*.jar +java -Dloader.path=platform/lib,platform/extras -jar platform/omag-server-platform*.jar ``` This starts the platform listening on port `9443`. Add the `-Dserver.port` parameter before the `-jar` parameter if you wish the platform to listen on a different port. For example, the following command starts the platform listening on port `9444`. Multiple instances of the same OMAG Server Platform may run in a single machine (or in the same container). However, they each need to listen on a different port. @@ -52,32 +52,18 @@ Sun Jun 11 13:14:04 BST 2023 No OMAG servers listed in startup configuration Sun Jun 11 13:14:04 BST 2023 OMAG server platform ready for more configuration ``` -When you see the `OMAG server platform ready for more configuration` message, it means the OMAG Server Platform has completed its start up and it ready to use. +When you see the `OMAG server platform ready for more configuration` message, it means the OMAG Server Platform has completed its start-up, and it is ready to use. If you get an error that the port is in use, check for any applications using the same port and make sure they are each using unique ports. -Try the following command (replace 9443 accordingly if using a non standard port): +Try the following command (replace 9443 accordingly if using a non-standard port): ```bash curl --insecure -X GET https://localhost:9443/open-metadata/platform-services/users/test/server-platform/origin ``` +Returns ```text Egeria OMAG Server Platform (version 4.2) ``` This calls the OMAG server platform using a REST API call. The response `Egeria OMAG Server Platform (release X.x)` means the curl command communicated with a running OMAG Server Platform instance. - -The OMAG Server Platform has many REST APIs. Enter **https://localhost:9443/swagger-ui/index.html** into your browser to see the list of available REST APIs. - -Broadly speaking, the OMAG Server Platform supports: - -* Services to operate the platform. -* Open metadata and governance services to manage the open metadata ecosystem. - -The services operating the platform (primarily the [Administration Services](/services/admin-services/overview) and [Platform Services](/services/platform-services/overview)) are available all the time the OMAG Server Platform is running. The open metadata and governance services include a server name in the URL and they are routed to the named OMAG Server running on the OMAG Server Platform. - -OMAG Servers are started on the OMAG Server Platform through the Platform Services using a [configuration document](/concepts/configuration-document). This configuration document is configured in the OMAG Server Platform using the Administration Services. - -Understanding how to create a configuration document using the administration services [is the next task in this tutorial](/education/tutorials/omag-server-tutorial/task-creating-configuration-documents). - ---8<-- "snippets/abbr.md" \ No newline at end of file diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-starting-omag-server.md b/site/snippets/tasks/task-starting-omag-server.md similarity index 97% rename from site/docs/education/tutorials/omag-server-tutorial/task-starting-omag-server.md rename to site/snippets/tasks/task-starting-omag-server.md index cb58326ab0..2fc2e91503 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-starting-omag-server.md +++ b/site/snippets/tasks/task-starting-omag-server.md @@ -1,10 +1,9 @@ -# Activating OMAG servers in the OMAG server platform +### Activating OMAG servers in the OMAG Server Platform -Once you have [created a configuration document for an OMAG server](task-creating-configuration-documents.md) -it is started in the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is request **7.** in Postman). +Once you have created a configuration document for an OMAG server, it is started in the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is request **7.** in Postman). ``` POST https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platformservers/myMetadataServer/instance @@ -20,8 +19,7 @@ The response from the command lists the subsystems that have been activated in t } ``` -The window where your OMAG Server Platform is running will show the start-up -audit log messages, something like this: +The window where your OMAG Server Platform is running will show the start-up audit log messages, something like this: ```text Project Egeria - Open Metadata and Governance @@ -190,10 +188,7 @@ Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMRS-AUDIT-0015 The listen Sun Jun 11 21:19:16 BST 2023 myMetadataServer Startup OMAG-ADMIN-0004 The myMetadataServer server has successfully completed start up. The following services are running: [Open Metadata Repository Services (OMRS), Connected Asset Services, Open Metadata Store Services, Open Integration Service, Data Manager OMAS, Subject Area OMAS, Glossary View OMAS, Design Model OMAS, Security Officer OMAS, Asset Manager OMAS, IT Infrastructure OMAS, Data Science OMAS, Community Profile OMAS, Data Engine OMAS, Discovery Engine OMAS, Digital Architecture OMAS, Asset Owner OMAS, Stewardship Action OMAS, Governance Program OMAS, Digital Service OMAS, Asset Lineage OMAS, Asset Consumer OMAS, Asset Catalog OMAS, DevOps OMAS, Software Developer OMAS, Project Management OMAS, Governance Engine OMAS, Data Privacy OMAS, Security Manager OMAS] ``` -THe start-up messages show the [open metadata types](/types) being loaded, followed by the open metadata archive `content-packs/SimpleDataCatalog.json`. Then the local repository is initialized and finally the OMASs are started. +The start-up messages show the [open metadata types](/types) being loaded, followed by the open metadata archive `content-packs/SimpleCatalog.json`. Then the local repository is initialized and finally the OMASs are started. -## Next steps - -Now the OMAG Server is running you are ready to start [calling the open metadata and governance services](task-calling-omag-apis.md). diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server-platform.md b/site/snippets/tasks/task-stopping-omag-server-platform.md similarity index 93% rename from site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server-platform.md rename to site/snippets/tasks/task-stopping-omag-server-platform.md index c18f69e2c3..76c65d7af3 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server-platform.md +++ b/site/snippets/tasks/task-stopping-omag-server-platform.md @@ -1,7 +1,7 @@ -# Stopping the OMAG server platform +### Stopping the OMAG Server Platform Once you have [Stopped your OMAG server](/education/tutorials/omag-server-tutorial/task-stopping-omag-server) you can stop the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is request **10.** in Postman). diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server.md b/site/snippets/tasks/task-stopping-omag-server.md similarity index 90% rename from site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server.md rename to site/snippets/tasks/task-stopping-omag-server.md index 744cd0daf2..3fb8e67c8b 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-stopping-omag-server.md +++ b/site/snippets/tasks/task-stopping-omag-server.md @@ -1,12 +1,9 @@ -# Activating OMAG servers in the OMAG server platform +### Stopping OMAG servers in the OMAG Server Platform -Once you have finished [calling the open metadata and governance APIs](/education/tutorials/omag-server-tutorial/task-calling-omag-apis) -you can stop your server in the -[OMAG Server Platform](/concepts/omag-server-platform) -using the following command (this is command **8.** in Postman). +Once you have finished calling the open metadata and governance APIs you can stop your server in the [OMAG Server Platform](/concepts/omag-server-platform) using the following command (this is command **8.** in Postman). ``` POST https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers/myMetadataServer/instance @@ -51,7 +48,7 @@ Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMAG-ADMIN-0006 The myMet Sun Jun 11 21:52:43 BST 2023 myMetadataServer Shutdown OMRS-AUDIT-0016 The listener thread for the OMRS Topic Connector for topic myMetadataServer.openmetadata.repositoryservices.enterprise.myMetadataServer.OMRSTopic has shutdown ``` -Even though the server has stopped, the platform is still running and it is possible to query the platform about the server. The next command queries the status of the server (this is command **9.** in Postman). +Even though the server has stopped, the platform is still running, and it is possible to query the platform about the server. The next command queries the status of the server (this is command **9.** in Postman). ``` GET https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers/myMetadataServer/status @@ -76,14 +73,11 @@ You can see that it is not currently active and the times when it was active. } ``` -You can experiment by starting and stopping your server and trying this status command both while it is running and after it is stopped to see the different statuses. +You can experiment by starting and stopping your server and trying this status command both while it is running, and after it is stopped to see the different statuses. -!!! education "The platform operation services" +!!! tip "The platform operation services" Explore the [Platform Services](/services/platform-services/overview) to discover more commands to monitor and control the OMAG Server Platform. -## Next steps - -Now the OMAG Server has stopped, you can [shut down your OMAG Server Platform](/education/tutorials/omag-server-tutorial/task-stopping-omag-server-platform). --8<-- "snippets/abbr.md" diff --git a/site/snippets/tasks/task-understanding-rest-apis.md b/site/snippets/tasks/task-understanding-rest-apis.md new file mode 100644 index 0000000000..63c9b233ea --- /dev/null +++ b/site/snippets/tasks/task-understanding-rest-apis.md @@ -0,0 +1,22 @@ + + + +### What are the REST APIs supported by the Platform? + +The OMAG Server Platform has many REST APIs. Enter **https://localhost:9443/swagger-ui/index.html** into your browser to see the list of available REST APIs. + +Broadly speaking, the OMAG Server Platform supports: + +* Services to operate the platform itself. +* Services to manage and govern the open metadata ecosystem. + +The services operating the platform (primarily the [Administration Services](/services/admin-services/overview) and [Platform Services](/services/platform-services/overview)) are available all the time the OMAG Server Platform is running. The other services require at least one OMAG Server running on the OMAG Server Platform to activate them. + +OMAG Servers are started on the OMAG Server Platform through the Platform Services using a [configuration document](/concepts/configuration-document). This configuration document is configured in the OMAG Server Platform using the Administration Services. + +Understanding how to create a configuration document using the administration services is the next task in this tutorial. + + + + + diff --git a/site/docs/education/tutorials/omag-server-tutorial/task-working-with-postman.md b/site/snippets/tasks/task-working-with-postman.md similarity index 98% rename from site/docs/education/tutorials/omag-server-tutorial/task-working-with-postman.md rename to site/snippets/tasks/task-working-with-postman.md index 3ffd10a386..2477f400c7 100644 --- a/site/docs/education/tutorials/omag-server-tutorial/task-working-with-postman.md +++ b/site/snippets/tasks/task-working-with-postman.md @@ -1,7 +1,7 @@ -# Working with Postman +### Working with Postman Postman is a test tool that allows you to type in calls to [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer). diff --git a/site/snippets/tasks/terminal-installing-egeria.md b/site/snippets/tasks/terminal-installing-egeria.md index 736164990e..1e7eda48dc 100644 --- a/site/snippets/tasks/terminal-installing-egeria.md +++ b/site/snippets/tasks/terminal-installing-egeria.md @@ -17,7 +17,7 @@ The distribution tar file is `{release}-distribution.tar.gz` or `egeria-platform egeria-platform-4.3-distribution.tar.gz ``` -Create a directory for the install and copy the tar file into it. The two commands shown below create an install directory in your home directory and then copies the egeria distribution file into it. +Create a directory for Egeria and copy the tar file into it. The two commands shown below creates a directory in your home directory and then copies the egeria distribution file into it. ```bash mkdir ~/egeria-install