From a17b5af5daf4f058014dd8e3dbc034577043b3b8 Mon Sep 17 00:00:00 2001
From: Torsten Friebe <torsten.friebe@gmail.com>
Date: Tue, 12 Dec 2023 17:24:58 +0100
Subject: [PATCH] XPLANBOX- 2429/2531 updated user and operations manual about
secured REST API and required JPA provider
---
.../src/main/asciidoc/aktualisierung.adoc | 1 +
.../asciidoc/konfiguration/rest-api/main.adoc | 20 +++++++++++--------
.../src/main/asciidoc/s3storage.adoc | 6 +++---
3 files changed, 16 insertions(+), 11 deletions(-)
diff --git a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/aktualisierung.adoc b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/aktualisierung.adoc
index 9eff29033c..e133c5bd2a 100644
--- a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/aktualisierung.adoc
+++ b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/aktualisierung.adoc
@@ -236,6 +236,7 @@ Für die Aktualisierung auf die Version 7.0 sind folgende Schritte auszuführen:
* Aktualisierung der Workspaces und Konfigurationen (s. <<teilweise-aktualisierung>>)
** Es wird empfohlen zur Absicherung der REST-Schnittstellen der XPlanDienste von der Authentifizierung über einen Tomcat-Nutzer auf API-Key umzustellen. Details dazu finden sich im Abschnitt <<dienste-tomcat>>. Soll weiterhin die Absicherung über einen konfigurierten Tomcat-Nutzer erfolgen, muss in der Datei _<DEEGREE_WORKSPACE_ROOT>/config.apikey_ ein `*` eingetragen werden, um die Absicherung zu deaktivieren.
+** Im _xplan-manager-workspace_ muss eine neue Konfigurationsdatei für einen `JpaConnectionProvider` im Unterverzeichnis _jdbc/_ angelegt werden. Die Datei muss mit der bereits vorhandenen Konfigurationsdatei für den `DataSourceConnectionProvider` über die Ressourcen-ID verknüpft werden. Vorlagen befinden sich in dem bereitgestellten Workspace _xplan-manager-workspace_.
* Aktualisierung der Datenbank:
** Ausführen des Skripts _migrate.sql_ im Verzeichnis _sql/update/from_6.0.1_to_7.0_ im Modul _xplan-manager-workspace_
*** vor Ausführung des Skripts muss die Variable `${xplan.srid}` mit dem verwendeten CRS ausgetauscht werden. Die Datei _migrate_25832.sql_ beinhaltet bereits die Ersetzung durch den CRS Code `25832` und kann ohne Änderungen ausgeführt werden.
diff --git a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/konfiguration/rest-api/main.adoc b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/konfiguration/rest-api/main.adoc
index cf8db37644..ac332a0c08 100644
--- a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/konfiguration/rest-api/main.adoc
+++ b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/konfiguration/rest-api/main.adoc
@@ -1,6 +1,10 @@
[[konfiguration-rest-api]]
== Konfiguration der REST-Schnittstellen
+Die xPlanBox stellt die folgenden REST-Schnittstellen bereit: die XPlanValidatorAPI,XPlanManagerAPI und XPlanDokumentenAPI.
+
+TIP: Die REST-Schnittstellen von XPlanValidatorAPI und XPlanManagerAPI sind über Spring Security abgesichert. Um für einen Aufruf der REST-Schnittstellen die erfolgreiche Authentifizierung zu prüfen, muss das Spring-Profil `enableSecurity` für die Komponenten aktiviert werden.
+
[[konfiguration-manager-api]]
=== XPlanManagerAPI
@@ -18,9 +22,9 @@ Beispiel:
apiUrl=https://xplanbox.lat-lon.de
----
-==== Kontakt E-Mail Adresse
+==== Kontakt E-Mail-Adresse
-E-Mail Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
+E-Mail-Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
Beispiel:
----
@@ -87,9 +91,9 @@ Beispiel:
apiUrl=https://xplanbox.lat-lon.de
----
-==== Kontakt E-Mail Adresse
+==== Kontakt E-Mail-Adresse
-E-Mail Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
+E-Mail-Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
Beispiel:
----
@@ -105,7 +109,7 @@ Beispiel:
termsOfServiceUrl=https://opensource.org/tos/
----
-==== URL zur Dokumentation der xPLanBox
+==== URL zur Dokumentation der xPlanBox
URL zur Dokumentation, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
Beispiel:
@@ -130,9 +134,9 @@ apiUrl=https://xplanbox.lat-lon.de
----
Wird keine URL angegeben, dann wird eine relative URL ausgegeben
-==== Kontakt E-Mail Adresse
+==== Kontakt E-Mail-Adresse
-E-Mail Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
+E-Mail-Adresse des Kontakts, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
Beispiel:
----
@@ -148,7 +152,7 @@ Beispiel:
termsOfServiceUrl=https://opensource.org/tos/
----
-==== URL zur Dokumentation der xPLanBox
+==== URL zur Dokumentation der xPlanBox
URL zur Dokumentation, die im OpenAPI Dokument ausgegeben wird. Diese Konfiguration ist optional.
Beispiel:
diff --git a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/s3storage.adoc b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/s3storage.adoc
index 2d51b8ae21..3aa7ee12c8 100644
--- a/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/s3storage.adoc
+++ b/xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/s3storage.adoc
@@ -1,14 +1,14 @@
[[s3-storage]]
== S3-Objektspeicher
-Die Ablage von Rasterdaten und Begleitdokumente im Objektspeicher von AWS S3 wird ab der Version 7.0 der xPlanBox unterstützt.
+Die Ablage von Rasterdaten und Begleitdokumente in einemS3-Objektspeicher wird ab der Version 7.0 der xPlanBox unterstützt.
[[s3-storage-image]]
=== Rasterdaten
-Rasterdaten können im Objektspeicher von AWS S3 gespeichert und über den MapServer abgerufen werden.
+Rasterdaten können in einem S3-Objektspeicher gespeichert und über den MapServer abgerufen werden.
-Dazu müssen in der Konfiguration für <<konfiguration-xplanwms-mapserver,MapServer>> und <<konfiguration-manager-mapserver,XPlanManager>> die Verbindungsdaten für das AWS S3-API angegeben werden. Für den MapServer steht in dem Distributionspaket _xplan-mapserver-config-<VERSION>.zip_ eine Konfigurationsdatei _mapserver.map_ bereit. In dieser Datei müssen die Angaben für `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`, `AWS_S3_ENDPOINT` (siehe https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html[AWS CLI Umgebungsvariablen]) angepasst werden.
+Dazu müssen in der Konfiguration für <<konfiguration-xplanwms-mapserver,MapServer>> und <<konfiguration-manager-mapserver,XPlanManager>> die Verbindungsdaten für das S3-API angegeben werden. Für den MapServer steht in dem Distributionspaket _xplan-mapserver-config-<VERSION>.zip_ eine Konfigurationsdatei _mapserver.map_ bereit. In dieser Datei müssen die Angaben für `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`, `AWS_S3_ENDPOINT` (siehe https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html[AWS CLI Umgebungsvariablen]) angepasst werden.
TIP: Weitere Informationen zur Konfiguration des https://aws.amazon.com/de/s3/[S3] Objektspeichers im MapServer https://mapserver.org/mapfile/map.html[Mapfile] und https://gdal.org/user/virtual_file_systems.html[GDAL Virtual File Systems].
--
GitLab