From 3d2c73ff8f28138f4d377958b779d2b8220659e5 Mon Sep 17 00:00:00 2001 From: Jakub Lidke Date: Thu, 24 Aug 2023 13:01:29 +0200 Subject: doc: gPas Version requirement added --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index db6ae44..f56a34b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Diese Anwendung versendet ein bwHC-MTB-File an das bwHC-Backend und pseudonymisi ## Pseudonymisierung der Patienten-ID -Wenn eine URI zu einer gPAS-Instanz angegeben ist, wird diese verwendet. +Wenn eine URI zu einer gPAS-Instanz (Version >= 2023.1.0) angegeben ist, wird diese verwendet. Ist diese nicht gesetzt. wird intern eine Anonymisierung der Patienten-ID vorgenommen. * `APP_PSEUDONYMIZE_PREFIX`: Standortbezogenes Prefix - `UNKNOWN`, wenn nicht gesetzt @@ -43,4 +43,18 @@ Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an ein * `APP_KAFKA_TOPIC`: Zu verwendendes Topic * `APP_KAFKA_SERVERS`: Zu verwendende Kafka-Bootstrap-Server als kommagetrennte Liste -Weitere Einstellungen können über die Parameter von Spring Kafka konfiguriert werden. \ No newline at end of file +Weitere Einstellungen können über die Parameter von Spring Kafka konfiguriert werden. + + +### Docker Image +Bauen eines Docker Images kann wie folgt erzeugt werden: + +```bash +docker build . -t "imageName" +``` + +*Ausführen als Docker Conatiner:* + +```bash +docker compose -f deploy/docker-compose.yaml up -d +``` \ No newline at end of file -- cgit v1.2.3 From bbea48322fa5a24ff61eef25ed84f4966bf49c42 Mon Sep 17 00:00:00 2001 From: Jakub Lidke Date: Fri, 25 Aug 2023 12:50:29 +0200 Subject: chore: added deployment port mapping for monitoring access --- README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f56a34b..ce086d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # ETL-Processor for bwHC data -Diese Anwendung versendet ein bwHC-MTB-File an das bwHC-Backend und pseudonymisiert die Patienten-ID. +Diese Anwendung versendet ein bwHC-MTB-File an das bwHC-Backend und pseudonymisiert die +Patienten-ID. ## Pseudonymisierung der Patienten-ID @@ -12,41 +13,49 @@ Ist diese nicht gesetzt. wird intern eine Anonymisierung der Patienten-ID vorgen ### Eingebaute Pseudonymisierung -Wurde keine oder die Verwendung der eingebauten Pseudonymisierung konfiguriert, so wird für die Patienten-ID der -entsprechende SHA-256-Hash gebildet und Base64-codiert - hier ohne endende "=" - zuzüglich des konfigurierten Prefixes +Wurde keine oder die Verwendung der eingebauten Pseudonymisierung konfiguriert, so wird für die +Patienten-ID der +entsprechende SHA-256-Hash gebildet und Base64-codiert - hier ohne endende "=" - zuzüglich des +konfigurierten Prefixes als Patienten-Pseudonym verwendet. ### Pseudonymisierung mit gPAS Wurde die Verwendung von gPAS konfiguriert, so sind weitere Angaben zu konfigurieren. -* `APP_PSEUDONYMIZE_GPAS_URI`: URI der gPAS-Instanz inklusive Endpoint (z.B. `http://localhost:8080/ttp-fhir/fhir/gpas/$pseudonymizeAllowCreate`) +* `APP_PSEUDONYMIZE_GPAS_URI`: URI der gPAS-Instanz inklusive Endpoint ( + z.B. `http://localhost:8080/ttp-fhir/fhir/gpas/$pseudonymizeAllowCreate`) * `APP_PSEUDONYMIZE_GPAS_TARGET`: gPas Domänenname * `APP_PSEUDONYMIZE_GPAS_USERNAME`: gPas Basic-Auth Benutzername * `APP_PSEUDONYMIZE_GPAS_PASSWORD`: gPas Basic-Auth Passwort -* `APP_PSEUDONYMIZE_GPAS_SSLCALOCATION`: Root Zertifikat für gPas, falls es dediziert hinzugefügt werden muss. +* `APP_PSEUDONYMIZE_GPAS_SSLCALOCATION`: Root Zertifikat für gPas, falls es dediziert hinzugefügt + werden muss. ## Mögliche Endpunkte -Für REST-Requests als auch (parallel) zur Nutzung von Kafka-Topics können Endpunkte konfiguriert werden. +Für REST-Requests als auch (parallel) zur Nutzung von Kafka-Topics können Endpunkte konfiguriert +werden. ### REST -Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an das bwHC-Backend gesendet wird: +Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an das bwHC-Backend +gesendet wird: -* `APP_REST_URI`: URI der zu benutzenden API der bwHC-Backend-Instanz. z.B.: `http://localhost:9000/bwhc/etl/api` +* `APP_REST_URI`: URI der zu benutzenden API der bwHC-Backend-Instanz. + z.B.: `http://localhost:9000/bwhc/etl/api` ### Kafka-Topics -Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an ein Kafka-Topic übermittelt wird: +Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an ein Kafka-Topic +übermittelt wird: * `APP_KAFKA_TOPIC`: Zu verwendendes Topic * `APP_KAFKA_SERVERS`: Zu verwendende Kafka-Bootstrap-Server als kommagetrennte Liste Weitere Einstellungen können über die Parameter von Spring Kafka konfiguriert werden. - ### Docker Image + Bauen eines Docker Images kann wie folgt erzeugt werden: ```bash @@ -54,7 +63,10 @@ docker build . -t "imageName" ``` *Ausführen als Docker Conatiner:* +Wenn gewünscht, Änderungen in der `env` vornehmen. Beachten, dass *MONITORING_HTTP_PORT* über +Host-Umgebung gesetzt werden muss (z.B. .env oder Parameter --env-file ) ```bash -docker compose -f deploy/docker-compose.yaml up -d +cd ./deploy +docker compose up -d ``` \ No newline at end of file -- cgit v1.2.3 From 25143745c4691646112266006d68161bcb359bdd Mon Sep 17 00:00:00 2001 From: Jakub Lidke Date: Mon, 28 Aug 2023 12:54:14 +0200 Subject: chore: added deployment docker-compose.yaml and env-sample.env added. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b743d92..8290dd1 100644 --- a/README.md +++ b/README.md @@ -129,11 +129,14 @@ docker build . -t "imageName" ## Deployment *Ausführen als Docker Conatiner:* -Wenn gewünscht, Änderungen in der `env` vornehmen. Beachten, dass *MONITORING_HTTP_PORT* über -Host-Umgebung gesetzt werden muss (z.B. .env oder Parameter --env-file ) ```bash cd ./deploy +cp env-sample.env .env +``` +Wenn gewünscht, Änderungen in der `.env` vornehmen. + +```bash docker compose up -d ``` -- cgit v1.2.3 From e24be0d32592623ae2fc0e3d7f3618437036d72a Mon Sep 17 00:00:00 2001 From: Jakub Lidke Date: Wed, 30 Aug 2023 11:50:24 +0200 Subject: chore: cleanup deployment docker-compose.yaml and env-sample.env. added 'DNPM' prefix for better integration into productive environment. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8290dd1..908b1de 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ als Patienten-Pseudonym verwendet. Wurde die Verwendung von gPAS konfiguriert, so sind weitere Angaben zu konfigurieren. * `APP_PSEUDONYMIZE_GPAS_URI`: URI der gPAS-Instanz inklusive Endpoint ( - z.B. `http://localhost:8080/ttp-fhir/fhir/gpas/$pseudonymizeAllowCreate`) + z.B. `http://localhost:8080/ttp-fhir/fhir/gpas/$$pseudonymizeAllowCreate`) * `APP_PSEUDONYMIZE_GPAS_TARGET`: gPas Domänenname * `APP_PSEUDONYMIZE_GPAS_USERNAME`: gPas Basic-Auth Benutzername * `APP_PSEUDONYMIZE_GPAS_PASSWORD`: gPas Basic-Auth Passwort @@ -124,7 +124,7 @@ Diese Anwendung ist auch als Docker-Image verfügbar: https://github.com/CCC-MF/ ### Images lokal bauen ```bash -docker build . -t "imageName" +./gradlew bootBuildImage ``` ## Deployment -- cgit v1.2.3