PR template adjusted

Author: martind260

.github/pull_request_template.md

@@ -1,25 +1,17 @@
----
-name: Pull request template
-about: Create a pull request to contribute to our software
-title: ""
-labels: ""
-assignees: ""
----
+# Description
 
-## Pull Request 
+<!-- Add a short description of what the request is all about here -->
 
-### Description
+# Issue References
 
-### Reference
+<!-- Add the corresponding issues here -->
+ 
+# Definition of Done
 
-Issues: 
+<!-- Check all completed DoD requirements here -->
 
-### Definition of Done
 - [ ] Acceptance criteria are met
+- [ ] Testing is done (unit-tests, DEV-environment)
 - [ ] Build/Test workflow has successfully finished
 - [ ] Release notes are complemented
-- [ ] Documentation is complemented (operator manual, system specification)
-- [ ] Frontend is locally smoke-tested
-- [ ] Side branches are deleted
-- [ ] Board is updated
-- [ ] Infrastructure is adjusted
+- [ ] Documentation is complemented (operator manual, system specification, etc.)

src/main/resources/application-docker.yml

@@ -1,35 +1,48 @@
 server:
-  port: 39146
+  port: 50001
 
-spring:
+logging:
+  level:
+    root: WARN
+    de.muenchen.dave: INFO
 
+db.schema: dave_ng
+spring:
+  flyway:
+    enabled: true
+    schemas: ${db.schema}
+    defaultSchema: ${db.schema}
   datasource:
-    url: jdbc:h2:mem:testdb
-    username: sa
-    password:
-  # Spring JPA
-  h2.console.enabled: true
+    url: jdbc:postgresql://postgres:5432/dave-db
+    username: dave
+    password: 1234
+    driver-class-name: org.postgresql.Driver
+    hikari:
+      maximum-pool-size: 20          # Increase the maximum pool size (default: 10)
+      connection-timeout: 600000     # Connection timeout in milliseconds (default: 30000)
   jpa:
-    database: H2
+    database: postgresql
     hibernate:
       # always drop and create the db should be the best
       # configuration for local (development) mode. this
       # is also the default, that spring offers by convention.
       # but here explicite:
       ddl-auto: create-drop
       naming.physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
+
     # Logging for database operation
     show-sql: false
     properties:
       hibernate:
+        default_schema: ${db.schema}
         format_sql: true
 
   security:
     # possible values: none, all, changing (With changing, only changing requests such as POST, PUT, DELETE are logged)
     logging.requests: all
     oauth2:
       resource:
-        user-info-uri: ${SSO_BASE_URL}/realms/${realm}/protocol/openid-connect/userinfo
+        user-info-uri: ${SSO_BASE_URL}/auth/realms/${realm}/protocol/openid-connect/userinfo
       resourceserver:
         jwt:
           issuer-uri: ${SSO_BASE_URL}/auth/realms/${realm}
@@ -45,41 +58,45 @@ spring:
             authorization-grant-type: client_credentials
             client-authentication-method: client_secret_post
 
-# Define the local keycloak realm here
+# Management
+management.health.elasticsearch.enabled: false
+
+# Define the keycloak realm here
 realm: Dave
 
+elasticsearch.index.suffix: -ng
 elasticsearch:
   user: elastic
-  password:
-  host: localhost
+  host: elastic
   port: 9200
   connectTimeout: 10
   socketTimeout: 30
 
 dave:
   zaehlung:
-    status-updater:
+    status:
       #      Alle 5 min
-      cron: 0 0/5 * 1/1 * ?
-      # Sollte immer knapp unter dem Cron sein
-      shedlock: 4m
+      updater: 0 0 * 1/1 * ?
   email:
-    address: dave-dummy@muenchen.de
+    address: dave-dummy@mail.de
     password: dummy
     url:
       adminportal: http://localhost:8085
       selfserviceportal: http://localhost:8086
     receiver:
-      #      Alle 1 min
-      cron: 0 0/1 * 1/1 * ?
-      # Sollte immer knapp unter dem Cron sein
-      shedlock: 55s
-
+      # Update-Intervall in Millisekunden für den Email-Abruf
+      update-interval: 50000000000
+      hostname: imap.de
   messstelle:
-    cron: 0 0/17 * 1/1 * ?
+    # Alle 5 min
+    cron: 0 0 * 1/1 * ?
+    # Sollte immer knapp unter dem Cron sein
     shedlock: 4m
+  reports:
+    logo-icon: classpath:/pdf/images/kindl.jpg
+    logo-subtitle: "Landeshauptstadt<br/>München<br/><b>Mobilitätsreferat</b>"
+
+geodaten.eai.url: http://localhost:8088
 
-geodaten:
-  eai:
-    url: http://localhost:8088
+document-storage.url: http://localhost:8089
 

src/main/resources/application-sample.yml

@@ -1,2 +1 @@
-spring.jpa.defer-datasource-initialization: true
 spring.sql.init.data-locations: classpath:/data/sample-data.sql

stack/.env

@@ -5,4 +5,7 @@ ELASTIC_PASSWORD=changeme
 KIBANA_PASSWORD=changeme
 
 # Version of Elastic products
-STACK_VERSION=8.13.4
+STACK_VERSION=8.13.4
+
+# Elasticseach CA certificate fingerprint
+ELASTICSEARCH_CERT_FINGERPRINT=

stack/docker-compose.yml

@@ -2,7 +2,8 @@ name: dave-stack
 
 services:
   setup:
-    image: elasticsearch:${STACK_VERSION}
+    container_name: setup
+    image: docker.io/library/elasticsearch:${STACK_VERSION}
     volumes:
       - elastic-certs:/usr/share/elasticsearch/config/certs
     user: "0"
@@ -51,10 +52,11 @@ services:
       retries: 120
 
   elastic:
+    container_name: elastic
     depends_on:
       setup:
         condition: service_healthy
-    image: elasticsearch:${STACK_VERSION}
+    image: docker.io/library/elasticsearch:${STACK_VERSION}
     volumes:
       - elastic-certs:/usr/share/elasticsearch/config/certs
       - elastic-data:/usr/share/elasticsearch/data
@@ -94,10 +96,11 @@ services:
       retries: 120
 
   kibana:
+    container_name: kibana
     depends_on:
       elastic:
         condition: service_healthy
-    image: kibana:${STACK_VERSION}
+    image: docker.io/library/kibana:${STACK_VERSION}
     volumes:
       - elastic-certs:/usr/share/kibana/config/certs
       - kibana-data:/usr/share/kibana/data
@@ -121,6 +124,7 @@ services:
       retries: 120
 
   postgres:
+    container_name: postgres
     image: postgres:16.6-alpine3.21
     environment:
       - POSTGRES_DB=dave-db
@@ -141,6 +145,7 @@ services:
 
   # see https://event-driven.io/en/automatically_connect_pgadmin_to_database/
   pg-admin:
+    container_name: pg-admin
     image: dpage/pgadmin4:8.14
     environment:
       - [email protected]
@@ -162,6 +167,39 @@ services:
     user: root # see https://github.com/pgadmin-org/pgadmin4/issues/6257
     entrypoint: /bin/sh -c "chmod 600 /pgadmin4/pgpass; /entrypoint.sh;" # see https://www.postgresql.org/docs/current/libpq-pgpass.html#LIBPQ-PGPASS (last paragraph)
 
+  dave-backend:
+    container_name: dave-backend
+    profiles: [sample-stack]
+    image: ghcr.io/it-at-m/dave-backend/dave-backend:latest
+    environment:
+      - ELASTICSEARCH_PASSWORD=${ELASTIC_PASSWORD}
+      - ELASTICSEARCH_HTTPCACERTIFICATE=${ELASTICSEARCH_CERT_FINGERPRINT}
+      - SPRING_PROFILES_ACTIVE=docker,no-security,debugging,sample
+      - SSO_BASE_URL=http://sso.de
+    ports:
+      - "50001:50001"
+    pull_policy: always
+    restart: on-failure
+    healthcheck:
+      test: [ "CMD-SHELL", "curl http://dave-backend:50001/actuator/health | grep -q '\"status\":\"UP\"'", ]
+      interval: 1s
+      timeout: 5s
+      retries: 120
+
+  dave-frontend:
+    container_name: dave-frontend
+    profiles: [sample-stack]
+    depends_on:
+      dave-backend:
+        condition: service_healthy
+    image: ghcr.io/it-at-m/dave-frontend/dave-frontend:latest
+    environment:
+      - SPRING_PROFILES_ACTIVE=docker,no-security
+      - SSO_BASE_URL=http://sso.de
+    ports:
+      - "8082:8082"
+    pull_policy: always
+
 volumes:
   pg_data:
   elastic-certs:

stack/readme.md

@@ -66,4 +66,48 @@ Bevor das Backend gestartet werde kann muss die application-local agepasst werde
 * * password:1234
 * elasticsearch:
 * * password:changeme
-* * http-ca-certificate: <generate>
+* * http-ca-certificate: <generate>
+
+# DAVe sample stack
+
+DAVe __sollte__ in Produktionsumgebungen via [helm chart](https://artifacthub.io/packages/helm/it-at-m/dave?modal=install) installiert und betrieben werden.
+
+Aber für einen ersten Einblick in das, was DAVe zu bieten hat oder für Entwicklungsumgebungen stellen wir eine 
+[docker-compose](https://github.com/it-at-m/dave-backend/blob/sprint/stack/docker-compose.yml)-Datei zur Verfügung, 
+die neben der benötigten Infrastruktur auch Frontend und Backend mit einem Beispieldatensatz einer Zählstelle startet.
+
+Folgende Schritte sind hierfür nötig:
+
+1. Docker und Docker Compose installieren: Sie müssen Docker und Docker Compose auf Ihrem System installiert haben.
+   Wenn Sie diese noch nicht installiert haben, können Sie die offizielle Dokumentation befolgen, um sie zu installieren.
+   Mit den folgenden Befehlen können Sie überprüfen, ob sie installiert sind:
+```
+docker --version
+docker compose --version
+```
+Alternativ zu Docker kann auch [Podman](https://podman.io/) verwendet werden.
+
+2. Infrastruktur starten: Die Infrastruktur-Container können mit folgenden Befehlen gestartet werden:
+```
+cd stack
+source .env
+docker compose up
+```
+
+3. Elasticsearch Zertifikat einbinden: Folgen Sie den Anweisungen unter [Erzeugen des Fingerprints](#erzeugen-des-fingerprints),
+   um das von Elasticsearch verwendete Zertifikat für die verschlüsselte Verbindung zu erhalten.
+   Dann fügen Sie den Fingerprint als Umgebungsvariable ELASTICSEARCH_CERT_FINGERPRINT im [.env-File](https://github.com/it-at-m/dave-frontend/blob/sprint/stack/.env) ein
+   und lesen die Datei nochmal ein:
+```
+source .env
+```
+
+4. Backend und Frontend hochfahren: Fahren Sie die beiden Container wie folgt hoch:
+```
+docker compose --profile sample-stack up
+```
+
+5. Auf die Anwendung zugreifen: Sobald alle Container betriebsbereit sind, können Sie die DAVe UI verwenden,
+   indem Sie im Browser zu http://localhost:8082 navigieren.
+
+Das war's! Sie haben den Anwendungsstack für DAVe erfolgreich installiert und gestartet.