-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #900 from mandy-chessell/code2024
Change diagrams used in admin guide
- Loading branch information
Showing
25 changed files
with
1,154 additions
and
700 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
2 changes: 1 addition & 1 deletion
2
site/docs/guides/admin/servers/by-section/configuration-document-structure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions
28
site/docs/guides/admin/servers/by-section/egeria-managed-properties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
4 changes: 4 additions & 0 deletions
4
site/docs/guides/admin/servers/by-section/egeria-managed-properties.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
...dmin/servers/by-server-type/configuration-document-structure-by-server-type.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.