jschoubben
f801b4b3e2
Assumed throughout and stated nowhere — the wrong way round for the most consequential fact about this component. A board reachable only over the private network would sit inside the boundary 0004 already calls the security boundary, and a login there would guard a room whose door is inside the building. This one faces the internet, so its login is a perimeter rather than defence in depth. Which makes the identity provider the mesh's outermost gate. The board presents the control plane, and the control plane's networked surfaces can change the mesh (0035) — so whoever that provider admits can assign modules, from anywhere. Written flatly because it is easy to arrive at one reasonable step at a time and then be surprised by. What follows is not the board's own design: who may log in is a decision about the mesh rather than about an application; a public name needs a certificate from an authority the world trusts, which is why that work exists; and the provider going wrong in the permissive direction is a mesh-wide exposure with no local symptom. The command line is unaffected and is why this is tolerable — it authenticates through nothing and answers to the machine's own login, so the mesh stays operable by somebody standing at it whatever happens to the gate. That is the property to protect if the rest is ever traded away.
03-DESIGN
The authoritative specification. Implementation is built against what is written here.
Two layers
| Folder | What it is |
|---|---|
00-as-is/ |
The mesh that exists today. Shipped behaviour, described as it is — including behaviour nobody would choose again. |
01-to-be/ |
The mesh being built toward. Every statement traceable to a record in 02-DECISIONS/. |
They are never mixed. A statement about the future does not belong in an as-is document, and an as-is document is never edited to describe an intention.
When a to-be design ships, it does not move. Its as-is counterpart is written or updated,
the to-be document's status becomes implemented, and both stand — one describing what runs,
the other recording what was intended. Deleting the intention loses the reasoning, which is
the expensive half.
Frontmatter
Every design document (not the READMEs) carries:
---
layer: as-is | to-be
status: designed | in-progress | implemented | abandoned
code: [] # owning code repo(s), from 00-META/repos.md
updated: YYYY-MM-DD # date of the last status change, not of text edits
decisions: [] # 02-DECISIONS/ records this document rests on
---
For an as-is document, status: implemented is the normal state — it describes something that
runs — and code: names where that implementation lives.
Status changes when implementation state changes, never because design text was edited. An
implemented claim must be defensible from the owning repository's main branch, not from
intent. If it cannot be checked, it is in-progress.
Cross-cutting views are generated from this frontmatter by the hq-status skill and never
written to disk.
What belongs here
Functional analysis, architectural description, and specification — prose and diagrams
only, no code. A manifest field may be named; a manifest may not be pasted. A document
enters the to-be layer only after the decision behind it is recorded in 02-DECISIONS/
and the research that produced it is closed.
Subfolders are encouraged where a layer grows enough to need them.