Skip to content

Commit

Permalink
Merge pull request #835 from mandy-chessell/dev-dojo
Browse files Browse the repository at this point in the history 
Add August newsletter
  • Loading branch information
@mandy-chessell
mandy-chessell authored Aug 31, 2023
2 parents 360d6a0 + 4c06c88 commit 5d2e0c8
Show file tree
Hide file tree
Showing 17 changed files with 414 additions and 69 deletions.
1 change: 1 addition & 0 deletions site/docs/concepts/audit-log-intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@ The structure is defined by the Audit Log Framework (ALF). The Open Metadata Re
| 12 | `Cohort` | The server is exchanging registration information about an open metadata repository cohort that it is connecting to. |
| 13 | `Trace` | This is additional information on the operation of the server that may be of assistance in debugging a problem. It is not normally logged to any destination, but can be added when needed. |
| 14 | `PerfMon` | This log record contains performance monitoring timing information for specific types of processing. It is not normally logged to any destination, but can be added when needed. |
| 15 | `Activity` | This log record describes the activity of users. It is not normally logged to any destination, but can be added when needed. |
| 0 | `<Unknown>` | Uninitialized Severity |

2 changes: 1 addition & 1 deletion site/docs/connectors/integration/jdbc-integration-connector.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- Connector Category: [Integration Connector](/concepts/integration-connector)
- Hosting Service: [Database Integrator OMIS](/services/omis/database-integrator/overview)
- Hosting Server: [Integration Daemon](/concepts/integration-daemon)
- Source Module: [jdbc-integration-connector :material-github:](https://github.com/odpi/egeria-database-connectors/tree/main/jdbc-integration-connector){ target=gh }
- Source Module: [jdbc-integration-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/integration-connectors/jdbc-integration-connector){ target=gh }
- Jar File Name: `jdbc-integration-connector.jar`


Expand Down
30 changes: 30 additions & 0 deletions site/docs/connectors/resource/apache-atlas-rest-connector.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Apache Atlas REST Connector

???+ info "Connector summary"
- Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector)
- Source Module: [apache-atlas-rest-connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/system-connectors/apache-atlas-rest-connector){ target=gh }.
- Jar File Name: `apache-atlas-rest-connector.jar`
- Supported Asset Type: [SoftwareServer](/types/0/0040-Software-Servers)

Apache Atlas has a REST API that allows external callers to query and create both
types and instances. This connector provides a simple Java API to this REST API.
It is written without any dependencies on Apache Atlas (or its associated Hadoop components)
so it happily runs in the same version of Java as the rest of Egeria.

This connector is used by other connectors from Egeria, and may also be used
by components from outside Egeria.

The values from the connection used by this connector are:

* Connection.getUserId() and Connection.getClearPassword() for logging in to Apache Atlas.
* Connection.getDisplayName() for the connector name in messages.
* Connection.getEndpoint().getAddress() for the URL root (typically host and port name) of the Apache Atlas server.
* Connection.getConfigurationProperties.get("atlasServerName") for the name of the Apache Atlas server to use in messages.




--8<-- "snippets/abbr.md"
36 changes: 34 additions & 2 deletions site/docs/connectors/resource/jdbc-resource-connector.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@

???+ info "Connector summary"
- Connector Category: [Digital Resource Connector](/concepts/digital-resource-connector)
- Source Module: [jdbc resource connector :material-github:](https://github.com/odpi/egeria-database-connectors/tree/main/jdbc-resource-connector){ target=gh }.
- Source Module: [jdbc resource connector :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/adapters/open-connectors/data-store-connectors/jdbc-resource-connector){ target=gh }.
- Jar File Name: `jdbc-resource-connector.jar`
- Supported Asset Type: [RelationalDatabase](/types/2/0224-Databases)


The JDBC Resource Connector provides a DataSource, which in turn is used to get a connection to underlying database. It provides access to both the schema metadata and the business data content.
Expand All @@ -19,8 +20,39 @@ The JDBC Resource Connector provides a DataSource, which in turn is used to get

## Usage

The connector is initialized using the connection information attached to the [Database](/types/2/0224-Databases) asset in open metadata.
The connector is initialized using the connection information attached to the [RelationalDatabase](/types/2/0224-Databases) asset in the open metadata ecosystem.

![Figure 2](jdbc-resource-connector-use.svg)
> **Figure 2:** Connection information used to create an instance of the JDBC resource connector
The optional configuration properties supported by this connector are:

* `jdbcDriverManagerClassName` - requests the named class to be loaded and registered as a driver. This property only needs to be defined if the connector is experiencing exceptions related to a missing DriverManager class for the database URL.
* `jdbcConnectionTimeout` - sets the maximum time in seconds that this data source will wait while attempting to connect to a database. The default value is 0 which means use the system default timeout, if any; otherwise it means no timeout.
* `jdbcDatabaseName` - provides a name to use in messages about the database. If it is not set then the connection URL string is used.

Below is an example connection for a PostgreSQL database:

```json
{
"class": "Connection",
"connectorType": {
"class": "ConnectorType",
"connectorProviderClassName": "org.odpi.openmetadata.adapters.connectors.resource.jdbc.JDBCResourceConnectorProvider"
},
"endpoint": {
"class": "Endpoint",
"address": "jdbc:postgresql://localhost:5432/myDatabase"
},
"userId": "xxxxx",
"clearPassword": "xxxx",
"configurationProperties": {
"jdbcDriverManagerClassName": "org.postgresql.Driver",
"jdbcConnectionTimeout": "10",
"jdbcDatabaseName": "MyDatabase"
}
}
```

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

4 changes: 4 additions & 0 deletions .../education/tutorials/building-egeria-tutorial/omag-server-platform-assembly.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 63 additions & 1 deletion site/docs/education/tutorials/docker-tutorial/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,69 @@
# Docker tutorial

**Docker** is a [simple container runtime and standard](https://www.docker.com/why-docker).
Every day, the egeria build processing creates a docker image of egeria and pushes it to the docker catalog on the **Docker website**.

Every time the egeria Pull Request (PR) build runs, it creates a **latest** docker image of egeria based on the latest content of the `main` branch of [egeria.git](https://github.com/odpi/egeria) and pushes it to the docker catalog on the [Docker website](https://hub.docker.com/r/odpi/egeria). The site also contains docker images for each official release of egeria.

Alternatively, you can build a customized docker image of egeria, that includes or excludes the connectors and services that you need.

This page takes you through the different options for building and running egeria using docker containers.

## 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`.

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
This docker image provides a simple way to bring a runnable version of Egeria onto your machine. It also provides the basis for a [Kubernetes](/guides/operations/kubernetes) deployment of Egeria.
Expand Down
2 changes: 1 addition & 1 deletion site/docs/release-notes/4-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

??? functional "HMS listener"
The [Hive Metastore (HMS) listener](/connectors/repository/hms/overview/#using-with-the-hive-metastore-listener) runs in the HMS process,
and issues Egerie Events when HMS tables and added, dropped or altered. The git repository for the listener is [https://github.com/odpi/egeria-listener-hms](https://github.com/odpi/egeria-listener-hms).
and issues Egeria Events when HMS tables and added, dropped or altered. The git repository for the listener is [https://github.com/odpi/egeria-listener-hms](https://github.com/odpi/egeria-listener-hms).

??? functional "Other functional fixes and enhancements"

Expand Down
13 changes: 9 additions & 4 deletions site/docs/release-notes/4-2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
<!-- Copyright Contributors to the Egeria project. -->


## Release 4.2 (19 July 2023)
## Release 4.2 (July 2023)

??? functional "Open Metadata Types"
* The [*CollectionMembership*](/types/0/0021-Collections) relationship has new properties *stewardTypeName*, *stewardPropertyName*, *userDefinedStatus* and *notes* to improve ability to manage collection membership.
Release 4.2 has a focus on runtime optimization and the start of the work to optimize the process of getting Egeria up and running in a new environment. This theme is continued in release 4.3.

??? functional "OMAG Server Topic Configuration"
Except when the `no-topics` option is specified, the configuration document helper methods add a connection for both the [InTopic](/concepts/in-topic) and the [OutTopic](/concepts/out-topic) to each Open Metadata Access Service (OMAS) configuration irrespective of whether the particular OMAS supports these topics. This has no impact at runtime because the OMASs simply do not start topics they do not use. However, from a set up point of view, it is misleading - and can result in an organization thinking they need to set up (and may be pay for) topics that are not use.
Except when the `no-topics` option is specified, the configuration document helper methods add a connection for both the [InTopic](/concepts/in-topic) and the [OutTopic](/concepts/out-topic) to each Open Metadata Access Service (OMAS) configuration irrespective of whether the particular OMAS supports these topics. This has no impact at runtime because the OMASs simply do not start topics they do not use. However, from a set-up point of view, it is misleading - and can result in an organization thinking they need to set up (and may be pay for) topics that are not use.

This release adds knowledge of whether an OMAS supports the inTopic and/or OutTopic to the [AccessServiceDescroption](https://github.com/odpi/egeria/blob/main/open-metadata-implementation/admin-services/admin-services-api/src/main/java/org/odpi/openmetadata/adminservices/configuration/registration/AccessServiceDescription.java) class. This information is used by the configuration helper methods when setting up the access service configuration. For example, this is the list of topics for `cocoMDS1` at release 4.2:

Expand All @@ -33,5 +32,11 @@
* The name of the JAR file to start the platform is now `omag-server-platform.jar` in the `platform` directory of the distribution/install image. The previous `server-chassis-spring.jar` is still present in the `server` directory, to allow time for teams to migrate their operational scripts. However, this old jar file name is deprecated and will be removed in a future release.
* The REST API calls to start and stop OMAG Servers have been moved from the [Administration Services](/services/admin-services/overview) to the [Platform Services](/services/platform-services/overview). The original Java client and REST API calls are still available, but they have been deprecated and will be removed at a later date. This change is to separate the operational responsibilities from the configuration responsibilities. Prior to this change, the operational responsibilities where split between the Platform Services and the Administration Services.

??? functional "New My Profile Open Metadata View Services (OMVS)"
In this release we have added a new view service called [My Profile OMVS](/services/omvs/my-profile/overview) to aid organizations writing user interfaces (UIs). My Profile OMVS returns information about the supplied user's profile. It is intended to supply information about the logged-on user.

??? functional "Open Metadata Types"
* The [*CollectionMembership*](/types/0/0021-Collections) relationship has new properties *stewardTypeName*, *stewardPropertyName*, *userDefinedStatus* and *notes* to improve ability to manage collection membership.


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

0 comments on commit 5d2e0c8

Please sign in to comment.