Persistent dev db & cleanup

[jschoedl]

Summary

• add persistent database to local docker compose
• drop best practises MD file

Type of change

• Bug fix
• New feature
• Refactor / cleanup
• Infrastructure / CI
• Documentation

API changes

• This PR does not affect the API
• This PR changes the API → api/openapi.yaml updated and api/scripts/gen-all.sh re-run

Definition of Done

• CI passes
• Pre-commit hooks pass locally
• Relevant tests added or updated

Summary by CodeRabbit

• New Features

  • Added PostgreSQL provisioning to the local application environment with persistent storage and health checks.
  • Improved service startup sequencing by waiting for required dependencies to be ready.

• Improvements

  • Updated PostgreSQL container images to version 16.
  • Preserved database data through a named persistent volume.

• Documentation

  • Removed the best-practices guidance document.
  • Simplified Kubernetes namespace documentation.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docker-compose.yml (1)

51-52: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Publish the database port to the host for easier local development.

Using expose only makes the port available to other containers on the Docker network. For a local development environment, it is highly recommended to publish the port to the host machine using ports so developers can easily connect to the database using external SQL clients (e.g., DBeaver, DataGrip).

💡 Proposed refactor

-    expose:
-      - "5432"
+    ports:
+      - "5432:5432"

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docker-compose.yml` around lines 51 - 52, Update the database service
configuration near the existing expose entry to publish port 5432 to the host
using ports, enabling local SQL clients to connect; replace the expose-only
configuration while preserving the container’s database port.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@infra/docker-compose.yml`:
- Line 36: Revert the PostgreSQL image in the Docker Compose database service to
postgres:15-alpine, preserving compatibility with existing db-data volumes. Do
not upgrade the major version without adding an explicit migration strategy.

---

Nitpick comments:
In `@docker-compose.yml`:
- Around line 51-52: Update the database service configuration near the existing
expose entry to publish port 5432 to the host using ports, enabling local SQL
clients to connect; replace the expose-only configuration while preserving the
container’s database port.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a990cc6d-dd8d-498a-b5b9-db7b3b0e8d24

📥 Commits

Reviewing files that changed from the base of the PR and between 32ef62d and cd24b50.

📒 Files selected for processing (4)

• best_practices.md
• docker-compose.yml
• infra/docker-compose.yml
• infra/k8s/namespace.yaml

💤 Files with no reviewable changes (1)

• best_practices.md

[paulwiese]

LGTM! We should have added this sooner :)