Deploy in one run, with nothing older to preserve

There is no previous system kept serving, so the playbook no longer knows about
one: the retire flags, the temporary web address, the task that removed the old
nginx snippet and the task that stopped the old container are gone. One run
starts the container and points the Site's web address at it, and deploying an
earlier tag is the rollback. The vars lose vhost, retire_nginx_snippet,
retire_nginx_container and legacy_container; the Caddy role keeps only the
snippet upsert.

The deployment readme drops its staged-rollout sections and the glossary of words
that no longer exist, and the plan's sequence and the operating notes describe
the single run instead.
This commit is contained in:
tanshu committed 2026-09-22 23:27:17 +05:30
1 parent 041b8b62fe
commit f2d8058456
8 files changed
+152 -131

No files matched your search

+98
View File
@@ -1,5 +1,103 @@
# Operating the menus
For whoever is on the other end of "the menu is wrong". The design is in
`plan.md`, the vocabulary in `CONTEXT.md`, and the deployment in
`ansible-playbooks/menu-admin/readme.md`.
## Where things are
| Thing | Where |
| --- | --- |
| The app | container `menu-app.<site>` on `monoco`, image `registry.tanshu.com/menu-admin:<tag>` |
| Menu content | `/var/lib/menu-app.<site>/data` — `originals/`, `drafts/`, `published/` |
| Admin | `https://<vhost>/admin` |
| The password | `/var/lib/menu-app.<site>/site.env` (mode 600, never in git) |
| Categories | `data/sections.json`, edited in the admin |
| Brand and theme | `config/<site>.site.json` in this repo, baked into the image (the palette follows the Stitch system in `docs/design/stitch/`) |
## Everyday tasks
**Publish a new menu.** Sign in at `/admin`, find the Section, fill in "New Menu
Set" (label, optional valid-until date), Create Draft, then drop the photos in.
Drag to reorder — the order in the editor is the order customers see. Press
Preview to check it, then Publish. Publishing archives whatever was current.
**Put an older menu back.** Open the Section's "older menus" fold in the admin,
open the set you want and press "Make current". Its URL does not change.
**Change the admin password.** On the server:
```sh
bash /tmp/provision-site-env.sh /var/lib/menu-app.hopsngrains.com --force
docker restart menu-app.hopsngrains.com
```
**Add, rename, reorder or remove a category.** In the admin, open the
**Categories** fold at the bottom of the dashboard. A new category starts empty,
so customers do not see it until you publish a menu into it. Reordering there is
the order customers see. Two rules: a category's web address is fixed when it is
created (rename the name as often as you like — a printed QR code keeps working),
and a category can only be removed once it holds no menus.
**Change the restaurant's name or tagline, the icon, or the published dates.** In
the admin, open the **Site identity** fold: the name and tagline customers see,
a checkbox for whether a menu says when it was published, and an SVG upload for
the icon (under 256 KB; the upload replaces the bundled mark and "Remove the
uploaded icon" brings it back). None of this changes your web addresses.
**Change the colours.** Those are still `config/<site>.site.json`, so they need a
rebuild and push (`./deploy.sh <tag>`) and the playbook with the new tag.
**Fix a missing image.** If a Page's thumbnail or viewing image is lost while its
Original survives, the app can rebuild them:
```sh
docker run --rm --user 1000:1000 -e MENU_ROOT=/data \
-e MENU_SITE_CONFIG=/app/config/hopsngrains.site.json \
-v /var/lib/menu-app.hopsngrains.com:/data \
--entrypoint node registry.tanshu.com/menu-admin:<tag> src/cli/repair.ts
```
`src/cli/verify.ts` does the same inventory without changing anything, and is
what the server refuses to boot on.
## When something looks wrong
| Symptom | Look here |
| --- | --- |
| Landing page says the menus are being updated | no Section has a Current Menu Set — publish one in the admin |
| A Section 404s | that Section has no Current set, or the URL is misspelled |
| Sign-in rejects the right password | `docker logs menu-app.<site>`, then check `site.env` exists and is owned by the app user |
| Admin is missing entirely | `site.env` was unreadable at boot, so the admin is disabled: run the provision script and `docker restart` |
| A photo uploads but looks wrong | the browser shrinks to 3000px before upload; that is expected, and the Original is kept |
| The container will not start | `docker logs` — a fatal integrity problem makes it refuse to serve a data directory it cannot trust |
| Caddy reload failed during a deploy | nothing is down: Caddy validates before applying. Read the error in the playbook output |
| Everything is slow | check the tag is current; a Viewing image is ~1600px, so a Section page should not be megabytes |
**Logs.** `docker logs -f menu-app.<site>` — JSON lines, one per event, including
every upload, publish, restore and failed sign-in.
**Checking from outside.** No sign-in, no writes, exits non-zero on failure, so
it can gate a cutover:
```sh
npm run check-site -- https://menu.hopsngrains.com
```
## Backups
The app is the only writer. The irreplaceable part is
`/var/lib/menu-app.<site>/data/originals` — the photos exactly as uploaded, from
which everything else can be regenerated with `repair`. Back that directory up;
`site.env` is worth keeping too (otherwise you re-provision the password).
## Rolling back
Deploy the previous tag — `./deploy.sh <previous-tag>` — which rebuilds the Site at
that version. `docker logs menu-app.<site>` is where a container that will not start
says why.
For whoever is on the other end of "the menu is wrong". The design is in
`plan.md`, the vocabulary in `CONTEXT.md`, and the deployment in
`ansible-playbooks/menu-admin/readme.md`.
+12 -10
View File
@@ -123,16 +123,18 @@ The look is the Atelier Dining & Hospitality system from Stitch (`docs/design/st
## Sequence
1. Commit `nginx-menu/` to git so the current state is reproducible and revertible; create the `menu-admin` repo and move `CONTEXT.md`, `docs/`, and the ADRs into it.
2. Storage layer: config, manifest read/write, atomic writes, boot validation, tests.
3. Image pipeline: sharp variants, content-hashed filenames, tests.
4. Public renderer: landing, Section and archive routes, design tokens and CSS.
5. Admin: login, upload with browser pre-shrink, ordering, preview, publish/restore/delete.
6. Container, compose dev fixtures, Ansible role, deploy to `menu-new.hopsngrains.com`, verify from a phone on restaurant wifi.
7. Cutover: re-upload the current Food, Bar and Delivery menus, create What's On from the posters, switch `menu.hopsngrains.com` to the app, stop the old nginx container.
8. After a week: remove the old container and `/var/lib/menu.hopsngrains.com`, delete the dated folders, drop the dead `Caddyfile`, and reduce this folder to dev fixtures.
Deleting the old 319MB directory is the only irreversible step, so it is last.
1. Storage layer: config, manifest read/write, atomic writes, boot validation, tests.
2. Image pipeline: sharp variants, content-hashed filenames, tests.
3. Public renderer: landing, Section and archive routes, design tokens and CSS.
4. Admin: login, upload with browser pre-shrink, ordering, preview, publish/restore/delete.
5. Container, compose dev fixtures, Ansible role.
6. Deploy: `make build-production TAG=<tag>` builds a multi-arch podman manifest and
pushes it; the playbook in `ansible/` runs one Site to completion — it starts the
container and points the Site's web address at it. There is no older system kept
serving and nothing to retire, so there is no staged rollout; deploying an earlier
tag is the rollback.
7. Create the admin password once per Site (`scripts/provision-site-env.sh`), then
`npm run check-site` and a phone.
## Out of scope