417f8a3dd4
`db_data` was a volume and the instance directory was not, so the documented update path - `docker compose build api && up -d api` - recreated the container and discarded everything the site had written. `plugins.json` is only the loud part: maps, branding, model and application images, employee photos, warranty proofs, slides, printed-part files and the Dell OAuth token all live under instance_path too. MySQL rows survive and point at files that are gone, so the second symptom is images 404ing rather than an error anybody sees. Reported by an adopting site, which read it as having updated too fast. It had not; nothing it could have done differently would have kept those files. DEPLOY.md had been telling sites to back up `instance/` since it was written. The template never gave them anything to back up. The air-gap `migrate` service mounts the volume too, because `flask plugin upgrade-all` rewrites plugins.json and that service exits immediately after. The image now creates instance/ ITSELF, owned by the app user. Docker seeds an empty named volume from image content at the mountpoint, ownership included; with no such directory in the image the mountpoint is created root-owned 0755 and the container, which runs as shopdb, cannot write into its own instance directory. Caught by running the built image rather than by reading it: the volume mounted clean and `touch` came back Permission denied. Verified fixed the same way. A stack that predates the volume needs its files moved across ONCE, while the old container still exists - the volume is seeded from image content, and the image ships instance/ empty, so it comes up empty rather than inheriting the old container's writable layer. DEPLOY.md carries the procedure, including the chown after `docker compose cp`, which writes files under the copying user's numeric uid rather than the app user's. Also here, found while checking what an upgrade actually runs: the connected update steps ran `flask db upgrade` and stopped. Per-plugin Alembic chains (ADR-008) are not part of that, so a connected site taking an image with a bumped plugin migration ran the core chain and silently skipped every plugin chain. The air-gap stack had it right all along. Both commands are in Step 9 now, plus a `db current` check against `db heads`.
101 lines
3.7 KiB
YAML
101 lines
3.7 KiB
YAML
# shopdb-flask AIR-GAPPED single-site stack.
|
|
#
|
|
# For a site with NO internet. Nothing is built or pulled here: the images are
|
|
# built on a connected box (scripts/build-offline-bundle.ps1), shipped as a
|
|
# tarball, and `docker load`ed at the site. This file only RUNS pre-loaded
|
|
# images. See docs/DEPLOY-AIRGAP.md for the full runbook.
|
|
#
|
|
# Differences from docker-compose.yml (the connected/build template):
|
|
# - api uses `image:` (a loaded image), never `build: .` (build needs the net).
|
|
# - NO ./plugins bind mount. The image already carries every plugin baked in;
|
|
# binding a host ./plugins (which does not exist at an image-only site) would
|
|
# mask the baked plugins with an empty dir and load ZERO plugins.
|
|
# - a one-shot `migrate` service runs db upgrade + plugin upgrade-all + seed
|
|
# BEFORE api starts, so `up -d` alone brings up a working site (no manual
|
|
# `docker compose exec ... flask db upgrade` to forget).
|
|
#
|
|
# Usage at the site:
|
|
# docker load < shopdb-stack-<version>.tar.gz
|
|
# cp .env.example .env # then edit: secrets, CORS_ORIGINS, IMAGE_TAG
|
|
# docker compose -f docker-compose.airgap.yml up -d
|
|
# docker compose -f docker-compose.airgap.yml exec api flask seed admin <user> <email> <password>
|
|
|
|
# Shared application environment, reused by the migrate one-shot and the api
|
|
# service so the two never drift. A YAML anchor, not a container.
|
|
x-app-env: &app-env
|
|
FLASK_APP: wsgi.py
|
|
FLASK_ENV: production
|
|
DATABASE_URL: mysql+pymysql://shopdb:${MYSQL_PASSWORD}@db:3306/shopdb_flask?charset=utf8mb4
|
|
SECRET_KEY: ${SECRET_KEY:?SECRET_KEY must be set}
|
|
JWT_SECRET_KEY: ${JWT_SECRET_KEY:?JWT_SECRET_KEY must be set}
|
|
CORS_ORIGINS: ${CORS_ORIGINS:?CORS_ORIGINS must be set}
|
|
LOG_LEVEL: ${LOG_LEVEL:-INFO}
|
|
ZABBIX_URL: ${ZABBIX_URL:-}
|
|
ZABBIX_TOKEN: ${ZABBIX_TOKEN:-}
|
|
|
|
services:
|
|
db:
|
|
image: mysql:8.0
|
|
command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
|
|
restart: unless-stopped
|
|
environment:
|
|
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:?MYSQL_ROOT_PASSWORD must be set}
|
|
MYSQL_DATABASE: shopdb_flask
|
|
MYSQL_USER: shopdb
|
|
MYSQL_PASSWORD: ${MYSQL_PASSWORD:?MYSQL_PASSWORD must be set}
|
|
volumes:
|
|
- db_data:/var/lib/mysql
|
|
ports:
|
|
- "127.0.0.1:${MYSQL_PORT:-3306}:3306"
|
|
healthcheck:
|
|
test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-p${MYSQL_ROOT_PASSWORD}"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 5
|
|
|
|
# One-shot schema + seed. Runs to completion and exits; api waits for it.
|
|
# Every step is idempotent, so it is safe to run on every `up`.
|
|
migrate:
|
|
image: shopdb-flask:${IMAGE_TAG:-0.7.0}
|
|
restart: "no"
|
|
depends_on:
|
|
db:
|
|
condition: service_healthy
|
|
environment:
|
|
<<: *app-env
|
|
command:
|
|
- sh
|
|
- -c
|
|
- >
|
|
flask db upgrade &&
|
|
flask plugin upgrade-all &&
|
|
flask seed permissions &&
|
|
flask seed settings &&
|
|
flask seed reference-data
|
|
# plugin upgrade-all rewrites plugins.json, so migrate needs the same
|
|
# instance volume api uses. Without it the enabled-plugin list is written
|
|
# into a container that exits immediately afterwards.
|
|
volumes:
|
|
- instance_data:/app/instance
|
|
|
|
api:
|
|
image: shopdb-flask:${IMAGE_TAG:-0.7.0}
|
|
restart: unless-stopped
|
|
depends_on:
|
|
db:
|
|
condition: service_healthy
|
|
migrate:
|
|
condition: service_completed_successfully
|
|
environment:
|
|
<<: *app-env
|
|
ports:
|
|
- "${API_PORT:-5001}:5001"
|
|
# See docker-compose.yml for what lives here. Same reasoning: /app/instance
|
|
# is written state and does not survive a container recreate on its own.
|
|
volumes:
|
|
- instance_data:/app/instance
|
|
|
|
volumes:
|
|
db_data:
|
|
instance_data:
|