Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional updates for V5.0 #948

Merged
merged 2 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
A new *Run* tab appears next to `EgeriaPlatform`. `EgeriaPlatformReport` runs but fails:

```bash
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dfile.encoding=UTF-8 -jar /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dfile.encoding=UTF-8 -jar /Users/mandy-chessell/egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
===============================
OMAG Server Platform Report: Mon Sep 04 18:00:51 BST 2023
===============================
Expand Down Expand Up @@ -44,7 +44,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
Re-run `EgeriaPlatformReport` by clicking on the green arrow on the *Run* tab. There is more output this time even though it still seems to fail in the end. It begins with the report header that records the platform it is running against.

```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/reports/egeria-platform-report.jar
/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-5.0-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
===============================
OMAG Server Platform Report: Mon Sep 04 19:38:03 BST 2023
===============================
Expand All @@ -58,7 +58,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf

```bash
Platform deployment
Egeria version: Egeria OMAG Server Platform (version 4.3)
Egeria version: Egeria OMAG Server Platform (version 5.0)
Configuration document store connector: <null>
Platform security connector: <null>
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Enter:
* `VM Options` is set to `-Dstrict.ssl=false -Dloader.path=server/lib -Dserver.port=9443`. This turns off SSL checking, points to the `lib` directory where you will be adding your new connector jar files and requests that the OMAG Server listens on port `9443`.
* `Working Directory` is set to the parent directory above the directory with the OMAG Server Platform jar. This directory includes the `truststore.p12` certificate file needed for the platform to start successfully.

The example below is from a machine where the directory used to install Egeria was `/Users/mandy-chessell/egeria-install`. Notice the directory name needs to be specified in full, - the `~` notation does not work here. In this example, the Egeria release used was `4.3`.
The example below is from a machine where the directory used to install Egeria was `/Users/mandy-chessell/egeria-install`. Notice the directory name needs to be specified in full, - the `~` notation does not work here. In this example, the Egeria release used was `5.0`.
![OMAG Server Platform Configuration](/education/egeria-dojo/developer/intellij-omag-server-platform-configuration.png)

Once you have entered these values, click `OK`. The `Add Configurations ...` box has been replaced by a drop-down menu that includes your new configuration called `EgeriaPlatform`.
Expand All @@ -32,7 +32,7 @@ If you click on the down arrow next to `EgeriaPlatform` you will see `Add Config
With `EgeriaPlatform` showing in the configurations box, click the green triangle and a *Run* tab opens showing the platform is starting up. The first line of the output is the call used to start the platform. You should be able to see the options that you added to the `EgeriaPlatform` configuration. After the command is the console output of the OMAG Server Platform. When you see the `OMAG server platform ready for more configuration` message, it is ready for work.

```bash
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -DString.ssl=false -Dloader.path=lib,extra -Dserver.port=9443 -Dfile.encoding=UTF-8 -jar /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/platform/omag-server-platform-4.3.jar
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -DString.ssl=false -Dloader.path=lib,extra -Dserver.port=9443 -Dfile.encoding=UTF-8 -jar /egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/platform/omag-server-platform-4.3.jar
Project Egeria - Open Metadata and Governance
____ __ ___ ___ ______ _____ ____ _ _ ___
/ __ \ / |/ // | / ____/ / ___/ ___ ____ _ __ ___ ____ / _ \ / / __ / / / _ /__ ____ _ _
Expand All @@ -42,10 +42,10 @@ With `EgeriaPlatform` showing in the configurations box, click the green triangl

:: Powered by Spring Boot (v3.1.1) ::

2023-09-04T15:46:39.390+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 76773 (/Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/platform/omag-server-platform-4.3.jar started by mandy-chessell in /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/platform)
2023-09-04T15:46:39.390+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 76773 (/egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/platform/omag-server-platform-5.0.jar started by mandy-chessell in /egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/platform)
2023-09-04T15:46:39.392+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : No active profile set, falling back to 1 default profile: "default"
2023-09-04T15:46:43.116+01:00 INFO 76773 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9443 (https)
2023-09-04T15:46:44.443+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/platform
2023-09-04T15:46:44.443+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: /egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/platform
2023-09-04T15:46:44.443+01:00 WARN 76773 --- [ 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-09-04T15:46:46.591+01:00 INFO 76773 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 9443 (https) with context path ''
2023-09-04T15:46:46.608+01:00 INFO 76773 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Started OMAGServerPlatform in 7.925 seconds (process running for 8.73)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<!-- Copyright Contributors to the Egeria project. -->

```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
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dstrict.ssl=false -Dfile.encoding=UTF-8 -jar /egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/etc/utilities/egeria-config-utility-5.0.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)
Running against platform: https://localhost:9443 - Egeria OMAG Server Platform (version 5.0)
Using userId: garygeeke

Enter a command along with the server name and any optional parameters. Press enter to execute request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Platform report for: https://localhost:9443

## Platform deployment
* **Egeria version**: Egeria OMAG Server Platform (version 4.3)
* **Egeria version**: Egeria OMAG Server Platform (version 5.0)
* **Configuration document store connector**: *null*
* **Platform security connector**: *null*
## Registered services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Platform report for: https://localhost:9443

## Platform deployment
* **Egeria version**: Egeria OMAG Server Platform (version 4.3)
* **Egeria version**: Egeria OMAG Server Platform (version 5.0)
* **Configuration document store connector**: *null*
* **Platform security connector**: *null*
## Registered services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Platform report for: https://localhost:9443

## Platform deployment
* **Egeria version**: Egeria OMAG Server Platform (version 4.3)
* **Egeria version**: Egeria OMAG Server Platform (version 5.0)
* **Configuration document store connector**: *null*
* **Platform security connector**: *null*
## Registered services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Egeria's assembly includes a utility for configuring servers. It is called `Ser
=== "V4.3 and before"
![server config settings](server-config-settings-4-3.png)

=== "V4.4" and beyond
=== "V5.0" and beyond
![server config settings](server-config-settings-4-4.png)

When you click `OK`, then `ServerConfig` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the panel of the IntelliJ window where the platform is running.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Egeria's assembly includes a utility called `ServerOps` that makes it easy to st
=== "V4.3 and before"
![server ops settings](server-ops-settings-4-3.png)

=== "V4.4" and beyond
=== "V5.0" and beyond
![server ops settings](server-ops-settings-4-4.png)

When you click `OK`, then `ServerOps` appears in the dropdown run menu. Press the green triangle to run the utility and a new tab appears in the panel of the IntelliJ window where the platform is running.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Select `JAR Application`:

![select jar application](select-jar-application.png)

Fill in the properties based on the directory where you installed egeria. In this example, egeria was installed in directory `/Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/` and so the settings are:
Fill in the properties based on the directory where you installed egeria. In this example, egeria was installed in directory `/egeria-install/egeria-platform-5.0-distribution.tar.gz/` and so the settings are:

* Path to JAR: `{install directory}/assembly/platform/omag-server-platform-4.3.jar`
* Path to JAR: `{install directory}/assembly/platform/omag-server-platform-5.0.jar`
* VM Options: `-Dloader.path=lib,extra`
* Working Directory: `{install directory}/assembly/platform`

Expand All @@ -45,12 +45,12 @@ Select `Edit Configurations` to create another `JAR Application`. This time cal

![location of platform report jar](location-of-platform-report.png)

Leave the `Working Directory` to default to your project directory. If you are using Version 4.3 of Egeria, set the VM Options to `-Dstrict.ssl=false`; for release V4.4 and beyond, you can leave them blank.
Leave the `Working Directory` to default to your project directory. If you are using Version 4.3 of Egeria, set the VM Options to `-Dstrict.ssl=false`; for release V5.0 and beyond, you can leave them blank.

=== "V4.3 and before"
![platform report settings](platform-report-settings-4-3.png)

=== "V4.4 and beyond"
=== "V5.0 and beyond"
![platform report settings](platform-report-settings-4-4.png)

When you click `OK`, then `PlatformReport` appears in the dropdown run menu. Press the green triangle to run the report and a new tab appears in the panel of the IntelliJ window where the platform is running.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
A new *Run* tab appears next to `EgeriaPlatform`. `EgeriaPlatformReport` runs but fails:

```bash
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dfile.encoding=UTF-8 -jar /Users/mandy-chessell/egeria-install/egeria-platform-4.3-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/bin/java -Dfile.encoding=UTF-8 -jar /egeria-install/egeria-platform-5.0-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
===============================
OMAG Server Platform Report: Mon Sep 04 18:00:51 BST 2023
===============================
Expand Down Expand Up @@ -44,7 +44,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf
Re-run `EgeriaPlatformReport` by clicking on the green arrow on the *Run* tab. There is more output this time even though it still seems to fail in the end. It begins with the report header that records the platform it is running against.

```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/reports/egeria-platform-report.jar
/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-5.0-distribution.tar.gz/assembly/etc/reports/egeria-platform-report.jar
===============================
OMAG Server Platform Report: Mon Sep 04 19:38:03 BST 2023
===============================
Expand All @@ -58,7 +58,7 @@ In the `omag-server-platform` assembly, there is a jar file called `egeria-platf

```bash
Platform deployment
Egeria version: Egeria OMAG Server Platform (version 4.3)
Egeria version: Egeria OMAG Server Platform (version 5.0)
Configuration document store connector: <null>
Platform security connector: <null>
```
Expand Down
4 changes: 2 additions & 2 deletions site/docs/guides/operations/operate-omag-server-starter.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ java -jar omag-server-*.jar --omag.server-config-file=classpath:samples/metadata

:: Powered by Spring Boot (v3.1.1) ::

2023-09-19T15:10:45.763+02:00 INFO 94379 --- [ main] o.o.o.s.springboot.OMAGServer : Starting OMAGServer using Java 17.0.8.1 with PID 94379 (/server/omag-server-4.3.jar started by ***** in /server)
2023-09-19T15:10:45.763+02:00 INFO 94379 --- [ main] o.o.o.s.springboot.OMAGServer : Starting OMAGServer using Java 17.0.8.1 with PID 94379 (omag-server-platform-5.0.jar started by ***** in /server)
2023-09-19T15:10:45.765+02:00 INFO 94379 --- [ main] o.o.o.s.springboot.OMAGServer : No active profile set, falling back to 1 default profile: "default"
2023-09-19T15:10:47.488+02:00 INFO 94379 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9080 (http)
2023-09-19T15:10:47.497+02:00 INFO 94379 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
Expand Down Expand Up @@ -147,7 +147,7 @@ All other settings can be configured by setting the environment variables that c
To run OMAG Server as a metadata repository using the sample configuration, run the following command:

```bash
docker run --name omag-server -p 9443:9443 --env JAVA_APP_JAR="/deployments/server/omag-server-4.3.jar" --env LOADER_PATH="/deployments/server/lib" --env OMAG_SERVERCONFIGFILE="classpath:samples/metadata-repository-server.json" quay.io/odpi/egeria:4.3
docker run --name omag-server -p 9443:9443 --env JAVA_APP_JAR="/deployments/server/omag-server-5.0.jar" --env LOADER_PATH="/deployments/server/lib" --env OMAG_SERVERCONFIGFILE="classpath:samples/metadata-repository-server.json" quay.io/odpi/egeria:5.0
```

### Run in Kubernetes
Expand Down
2 changes: 1 addition & 1 deletion site/docs/release-notes/latest.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
--8<-- "snippets/release-notes/5.0.md"
--8<-- "snippets/release-notes/5-0.md"
6 changes: 3 additions & 3 deletions site/docs/release-notes/previous.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
???+ info "Release 4.3 (September 2023)"
--8<-- "snippets/release-notes/4-3.md"

???+ info "Release 4.2 (July 2023)"
??? info "Release 4.2 (July 2023)"
--8<-- "snippets/release-notes/4-2.md"

???+ info "Release 4.1 (May 2023)"
??? info "Release 4.1 (May 2023)"
--8<-- "snippets/release-notes/4-1.md"

???+ info "Release 4.0 (March 2023)"
??? info "Release 4.0 (March 2023)"
--8<-- "snippets/release-notes/4-0.md"

??? info "v3.x Releases"
Expand Down
1 change: 0 additions & 1 deletion site/snippets/concepts/governance-service-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ There are ten types of governance services. Related governance services are [pa
| [Repository Governance Service](/guides/developer/repository-governance-services/overview) | Performs governance for open metadata repositories such as dynamically maintaining [open metadata archives](/concepts/open-metadata-archive). | [Repository Governance Engine](/concepts/repository-governance-engine) | [Repository Governance OMES](/services/omes/repository-governance/overview) |


--8<-- "snippets/abbr.md"
2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Release 1.0 provides the open metadata integration and exchange between metadata

Link to Egeria's [Roadmap](/release-notes/roadmap) for more details about the Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Below are the highlights:

Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Below are the highlights:
Link to Egeria's [Roadmap](/release-notes/roadmap) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Below are the highlights of the 1.3 release:
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Release 1.4 focused on bug fixes and documentation.
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Additional, in Tech Preview, Data Engine OMAS, and a data engine proxy server.
Link to Egeria's [Roadmap](../roadmap) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Below are the highlights:

Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Below are the highlights:
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/1-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Below are the highlights of Release 1.8:
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/2-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Below are the highlights:
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/2-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ The highlights include:
Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.

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

2 changes: 1 addition & 1 deletion site/snippets/release-notes/2-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,4 @@ Link to Egeria's [Roadmap](/release-notes/roadmap/) for more details about the
Open Metadata and Governance vision, strategy and content.


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

1 change: 0 additions & 1 deletion site/snippets/release-notes/2-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,3 @@
??? status "Implementation status"
![Egeria implementation status](/release-notes/functional-organization-showing-implementation-status-for-2-11.svg)](/release-notes/roadmap/)

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