From 2cac5dc2444ae44eae9d3a3e229e8d91fdeeb43f Mon Sep 17 00:00:00 2001 From: Jan Zickermann <jan.zickermann@dataport.de> Date: Fri, 21 Feb 2025 13:17:57 +0100 Subject: [PATCH] KOP-3022 Rework readme --- readme.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 5ad99099..50462885 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,5 @@ # XTA-Adapter -Der XTA-Adapter erzeugt neue OZG-Cloud-Vorgänge von XTA-Nachrichten. +Der XTA-Adapter empfängt Anträge von Online-Diensten via XTA-Nachrichtenbroker und erzeugt für diese Anträge neue Vorgänge im Vorgang-Manager. Der XTA-Adapter läuft als cronjob und beendet sich, nachdem alle unterstützten Anträge vom XTA-Nachrichtenbroker (XTA-Server) abgeholt wurden. Jeder Antrag erzeugt einen neuen Vorgang im Vorgang-Manager. (Der Mantelantrag ist eine Ausnahme und kann mehrere Vorgänge erzeugen.) @@ -42,6 +42,7 @@ Dafür muss ein Root-Zertifikat `xtaRootCa` (in Base64-Kodierung) konfiguriert w xta: rootCa: LS0tLS1CRUdJTiBDRVJUSUZ... ``` + Der XTA-Adapter benötigt ein Client-Zertifikat, dass ihn zum Lesen der konfigurierten Xta-kennungen berechtigt. Das Client-Zertifikat muss in einem P12-KeyStore (in Base64-Kodierung) abgelegt werden: ```yaml @@ -55,11 +56,12 @@ xta: Der xta-test-server erlaubt mit einem validen Client-Zertifikat beliebige Nachricht-Typen mit beliebigen Kennungen zu senden und zu empfangen. Das CA-Zertifikat und Client-Zertifikat sollte aus dem entsprechenden Secrets des xta-test-servers heruntergeladen werden. + Nähere Information hierzu sind in der internen-Dokumentation zu finden: -https://git.ozg-sh.de/ozgcloud-doc/dokumentation/src/branch/master/Entwicklungsumgebung/Beistellungen/xta-test-server-SoapUI/README.md -https://git.ozg-sh.de/ozgcloud-doc/dokumentation/src/branch/master/Entwicklungsumgebung#xta-adapter +- https://git.ozg-sh.de/ozgcloud-doc/dokumentation/src/branch/master/Entwicklungsumgebung/Beistellungen/xta-test-server-SoapUI/README.md +- https://git.ozg-sh.de/ozgcloud-doc/dokumentation/src/branch/master/Entwicklungsumgebung#xta-adapter -## Verwendung mit dem Dataport-DEV-nachrichtenbroker +## Verwendung mit dem Dataport-DEV-Nachrichtenbroker Der Dataport-DEV-nachrichtenbroker ist nur erreichbar aus dem Landes-Netz. Um das Root-CA-Zertifikat `Dataport Root CA` zu erhalten, welches als `rootCa` konfiguriert werden kann, kann die Zertifikat-Kette direkt vom Endpunkt angefragt werden: ```shell @@ -68,4 +70,4 @@ openssl s_client -showcerts -connect li33-0005.dp.dsecurecloud.de:443 </dev/null Das Zertifikat kann ggf. lokal unter `/etc/ssl/certs/dataport-root-ca.pem` installiert werden mit `sudo update-ca-certificates`. -Ein Client-Zertifikat `KOP_SH_KIEL_DEV.p12`, das den Xta-Adapter zum Lesen von Xta-Kennungen berechtigt, muss beantragt werden. +Das Client-Zertifikat `KOP_SH_KIEL_DEV.p12`, das den Xta-Adapter zum Lesen von Xta-Kennungen berechtigt, muss beantragt werden. -- GitLab