A version prepares its state before it runs
The mesh derives the preparation from the module's own resource instead of each module hand-writing a step beside it (novox/hq ADR 0135). A manifest says one word — `prepares` — and the mesh runs that module's own program in its preparation mode, in the module's own context: the same image, the same environment, the same mounts, because it is the same code. A published port and a fixed address are taken away rather than copied, since the version being replaced still holds them. One word for every kind of module: a Go binary receives `prepare` as its argument, a bundle receives it through the runtime whose entry takes the same word. The control plane answers it like anything else — its own schema stops being a special case, and its hand-written step is gone.
This commit is contained in:
@@ -225,6 +225,19 @@ type Manifest struct {
|
||||
// subscription to the queue it writes to (design 29 §2).
|
||||
Uses []string `json:"uses,omitempty"`
|
||||
|
||||
// Prepares says this module has state that must be brought to the shape this version needs
|
||||
// before this version runs, and that the module's own code does it (novox/hq ADR 0135).
|
||||
//
|
||||
// **A word, not an arrangement.** The mesh runs the module's own program in its preparation
|
||||
// mode, in the module's own context — every binding, credential and setting its code receives,
|
||||
// because it *is* its code. Nothing here names a container, a command, a mount or a variable:
|
||||
// the module already said all of that once, and a second copy is a second thing to drift.
|
||||
//
|
||||
// **Declared, never inferred.** The control plane cannot read what is inside an artifact, so a
|
||||
// module that ships a migration and does not say this breaks on its first upgrade. That is
|
||||
// stated in the record rather than guarded here, because nothing mechanical can guard it.
|
||||
Prepares bool `json:"prepares,omitempty"`
|
||||
|
||||
// Tools are the tools this module answers — request and reply, awaited.
|
||||
//
|
||||
// **New, and not `serves`**, which this manifest already uses for the facts a consumer needs
|
||||
@@ -1276,6 +1289,17 @@ func ParseManifest(raw []byte) (Manifest, error) {
|
||||
"program that reads what the mesh delivered and reconciles",
|
||||
m.Module, r["id"]))
|
||||
}
|
||||
// **A module that prepares its state must have code the mesh can run** (novox/hq ADR 0135). The
|
||||
// preparation is the module's own program in its preparation mode, so it is derived from the
|
||||
// resource that runs that program — and a module declaring none has asked for something the mesh
|
||||
// cannot compose. Said here, where the manifest is read, rather than by a declaration that
|
||||
// quietly prepares nothing.
|
||||
if m.Prepares && preparationTarget(m) == "" {
|
||||
problems = append(problems, fmt.Sprintf(
|
||||
"%s says it prepares its state, and declares no container running an artifact it built — "+
|
||||
"the preparation is this module's own program, so there has to be one for the mesh to "+
|
||||
"run it in", m.Module))
|
||||
}
|
||||
// **A run-once container is a step the host runs to completion** (novox/hq ADR 0052). It is a
|
||||
// boolean modifier on the container shape — the host runs the container, requires it to exit 0,
|
||||
// and starts whatever the declaration places after it only once it has. A value that is not a
|
||||
|
||||
Reference in New Issue
Block a user