dbx/deploy/database/RECIPE_TEMPLATE.md

Database Recipe Template

Create deploy/database/<product>/<version>/ with recipe.json, compose.yaml, and an init/ directory. Set defaultPort in recipe.json to the native service port; the connection port and Compose DB_PORT fallback must both be defaultPort + 1.

Every recipe must use a pinned image, default its host binding to ${DB_BIND_ADDRESS:-127.0.0.1}, use the standard port plus one by default, set container_name to dbx-<product>-<version>, use password 123456, and initialize database dbx. Redis-like services without named databases use DB 0 and the dbx: key prefix.

Add both a non-interactive smoke.steps command and an interactive shell command to recipe.json, then run:

pnpm test:db-env
make db-check
make db-verify DB=<product>@<version>
make db-reset DB=<product>@<version> CONFIRM=1