Skip to content

Commit

Permalink
Merge pull request #900 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history
Change diagrams used in admin guide
  • Loading branch information
mandy-chessell authored Feb 21, 2024
2 parents dec5b43 + ea6bc30 commit 18cadb6
Show file tree
Hide file tree
Showing 25 changed files with 1,154 additions and 700 deletions.
2 changes: 1 addition & 1 deletion site/docs/concepts/lineage-warehouse.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,087 changes: 779 additions & 308 deletions site/docs/guides/admin/egeria-admin.drawio

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the Egeria project. -->

# Configuration document properties managed by Egeria

The following properties do not need be configured explicitly, the admin services will manage them automatically.

![Egeria Managed Properties](egeria-managed-properties.svg)

## Local Server Id

The localServerId is a unique identifier for the server, it is used when accessing resource that require their callers to supply a unique identifier. For example, when an OMAG server is accessing an Apache Kafka topic, it needs to reliably identify itself with a callerId so that the Kafka server knows which events it has received and which it has not. The localServerId is used for this purpose when accessing the [open metadata repository cohort topics](/concepts/cohort-events) for example.

## Local Server Name

The localServerName is a unique name for the server. This is a name you choose, and the administration services maintains the name in the configuration document.

## Local Server Type

The local server type is a classification of the type of the server based on the sections of the configuration document that have been configured. Leave it blank and Egeria will fill it in on server start up. There is also an administration call to query the type of server using the following call:

--8<-- "snippets/admin/calls/get-server-type-classification.md"

## Audit Trail

The audit trail lists the admin commands that have been issued against the configuration document. It is useful in tracking down when changes occurred, particularly when diagnosing problems in the configuration.

--8<-- "snippets/abbr.md"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 1 addition & 16 deletions site/docs/guides/admin/servers/by-section/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The configuration document is divided into sections. Some sections contain prop

![Configuration Document Structure](configuration-document-structure.svg)

* The [*LocalServerId*](#local-server-id), [*LocalServerName*](#local-server-name), [*Local Server Type*](#local-server-type) and [*Audit Trail*](#audit-trail) properties are managed by Egeria and you do not need to configure them.
* The *LocalServerId*, *LocalServerName*, *Local Server Type* and *Audit Trail* properties are [managed by Egeria](egeria-managed-properties.md) and you do not need to configure them.
* The [*Event Bus Config*](event-bus-config-section.md) is used to provide standard information about the event bus (typically Apache Kafka) that is used in each section that configures a service that is sending notifications over the event bus.
* The [*Basic Server Properties*](basic-server-properties-section.md) provides the standard properties of a server such as its user identifier and password.
* The [*Server Security Connection*](server-security-connection-section.md) provides the information needed to enable fine-grained metadata authorization checks.
Expand All @@ -22,20 +22,5 @@ The configuration document is divided into sections. Some sections contain prop
* The [*Data Engine Proxy Services*](data-engine-proxy-services-section.md) define the properties of a [data engine proxy server](/concepts/data-engine-proxy) server.


## Local Server Id

The localServerId is a unique identifier for the server, it is used when accessing resource that require their callers to supply a unique identifier. For example, when an OMAG server is accessing an Apache Kafka topic, it needs to reliably identify itself with a callerId so that the Kafka server knows which events it has received and which it has not. The localServerId is used for this purpose when accessing the [open metadata repository cohort topics](/concepts/cohort-events) for example.

## Local Server Name

The localServerName is a unique name for the server. This is a name you choose, and the administration services maintains the name in the configuration document.

## Local Server Type

The local server type is a classification of the type of the server based on the sections of the configuration document that have been configured. Leave it blank and Egeria will fill it in on server start up. There is also an administration call to query the type of server using the following call:



## Audit Trail

--8<-- "snippets/abbr.md"
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@

This section is only relevant when configuring an [integration daemon](/concepts/integration-daemon).

--8<-- "snippets/admin/configuring-the-integration-groups.md"

--8<-- "snippets/admin/configuring-the-integration-services.md"
--8<-- "snippets/admin/configuring-the-integration-daemon-services.md"


--8<-- "snippets/abbr.md"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

A *Conformance Test Server* is configured by creating a [configuration document](/concepts/configuration-document). Below is the outline structure of this type of server's configuration document.

![Configuration for a conformance test server](conformance-test-server-config.svg)
![Configuration for a conformance test server](/concepts/conformance-test-server.svg)

??? info "Configuring the default values used in subsequent configuration commands"
--8<-- "snippets/admin/configuring-event-bus.md"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,16 @@
<!-- Copyright Contributors to the ODPi Egeria project. -->


# Configuring a Data Engine Proxy Server
# Configuring a Data Engine Proxy

## Overview
A [Data Engine Proxy](/concepts/data-engine-proxy) provides the ability to load lineage data from a data engine.

Each [type of OMAG Server](/concepts/omag-server/#types-of-omag-server) is configured by creating a [configuration document](/concepts/configuration-document). The following can be configured for data engine proxy:
The configuration for a Data Engine Proxy requires knowledge of the [Metadata Access Server](/concepts/metadata-access-server) that is to store the lineage via the [Data Engine OMAS](/services/omas/data-engine/overview).

![Configuration for an data engine proxy server](data-engine-proxy-config.svg)
![Configuration for an data engine proxy server](/concepts/data-engine-proxy.svg)


??? info "Configuring the basic properties"
--8<-- "snippets/admin/configuring-omag-server-basic-properties.md"

??? info "Configuring the audit log"
--8<-- "snippets/admin/configuring-the-audit-log.md"

??? info "Configuring the server security connector"
--8<-- "snippets/admin/configuring-the-server-security-connector.md"
--8<-- "snippets/admin/configuring-standard-sections.md"

??? info "Configuring the Data Engine Proxy Services"
--8<-- "snippets/admin/configuring-the-data-engine-services.md"
Expand Down
Loading

0 comments on commit 18cadb6

Please sign in to comment.