0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-06 19:01:54 +00:00

Files

T

kevinveenbirkenbachandClaude Opus 4.7 8e293bd921 fix(compose-deploy): stop persisting runtime routing knobs into .env

Root cause of step-08 deploy failures across all 4 test-development
distros in run 26572559126: `make compose-deploy mode=reinstall
apps=web-app-dashboard INFINITO_SERVICES_DISABLED=matomo` (step 07)
made make export the cmdline var into the recipe's shell env, which
reached `runner.py` → `make setup` → `make dotenv`. The dotenv
generator's `setdefault` then baked the runtime-only value into the
on-disk `.env`. Step 08 sourced that .env, filtered `web-app-matomo`
out of its primary apps, and exited with "All primary apps disabled".

Fix:

- Drop the 7 routing knobs (apps, mode, purge, bundles, disable,
  full_cycle, variant) from `passthrough.STATIC_KEYS` and from
  `default.env`. They are per-invocation; .env is the persistent SPOT
  and must not capture them.
- Switch every consumer from `os.environ["KEY"]` strict access to
  `os.environ.get("KEY", "")` so the missing-key path stops at "no
  filter" instead of a KeyError.
- Rename the env-var surface to match the make-alias surface 1:1
  (lowercase): INFINITO_APPS → apps, INFINITO_SERVICES_DISABLED →
  disable, INFINITO_BUNDLES → bundles, INFINITO_FULL_CYCLE →
  full_cycle, INFINITO_VARIANT → variant, INFINITO_DEPLOY_MODE → mode,
  INFINITO_PURGE_ENTITIES → purge. The make alias was the user-facing
  name in every doc; routing-knob env vars now use the same name so
  the cmdline form, the recipe env-prefix, and the consumer reads
  all line up.
- Collapse the Makefile `compose-deploy` recipe to just the two
  knobs whose alias differs from the env name (`type` →
  INFINITO_DEPLOY_TYPE, `debug` → INFINITO_DEBUG). GNU Make
  auto-exports cmdline variables into the recipe's shell env, so the
  identical-name `$(if $(apps),apps="$(apps)")` lines were pure
  noise.
- Drop `disable: ${disable}` from compose.yml. The dev CLI builds
  `extra_env` per `docker exec` call and forwards `disable` via
  `-e`, so the container env never needs the value frozen at
  compose-up time.
- Update the 3 actual leak call sites
  (07/08/09_deploy_*.sh) to the make-alias form
  (`disable=matomo`, `full_cycle=true`, `variant=1`).
- Add `SIM112` to ruff's ignore set: the lowercase env names are
  the deliberate make/env parity, not a typo.

Repro before fix: `INFINITO_SERVICES_DISABLED=matomo make dotenv`
wrote `INFINITO_SERVICES_DISABLED=matomo` to `.env`. After fix:
`disable=matomo make dotenv` leaves `.env` untouched.

Tests: `make test` and `make autoformat` green (2711 tests, 8 lint
sub-targets).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

2026-05-28 17:47:03 +02:00

5.9 KiB

Raw Blame History

Local Deploy 🚀

Contributor guidance for running deploys against a local development stack on your workstation. For production deploy guidance see the Deploy Guide. For the agent-driven role iteration loop see role.md. For the matrix-variant mechanism that this page references throughout see variants.md.

Entry Points 🧭

Two layers exist for invoking a local deploy:

Layer	When to use
`make compose-deploy` in the Makefile	Default. Single entry point routed by main.sh. For the full Make-variable surface (`apps`, `mode`, `purge`, `type`, `bundles`, `disable`, `full_cycle`, `variant`) run `make help target=compose-deploy`.
`infinito administration deploy development <subcommand>` (Python CLI)	Direct invocation when you need a flag the make target does not expose, or when you script multi-step flows yourself.

The make target ultimately calls the same CLI, so any behaviour described here applies to both.

First-Run Baseline 📦

Use mode=reinstall to bring up a clean slate (cycles the dev stack and purges shared entities first):

make compose-deploy mode=reinstall apps="<role> <role>" full_cycle=true

full_cycle=true adds the async update pass (pass 2) and SHOULD stay on for the baseline. The behaviour, per-variant interleaving, and --full-cycle flag mechanics are documented in variants.md.
The router runs init, then deploy. Init materialises the inventory under ${INFINITO_INVENTORY_DIR} (resolved by make dotenv via resolve.sh; see variables.md).
For roles with a roles/<role>/meta/variants.yml the init step produces one inventory folder per variant; the deploy step iterates them. Folder layout, round semantics, cleanup rules, and the link to the file-format reference live in variants.md.

Edit / Fix / Redeploy Loop 🔁

Default redeploy after a local code change:

make compose-deploy mode=update apps="<role>"

Reuses the existing inventory, keeps app state, runs the deploy only.
For multi-variant roles you MUST set variant=<idx> (see Pinning A Single Variant) so the reuse path targets the round's folder. Without variant=, the reuse target points at <INFINITO_INVENTORY_DIR> which only exists for single-variant roles.

If the reuse path keeps reproducing the same failure and you want to test whether app entity state is involved:

make compose-deploy mode=update apps="<role>" purge=true

This purges the app's containers + volumes + Ansible-managed state on the host, then re-deploys. Use it once, then return to mode=update without purge=true. Do NOT loop with purge=true; if the failure survives a single purge it is not a state issue.

Only return to mode=reinstall when you have concrete evidence that the inventory or the host stack itself is broken (for example DNS or network failures during the deploy).

Pinning A Single Variant 🎯

For multi-variant roles you MAY restrict any of the make compose-deploy invocations above (and the dev CLI subcommands) to a single matrix round by setting variant=<idx>:

# Variant 1 baseline only (no full matrix):
make compose-deploy mode=reinstall apps="<role>" full_cycle=true variant=1

# Edit-fix-redeploy loop pinned to that variant:
make compose-deploy mode=update apps="<role>" variant=1

Pinning is sticky: when iterating with variant=<idx>, you MUST set it on every command in the iteration. Mixing pinned and unpinned commands silently retargets a different folder. The full semantics (single-folder mode, no inter-round cleanup, out-of-range error) live in variants.md.

Direct CLI Invocation ⚙️

When you need a flag the make wrappers do not expose, call the dev CLI directly:

infinito administration deploy development init   --inventory-dir "${INFINITO_INVENTORY_DIR}" --apps "<role>"
infinito administration deploy development deploy --inventory-dir "${INFINITO_INVENTORY_DIR}" --apps "<role>" [--variant <idx>] [--debug]

--inventory-dir is always the BASE path. The wrapper appends the -<round> suffix internally for matrix folders.
--variant <idx> pins to one round (same semantics as the variant= make arg).
The CLI prints the planned folder list at init time and the per-round summary at deploy time, so you can confirm the matrix shape before any work happens.

Inspect Live State 🔍

Use make compose-exec to drop into the running container shell. The repo is mounted at /opt/src/infinito, so code changes are visible immediately. Inspect logs and current state BEFORE redeploying so the failing snapshot stays available.

For TLS-enabled local sites, run make network-trust-ca once after the first deploy and restart the browser; alternatively use curl -k on the command line.

Reference Files 📌

File	Purpose
Makefile	The `deploy` router target and `make compose-exec` / `make network-trust-ca` helpers.
dev CLI tree	Python CLI for init, deploy, up, down, exec, etc.
`make dotenv`	Resolves `INFINITO_INVENTORY_DIR`, `INFINITO_INVENTORY_FILE`, and `INFINITO_INVENTORY_VARS_FILE` into `.env` for the dev CLI (see variables.md).
local deploy scripts	Bash glue behind the make targets (fresh / reuse / purge variants).
variants.md	Matrix-variant deep dive.
role.md	Role-iteration loop for agents. Recommended reading even for human contributors.

5.9 KiB Raw Blame History