Files
hq/00-META/glossary.md
T
jochen bf39baf104 Research 018 graduates: ADRs 0173–0177 and to-be 37, the operator's machine
Every configurable thing on a node is a module, the home included, and a
module is whatever it declares (0173, extending 0040). A node varies a module
only through a setting rendered into the file or a kept region, never an edit
(0174, extending 0011; issue 168 first). One tool runtime per node serves every
module's tools on the host side, never in a container; the console is its
serving mode, renamed node-tools (0175, extending 0150; 0047/0150/0152 carry
dated notes). The login shell is a node seat held by one shell module with
`execute` as its contract (0176). A unit may be user-scoped and the service
manager is a node seat held by systemd (0177).

To-be 37 is handed off in-progress to mesh-host, mesh-controller, mesh-tools
and mesh-catalog, with the build in order: the account on every node, the
runtime, zsh, systemd, then the graphical stack. To-be 29 keeps ~/.ssh and
points at 37; 33 §6 and 34 are amended; the glossary gains node tools, bundle,
kept region, installed/holding, and retires flavor.
2026-10-02 16:34:57 +02:00

8.6 KiB

Glossary — the words this repository uses, and the ones it stopped using

One name per thing. This page is the authority; where an older record says something else, that record is being superseded, not this page. It exists because the terms kept drifting in conversation — control plane / controller / master / hub for one thing, substrate / foundation for another — and a mesh you cannot name precisely is a mesh two people describe differently.

The mesh and its machines

  • node — a machine in the mesh. There are 0..n of them, and each runs the host agent. A node is just a machine that has joined; being one implies nothing about what it runs.
  • control-node — the one node that also holds the mesh-controller seat. There is exactly one per mesh. "control-node" is not a separate kind of machine — it is a node that additionally runs the controller (and, today, the foundation). Lose it and the other nodes keep running what they were last told; they simply cannot be told anything new.
  • master / slave, hub / peer — not used. The relationship is controller and nodes, and no node is subordinate: a node applies declarations on its own and survives the control-node dying.

What runs the mesh

  • controller — the component that decides what each node should be, holds the mesh's records, and tells nodes over the broker. Replaces "control plane" (borrowed from networking's control-plane/data-plane, and opaque here).

  • mesh-controller — the module that runs the controller. It claims the mesh-controller seat at mesh scope, which is what makes it singular. Replaces the module name mesh-control. (The git repository has been renamed mesh-control -> mesh-controller on the forge; the module, container and image it produces are mesh-controller.)

  • foundation — the store and the broker, raised at genesis before any module system exists. Replaces "substrate" (a biology metaphor that landed for no one). The foundation is not a third thing beside the store and broker — it is those two, named together.

  • store — the one postgres server. It holds the controller's own context databases (inventory, identity, licences — a context owns its store, ADR 0008) and every module's own database. One server, many databases — never one shared "mesh database".

  • bus — the mesh's own nervous system: NATS, one per mesh, carrying every link the mesh has — control, declarations, builds, events, tool calls (ADR 0106). A module reaches it by requiring mesh-bus (ADR 0128); one that does not require it has no account on it. Held by the mesh-broker seat, which is named after the role rather than the server, so the server can change without the seat doing so.

  • the deprecated broker — the lavinmq module. It was the mesh's bus and is not any more. It keeps running as an ordinary provider of the amqp provision, for modules that need a message broker of their own the way something needs a database (ADR 0127 (superseded by ADR 0131)) — no seat, not foundation, never raised at genesis, and a mesh that never installs it is complete.

    Say the deprecated broker, not "the compatibility broker" (it serves the mesh's own modules, not only the predecessor's) and not "the AMQP broker" (naming it after a protocol invites describing the bus by contrast with it, which is backwards: the bus is the mesh's nervous system and this is a module).

What the mesh stores and serves

  • package — what code resolves when it is compiled: an npm/cargo/pypi dependency, by version. Served by the package-registry (gitea). Only a builder talks to it.
  • artifact — anything a build produces and the mesh delivers to a machine by digest: an image, a mirrored upstream image, a bundle of the module's own code, an archive. Served by the artifact-store, an OCI registry that holds every kind as content-addressed blobs (ADR 0156). Every node pulls from it. An image is one kind of artifact, and a module is not an image.
  • These are two protocols, not one store being weak — see ADR 0075.

How modules relate to the mesh

  • seat — a named role at a scope (node / site / mesh), held by a module assignment, from a closed set the mesh defines: a claim naming a seat outside the set is refused. A seat may deliver a provision, and its holder is then the mesh's answer for it when several modules provide it (ADR 0126 (superseding ADR 0110)). The set, with who holds each seat, is the overview of what a mesh has (26 — The seats). A seat has a capacity: a capacity-1 seat is exclusive (one holder); a higher-capacity seat is a bench (several holders coexist).
  • claim — a module taking a spot on a seat. claims: [{name, scope}] in a manifest. A mesh-scoped exclusive claim is how the mesh says "there is one of me". A foundation seat is named after the server it guards: the mesh-controller, postgres and lavinmq modules claim the mesh-controller, mesh-store and mesh-broker seats (ADR 0079).
  • provision — a service one module provides and others require; the mesh resolves a provider and wires the two with an endpoint and a credential. A provision is a service you offer, a seat is a role you occupy, and the two meet where a seat delivers a provision: occupying the seat is what makes a module the provider of it.

The surfaces

  • console — the module (mesh-console) that puts the mesh's tools in front of whoever is on a machine: an MCP endpoint on the machine's loopback for an agent, the same endpoint for a person. It is assigned like any module, holds a credential the mesh minted, and calls tools under a grant its manifest declares (invokes). Loopback is the authority boundary: whoever is on the machine owns the mesh there (ADR 0152). Not "the tool bridge", "the brain" or "the MCP server" — those name the predecessor's program or a protocol, and the console is a module.
  • invokes — the manifest word for the tools a module calls, <module>.<tool> each or * for every one. A grant on the publish side and nothing else; a module that declares none calls nothing.

How this page is kept

A new name for an existing thing lands here first, in the same change that introduces it in code. A record under 02-DECISIONS/ keeps whatever word it was written with — those are immutable — so a term retired here may still appear there, and the mapping above is how to read it.

The operator's machine

  • node tools — the one tool runtime per node, a host-side process the host supervises, that loads every assigned module's tools bundle and serves every tool and held seat's verb on the subjects the memberships issue; its serving mode on loopback is what was called the console (ADR 0175). Replaces "console" as the module's name; console remains the word for the person's end of it.
  • bundle — the artifact a module's tools are built into, interpreted or compiled; never an image.
  • kept region — a marked block in a managed file the mesh writes into, where the operator's own lines survive every push and are given back when the module goes (ADR 0174). One of the two ways a node varies a module; the other is a setting.
  • installed / holding — a module may be assigned (its package installed, its files placed) without holding the seat its family declares; holding is being the one — the login shell, the display session — on that node (ADR 0176).
  • flavor — not used. What a flavor varied is a setting or a separate module.