69 lines
3.9 KiB
Markdown
69 lines
3.9 KiB
Markdown
# rig — withdrawn assumptions
|
|
|
|
**Everything in this file is no longer true.**
|
|
|
|
It exists so the live docs stay short and a withdrawn assumption cannot quietly
|
|
return: each entry carries a **check**, and `ctrl/selftest.sh` runs every one of
|
|
them under "withdrawn stays withdrawn". A retraction that is only prose is one
|
|
nobody re-reads.
|
|
|
|
- **Do not restate these** in a plan, a README or a comment; point here (`✖ S2`).
|
|
- **Ids are stable.**
|
|
- **Only withdrawn things belong here.** A warning that is still actionable is a
|
|
live rule and stays where it is.
|
|
|
|
---
|
|
|
|
**✖ S1 — "rig supplies `ctrl/Tiltfile` but does not own it: replace the examples and
|
|
add your images in its marked sections."** *(ctrl/Tiltfile, README, 2026-09-13)*
|
|
Withdrawn 2026-09-22. Every project that used rig edited rig's own file, so no
|
|
update to rig could land without merging those edits by hand. rig's `ctrl/Tiltfile`
|
|
is now rig's: identity, context guard, registry, manifests, namespaces. The
|
|
workload's half is the overlay's own `Tiltfile`, which rig's includes.
|
|
**Check:** `ctrl/Tiltfile` includes the overlay's Tiltfile and has no "Images" section
|
|
of its own.
|
|
|
|
**✖ S2 — "A second environment is a copy of rig renamed after it (`../<name>-rig`), and
|
|
its use case is written into the copy."** *(README, BOOTSTRAP, .gitignore, 2026-08)*
|
|
Withdrawn 2026-09-22. A use case is an overlay, kept outside rig's version control
|
|
(`docs/notes/overlay.md`); rig itself is replaced as a whole. Copying rig still gives
|
|
a separate environment, but carries no use case of its own.
|
|
**Check:** rig's `.gitignore` ignores `/local/`; no `acme` example name remains in rig.
|
|
|
|
**✖ S3 — "rig's addons include the services a workload needs (a database, a cache, a
|
|
scheduler), described in the host project's vocabulary."** *(ctrl/addons/, README,
|
|
versions.env, 2026-08)* Withdrawn 2026-09-22. Which services a workload needs is
|
|
not rig's business. `ctrl/addons/` holds what makes a cluster work; workload addons
|
|
live with overlays, and `examples/data` carries them as an example.
|
|
**Check:** `ctrl/addons/` holds exactly cert-manager, metallb and metrics-server;
|
|
`versions.env` pins no workload image.
|
|
|
|
**✖ S4 — "The dev loop's namespace is named after the cluster."** *(ctrl/Tiltfile,
|
|
2026-09-13)* Withdrawn 2026-09-22. The Tiltfile created and grouped
|
|
`<CLUSTER>:namespace` while the example manifests declared `rig`, so every copy not
|
|
named `rig` stopped at load: `No object identified by the fragment
|
|
"acme-rig:namespace"`. The first real use worked around it with a Namespace named
|
|
`to_be_replaced` that its overlay renamed. The Tiltfile now creates the namespaces
|
|
the manifests use and groups the ones they declare.
|
|
**Check:** `ctrl/Tiltfile` does not build a namespace name from `CLUSTER`.
|
|
|
|
**✖ S5 — "`MANIFESTS_DIR` defaults to `ctrl/k8s/overlays/dev`, rig's own examples."**
|
|
*(lib/config.sh, .env.example, 2026-09-13)* Withdrawn 2026-09-22. The default is the
|
|
overlay's `k8s/overlays/dev`; rig's examples are `examples/starter`. The old value,
|
|
still pinned by older `.env` files, is ignored while that folder does not exist, and
|
|
`make check` says to delete it.
|
|
**Check:** `ctrl/k8s/overlays` does not exist; `.env.example` does not set
|
|
`MANIFESTS_DIR`.
|
|
|
|
**✖ S6 — "The example profiles are `client`, `data` and `offline`."** *(ctrl/env.d/,
|
|
2026-09-17)* Withdrawn 2026-09-22. "client" names the customer, not a registry
|
|
mode: the example is `mirror`. `data` was a workload, not a way of reaching the
|
|
world: it is the `examples/data` overlay.
|
|
**Check:** `ctrl/env.d/` holds no `client` or `data` example.
|
|
|
|
**✖ S7 — "BOOTSTRAP spans three repos: rig prepares the machine, the house repos own the
|
|
project's shape and everything after local."** *(BOOTSTRAP.md, 2026-08)* Withdrawn
|
|
2026-09-22. rig's docs describe rig. The house scaffold and registration sections
|
|
moved out of rig; BOOTSTRAP now ends with starting an overlay.
|
|
**Check:** no house path or host name (`semester`, `local.ar`) in rig.
|