summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul-Christian Volkmer2023-08-15 01:09:22 +0200
committerPaul-Christian Volkmer2023-08-15 01:09:22 +0200
commit66dc96680da5e263550413493578ebe936dde149 (patch)
treef27c4afeedcbb2b772cedff1471cd2465243fa6b
parent64b8636145291a3cd28b4354af9ce20e052d672a (diff)
Update dev config and added related information into README.md
-rw-r--r--README.md22
-rw-r--r--dev-compose.yml3
-rw-r--r--src/main/resources/application-dev.yml7
3 files changed, 29 insertions, 3 deletions
diff --git a/README.md b/README.md
index 48dc27c..805514f 100644
--- a/README.md
+++ b/README.md
@@ -79,4 +79,24 @@ für HTTP nicht gibt.
## Docker-Images
-Diese Anwendung ist auch als Docker-Image verfügbar: https://github.com/CCC-MF/etl-processor/pkgs/container/etl-processor \ No newline at end of file
+Diese Anwendung ist auch als Docker-Image verfügbar: https://github.com/CCC-MF/etl-processor/pkgs/container/etl-processor
+
+## Entwicklungssetup
+
+Zum Starten einer lokalen Entwicklungs- und Testumgebung kann die beiliegende Datei `dev-compose.yml` verwendet werden.
+Diese kann zur Nutzung der Datenbanken **MariaDB** als auch **PostgreSQL** angepasst werden.
+
+Zur Nutzung von Apache Kafka muss dazu ein Eintrag im hosts-File vorgenommen werden und der Hostname `kafka` auf die lokale
+IP-Adresse verweisen. Ohne diese Einstellung ist eine Nutzung von Apache Kafka außerhalb der Docker-Umgebung nicht möglich.
+
+Beim Start der Anwendung mit dem Profil `dev` wird die in `dev-compose.yml` definierte Umgebung beim Start der
+Anwendung mit gestartet:
+
+```
+SPRING_PROFILES_ACTIVE=dev ./gradlew bootRun
+```
+
+Die Datei `application-dev.yml` enthält hierzu die Konfiguration für das Profil `dev`.
+
+Beim Ausführen der Integrationstests wird eine Testdatenbank in einem Docker-Container gestartet.
+Siehe hier auch die Klasse `AbstractTestcontainerTest` unter `src/integrationTest`. \ No newline at end of file
diff --git a/dev-compose.yml b/dev-compose.yml
index 5012bab..8f0780f 100644
--- a/dev-compose.yml
+++ b/dev-compose.yml
@@ -1,4 +1,7 @@
services:
+
+ # Note: Make sure, hostname "kafka" points to 127.0.0.1
+ # otherwise connection will not be available
kafka:
image: bitnami/kafka
hostname: kafka
diff --git a/src/main/resources/application-dev.yml b/src/main/resources/application-dev.yml
index 551f3f8..b1cc2fc 100644
--- a/src/main/resources/application-dev.yml
+++ b/src/main/resources/application-dev.yml
@@ -4,8 +4,11 @@ spring:
file: ./dev-compose.yml
app:
- rest:
- uri: http://localhost:9000/bwhc/etl/api
+ #rest:
+ # uri: http://localhost:9000/bwhc/etl/api
+
+ # Note: Make sure, hostname "kafka" points to 127.0.0.1
+ # otherwise connection will not be available
kafka:
topic: test
response-topic: test-response