knacky/mimic-big
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(backend): rename docker-compose.yml -> compose.yml + podman notes

Browse Source 
Compose v2 canonical filename (compose.yml) is recognized by both
docker compose and podman compose without preference. The previous
docker-compose.yml worked but signalled a Docker-first stance, while
target deployment is Podman 5.8+ rootless.

- Rename backend/docker-compose.yml -> backend/compose.yml.
- backend/README.md `make db-up` comment uses $(CONTAINER) to mirror
  the Makefile auto-detect (lines 14-16: docker || podman).
- backend/README.md audit-writer bootstrap snippet hints at podman
  fallback explicitly with `command -v` runtime sniff.
- backend/compose.yml comment for audit-writer mentions both runtimes.

No functional change. Makefile $(COMPOSE) target unchanged: Compose v2
discovers compose.yml first in its search order.
This commit is contained in:
knacky
2026-05-22 19:41:38 +02:00
parent ffcac42272
commit 9ece352659
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
backend/README.md
View File

@@ -34,7 +34,7 @@ backend/
```bash ```bash
make install # uv venv + pip install -e .[dev] make install # uv venv + pip install -e .[dev]
make db-up # docker compose up -d postgres make db-up # $(CONTAINER) compose up -d postgres (auto-detect docker|podman)
make db-bootstrap # one-time: create the mimic_audit_writer role (see below) make db-bootstrap # one-time: create the mimic_audit_writer role (see below)
make db-migrate # alembic upgrade head make db-migrate # alembic upgrade head
make run # flask run (debug) make run # flask run (debug)
@@ -49,7 +49,9 @@ make lint # ruff + mypy strict
(decision D-010). For local development, create it manually after `make db-up`: (decision D-010). For local development, create it manually after `make db-up`:
```bash ```bash
docker exec -it mimic-postgres psql -U mimic_app -d mimic \ # Substitute "podman" for "docker" if your runtime is Podman.
$(command -v docker || command -v podman) exec -it mimic-postgres \
psql -U mimic_app -d mimic \
-c "CREATE ROLE mimic_audit_writer LOGIN PASSWORD 'pick-a-dev-secret';" -c "CREATE ROLE mimic_audit_writer LOGIN PASSWORD 'pick-a-dev-secret';"
``` ```

3
backend/docker-compose.yml → backend/compose.yml
View File

@@ -12,7 +12,8 @@ services:
volumes: volumes:
- mimic_pgdata:/var/lib/postgresql/data - mimic_pgdata:/var/lib/postgresql/data
# The `mimic_audit_writer` role is provisioned by the Ansible playbook # The `mimic_audit_writer` role is provisioned by the Ansible playbook
# in prod (D-010). For dev, create it manually after `make db-up`: # in prod (D-010). For dev, create it manually after `make db-up`
# (substitute `podman` for `docker` if your runtime is Podman):
# docker exec -it mimic-postgres psql -U mimic_app -d mimic \ # docker exec -it mimic-postgres psql -U mimic_app -d mimic \
# -c "CREATE ROLE mimic_audit_writer LOGIN PASSWORD '<choose one>';" # -c "CREATE ROLE mimic_audit_writer LOGIN PASSWORD '<choose one>';"
# Then expose the same secret in MIMIC_DATABASE_AUDIT_URL in your .env. # Then expose the same secret in MIMIC_DATABASE_AUDIT_URL in your .env.