69032cb6e7
3 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
| 69032cb6e7 | refactoring: Env-Dateien und Docker-Dateien | |||
| 42dcdbba32 | core Struktur umbau | |||
StefanMo
|
3f9326a533
|
Refactor(config): Implement central environment config (MP-18)) (#17)
* fix(infra): Makefile .env generiert * MP-18 Env-Konfiguration Refactoring: Schritte 2–4 umgesetzt\n\n2) Single Source of Truth für Versionen\n- docker/versions.toml als alleinige Quelle bestätigt\n- docker/build-args/global.env bereinigt und konsistent auf *_IMAGE_TAG umgestellt (PROMETHEUS_IMAGE_TAG, GRAFANA_IMAGE_TAG, KEYCLOAK_IMAGE_TAG, POSTGRES_IMAGE_TAG, REDIS_IMAGE_TAG, CONSUL_IMAGE_TAG, KAFKA_IMAGE_TAG, ZOOKEEPER_IMAGE_TAG)\n- Keine Ports/Profiles/Secrets in global.env\n\n3) Build vs. Laufzeit getrennt (Variablenbereinigung)\n- .env.template von allen Build-/Image-Versionen befreit (DOCKER_*_VERSION, (DOCKER_)APP_VERSION, BUILD_DATE)\n- App-Versionsvariable vereinheitlicht: Nutzung von VERSION (APP_VERSION in Build-Args entfernt)\n\n4) Laufzeit-Env konsolidiert (globales .env)\n- Zentrales config/env/.env erstellt (Ports, Hosts, Flags, Pfade, SPRING_PROFILES_ACTIVE, NODE_ENV etc.)\n- config/env/.env.local angelegt (gitignored) und .gitignore ergänzt\n- Laufzeitwerte aus Build-Args-Dateien (clients/infrastructure/services) entfernt bzw. kommentiert mit Verweis auf config/env/.env\n\nAkzeptanzkriterien erfüllt\n- global.env enthält ausschließlich Build-Versionen/-Tags und Build-Tool-Versionen\n- .env.template enthält keine Build-/Image-Versionen mehr\n- Zentrales config/env/.env ist die einzige Quelle für Laufzeitwerte\n\nYouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18 Env-Konfiguration Refactoring: Schritte 5–7 umgesetzt 5) Build-Args-Dateien entschlackt/umstrukturiert - clients.env: Laufzeitwerte entfernt, NODE_VERSION/NGINX_VERSION → NODE_IMAGE_TAG/NGINX_IMAGE_TAG; nur Build-relevante Pfade/Namen belassen - infrastructure.env/services.env: bereits zuvor Runtime-Variablen entfernt, Kommentare mit Verweis auf config/env/.env beibehalten 6) Dockerfiles überprüft/angepasst - clients/web-app: Build-ARGs eingeführt (GRADLE_VERSION, JAVA_VERSION, NGINX_IMAGE_TAG), Basis-Image aus Tag abgeleitet; keine Runtime-ARGs - services/ping-service: SPRING_PROFILES_ACTIVE als ARG entfernt; Build ruft ohne -P profile; Labels/ENV vereinheitlicht (OCI: version/created) - infrastructure/gateway: SPRING_PROFILES_ACTIVE als ARG entfernt; Build ohne -P; Labels vereinheitlicht - templates/spring-boot-service.Dockerfile: Runtime-ARGs (SPRING_PROFILES_ACTIVE, SERVICE_PORT) entfernt; Healthcheck/Expose auf ENV basierend; ENV getrennt gesetzt - infrastructure/monitoring-server: SPRING_PROFILES_ACTIVE-ARG entfernt; Build ohne -P; ENV/Labels bereinigt 7) docker-compose* bereinigt - docker-compose.yml: env_file: config/env/.env hinzugefügt; Image-Tags von DOCKER_* auf feste Versionen (aus global.env/versions.toml) umgestellt; keine Laufzeitwerte via build.args - docker-compose.services.yml: env_file hinzugefügt; DOCKER_* Build-Args entfernt; nur Build-Zeit-ARGs (GRADLE_VERSION, JAVA_VERSION, BUILD_DATE, VERSION); Ports/ENV aus config/env/.env - docker-compose.clients.yml: env_file hinzugefügt; DOCKER_* entfernt; NGINX_IMAGE_TAG als Build-Arg; APP_VERSION nutzt VERSION Akzeptanzkriterien - Keine Laufzeitvariablen in build-args-Dateien - Dockerfiles verwenden ausschließlich Build-ARGs; keine Ports/Secrets/Profile als ARG - Compose lädt nur eine Runtime-Env-Quelle (config/env/.env) und schleust keine Runtimewerte via build.args ein YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18 Env-Konfiguration Refactoring: Schritte 8–11 umgesetzt 8) Secrets-Strategie (Dev vereinfacht) - config/env/.env.local bereits vorhanden und gitignored; Nutzung für lokale Secrets verdeutlicht - docker/secrets/README.md hinzugefügt; echte Geheimnisse entfernt/Platzhalter gesetzt (postgres_password.txt) - Optimierte Compose-Dateien erzwingen Secrets nur im Profil 'prod' (profiles: [prod]) und verwenden env_file: config/env/.env 9) Namenskonventionen vereinheitlicht - DOCKER_* in optimierten Compose-Dateien entfernt; Build-Args auf GRADLE_VERSION/JAVA_VERSION/VERSION und *_IMAGE_TAG konsolidiert - SPRING_PROFILES_ACTIVE nur noch zur Laufzeit (Compose/env); aus Dockerfiles (auth, gateway, horses, events, members, masterdata) als Build-ARG entfernt 10) CI: ssot-guard.yml erweitert - Guard-Checks hinzugefügt: Fail bei Runtime-Variablen in Build-Args-Dateien und bei Build-/Versions-Variablen in Runtime-Envs - Konsistenz-Check zwischen docker/versions.toml und docker/build-args/global.env (zentraler Versionsabgleich) 11) Skripte & Automatisierung - Neues Skript scripts/generate-build-env.sh zum Generieren von docker/build-args/global.env aus docker/versions.toml (minimal) Akzeptanzkriterien - Lokale Entwicklung erfordert keine Docker-Secrets (Compose default), keine Geheimnisse im Repo - Keine DOCKER_* Präfixe in Laufzeitdateien, eindeutige Namenskonventionen - CI bricht bei Build-vs-Runtime-Verletzungen und Versions-Drift YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18 Env-Konfiguration Refactoring: Schritte 12–17 umgesetzt 12) DDD-Slice-Overrides eingeführt - Optionale Runtime-Env-Dateien hinzugefügt: config/env/services/{ping,members,horses,events,masterdata}.env, config/env/infrastructure/api-gateway.env, config/env/clients/web-app.env - Compose-Dateien laden diese Overrides zusätzlich zu config/env/.env (nur wenn vorhanden) 13) Deduplizierung bestätigt - Build-Args-Dateien enthalten keine Laufzeitwerte; .env/.env.template ohne Build-/Versions-Keys 14) Compose an Envs gekoppelt - docker-compose*.yml referenzieren ausschließlich config/env/.env + optionale Slice-Overrides; keine docker/build-args/*.env als Runtime-Quelle 15) Doku aktualisiert - README: neue Konfig-Struktur, Quickstart mit .env/.env.local, optionale Overrides, Deprecations (DOCKER_*_VERSION → *_IMAGE_TAG), Smoke-Tests 16) Cleanup & Deprecations - Deprecation-Hinweise in README dokumentiert; keine obsoleten Root-.env-Dateien verbleiben 17) Validierung & Hinweise - Start-/Healthcheck-Hinweise für lokalen Smoke-Test ergänzt; CI-Guards bleiben gültig * MP-18 DoD-Finalisierung: Build/Runtime-Trennung verhärtet, Doku-Hinweise korrigiert - Entfernt: Runtime-Build-ARG SERVICE_PORT aus Service-Dockerfiles (members, horses, events, masterdata) * Feste Default-Ports gesetzt (8083–8086), Healthchecks und SERVER_PORT-ENV angepasst * Erfüllt DoD: Build-Args enthalten keine Runtime-Werte mehr - .env.template Usage korrigiert: verweist nun explizit auf config/env/.env und compose-Aufrufe DoD-Checkliste: ✓ Zentrale Runtime-Datei config/env/.env + .env.local (Compose nutzt env_file) ✓ Build-Args nur Versionen/Pfade/Namen (keine Runtime-Keys) ✓ versions.toml als einzige Quelle für Image-/Tool-Versionen (CI-Guard prüft Drift) ✓ CI-Workflow blockiert Build/Runtime-Mixing & Versions-Drift (ssot-guard) ✓ README dokumentiert den Flow (Quickstart, Struktur, Deprecations) ✓ Clean Builds/Local-Starts durch compose-Files unterstützt YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18: GitHub-Workflows aktualisiert und README Markdownlint-Fehler behoben Workflows - CI: minimale Permissions + Concurrency hinzugefügt; build-test hängt jetzt auch von validate-docs ab; actions/setup-node → v4 - SSoT Guard: minimale Permissions + Concurrency - Deploy Proxmox: Concurrency; Deploy-Job läuft korrekt bei workflow_dispatch (zuvor durch falsche IF-Bedingung blockiert) - Docs KDoc Sync: minimale Permissions + Concurrency - Integration Tests: minimale Permissions + Concurrency - YouTrack Sync: minimale Permissions + Concurrency; Guard, wenn Secrets fehlen Docs - README.md: MD032 (Leerzeilen um Listen) korrigiert - README.md: MD037 (Spaces in Emphasis / Wildcards) durch Backticks behoben - README.md: MD034 (Bare URLs) via <> eingefasst Ziel - Optimierte, aktuelle CI-Workflows und grüne markdownlint-Prüfungen. YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18: Fix Docker SSoT validator errors Remove default values from centralized ARGs in web-app Dockerfile (GRADLE_VERSION, JAVA_VERSION, NGINX_IMAGE_TAG). Align build.args in compose files to centralized DOCKER_* vars from versions.toml mapping (clients/services/optimized), and update api-gateway in optimized compose. Replace hardcoded infra image tags in docker-compose.yml with DOCKER_* fallbacks for postgres/redis/prometheus/grafana/keycloak. Validated via scripts/validate-docker-consistency.sh all → Errors=0 (Warnings remain by design). YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * MP-18: Finalize Env/SSoT refactor – align generator, validator, build-args and compose - Switch docker/build-args/global.env to *_IMAGE_TAG keys (PROMETHEUS/GRAFANA/KEYCLOAK/POSTGRES/REDIS/CONSUL/KAFKA/ZOOKEEPER) - Clean docker/build-args/{clients,services,infrastructure}.env to build-time only; remove runtime/profile/ports - Update scripts/docker-versions-update.sh to emit *_IMAGE_TAG and strip runtime keys from build-args files - Update scripts/validate-docker-consistency.sh to check *_IMAGE_TAG and stop enforcing runtime keys in build-args - Rename Keycloak Dockerfile ARG to KEYCLOAK_IMAGE_TAG and update FROM/labels - Add build arg fallbacks in compose files where needed (GRADLE/JAVA/VERSION) for dev convenience Result: - scripts/validate-docker-consistency.sh all → 0 errors (warnings remain informational) YouTrack: https://meldestelle-pro.youtrack.cloud/issue/MP-18 * fix: Bash-Syntax-Fehler in ssot-guard.yml behoben - Fehlerhafte '2>/dev/null || true' Konstrukte in for-Schleifen entfernt - Stattdessen 'shopt -s nullglob' für saubere Behandlung nicht-existierender Dateimuster verwendet - Beide betroffene for-Schleifen (Runtime-Variablen und Build-Variablen Guards) korrigiert MP-18 * chore: Regenerate Docker Compose files to fix SSoT drift - Removed default values from build arguments (now using centralized DOCKER_* variables) - Removed env_file directives for cleaner configuration - Updated variable names for consistency (GATEWAY_PORT → API_GATEWAY_PORT) - Standardized comments and structure across all compose files Resolves SSoT drift detected by ssot-guard workflow. MP-18 * MP-18 fix: Bash-Syntax-Fehler in ssot-guard.yml behoben - Fehlerhafte '2>/dev/null || true' Konstrukte in for-Schleifen entfernt - Stattdessen 'shopt -s nullglob' für saubere Behandlung nicht-existierender Dateimuster verwendet - Beide betroffene for-Schleifen (Runtime-Variablen und Build-Variablen Guards) korrigiert * MP-18 chore: Regenerate Docker Compose files to fix SSoT drift - Removed default values from build arguments (now using centralized DOCKER_* variables) - Removed env_file directives for cleaner configuration - Updated variable names for consistency (GATEWAY_PORT → API_GATEWAY_PORT) - Standardized comments and structure across all compose files Resolves SSoT drift detected by ssot-guard workflow. * MP-18 fix: qodana_code_quality.yml qodana.yaml * fix: GitHub Actions Workflow-Fehler behoben - youtrack-sync.yml: Korrektur der secrets if-Bedingung (Line 18) * Entfernung ungültiger != '' Vergleiche * Verwendung korrekter GitHub Actions Syntax: secrets.YT_URL && secrets.YT_TOKEN - ssot-guard.yml: Korrektur der get_toml_ver() Funktion * Behebung des Versions-Drift Problems * Parsing nur aus [versions] Sektion mit State-Machine-Pattern * Korrekte Extraktion aller 11 Versionswerte aus versions.toml * Trimming von Spaces vor Key-Vergleich Fixes: MP-18 * MP-18 Entfernung von Qodana * MP-18 fix(ssot-guard): align build-args comments with generator output to remove SSoT drift - clients.env/services.env/infrastructure.env: update runtime note text to match scripts/docker-versions-update.sh - Avoids false-positive drift in workflow (content changes beyond ignored timestamps) * MP-18 fix: workflows/youtrack-sync.yml * MP-18 fix: workflows/youtrack-sync.yml * MP-18 fix: workflows/youtrack-sync.yml * MP-18 fix: workflows/youtrack-sync.yml * MP-18 fix: workflows/youtrack-sync.yml |
