The tests' seat list holds the group's definitions: mesh-recovery and four more seats, eleven taken again

seatlisttest gains mesh-builds, mesh-delivery-view, mesh-grants,
mesh-pipeline-runner and mesh-recovery, which the live list (revision 473)
holds, and takes again the eleven definitions and two parts the group's heads
change (mesh-contracts feat/47-H2 e6ed560e, mesh-delivery feat/47-H2 80ff1afa,
mesh-catalog's form 5 from feat/47-H2-i 5e943280), so a test judges a manifest
against the seats the running validator judges it against. The three
bootstrapped seats among them (mesh-catalog, mesh-delivery, node-engine) are
replaced in the bootstrap and its captured contracts copy too (ADR 0635 §3,
ADR 0636 §7); the service manager's tests take its kernel-log verb, and the
grants module's name, now also a seat's, joins the kept names.

Builds: design 47 H2, H-A-452
This commit is contained in:
2026-11-22 02:29:29 +01:00
parent f90189353c
commit a323a3fd54
28 changed files with 7535 additions and 150 deletions
+6 -5
View File
@@ -7,7 +7,8 @@ import (
)
// The service manager is a seat of the mesh's own with the unit verbs as its contract (novox/hq
// ADR 0177): every verb described, with a schema, taking a scope.
// ADR 0177): every verb described, with a schema, taking a scope but kernel-log, the kernel's messages, which no user
// unit has (issue 1975).
func TestTheServiceManagerSeatServesTheUnitVerbs(t *testing.T) {
seat, ok := SeatNamed("node-service-manager")
if !ok {
@@ -16,7 +17,7 @@ func TestTheServiceManagerSeatServesTheUnitVerbs(t *testing.T) {
if seat.Scope != ScopeNode {
t.Fatalf("the service manager is a role each machine has once, and the seat is %s-scoped", seat.Scope)
}
want := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal", "failed", "reset-failed", "wanted-by", "unlink-dangling"}
want := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal", "kernel-log", "failed", "reset-failed", "wanted-by", "unlink-dangling"}
var got []string
for _, v := range seat.Serves {
got = append(got, v.Name)
@@ -24,7 +25,7 @@ func TestTheServiceManagerSeatServesTheUnitVerbs(t *testing.T) {
t.Fatalf("%s is promised without a description or a schema", v.Name)
}
props, _ := v.Input["properties"].(map[string]any)
if _, has := props["scope"]; !has {
if _, has := props["scope"]; !has && v.Name != "kernel-log" {
t.Fatalf("%s takes no scope, and a user unit could not be asked for", v.Name)
}
}
@@ -41,7 +42,7 @@ func TestFailedIsAnOptionalVerbOfTheServiceManager(t *testing.T) {
holder := func(serves ...string) Manifest {
return Manifest{Module: "systemd", Version: "1", Claims: []Claim{{Name: ServiceManagerSeat, Scope: ScopeNode, Serves: serves}}}
}
eight := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal",
eight := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal", "kernel-log",
"reset-failed", "wanted-by", "unlink-dangling"}
if err := CanHold(holder(eight...), seat); err != nil {
t.Fatalf("a holder without failed is refused: %v", err)
@@ -69,7 +70,7 @@ func TestFailedIsAnOptionalVerbOfTheServiceManager(t *testing.T) {
// back from the store's row they stay required.
func TestResetFailedWantedByAndUnlinkDanglingAreRequiredVerbsOfTheServiceManager(t *testing.T) {
defer UseSeats(DefaultSeats())
nine := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal", "failed"}
nine := []string{"units", "status", "start", "stop", "restart", "enable", "disable", "journal", "kernel-log", "failed"}
all := append(slices.Clone(nine), "reset-failed", "wanted-by", "unlink-dangling")
holder := func(serves ...string) Manifest {
return Manifest{Module: "systemd", Version: "1", Claims: []Claim{{Name: ServiceManagerSeat, Scope: ScopeNode, Serves: serves}}}
+179 -9
View File
@@ -253,6 +253,49 @@
},
"class": "read"
},
{
"name": "seat-list",
"class": "read",
"description": "The trunk's seat list as the mesh holds it, the object of the holder's objects seat-lists of that digest (design 47 H2 §814, §820; H-A-441, H-A-443): its digest and size, then its bytes (the definitions resolved, a JSON array in the form of a composer request's seats, sorted by seat) in chunks of at most 512 KiB on the chunk subject of the call, each acknowledged by the caller on the ack subject within 30 seconds. A validate run's asker fills the request's seats from these bytes. Reads only.",
"input": {
"type": "object",
"properties": {
"call": {
"type": "string",
"description": "128 random bits the caller chooses: the subject token of this send's chunks and acknowledgements",
"minLength": 1
}
},
"required": [
"call"
]
},
"answer": {
"type": "object",
"properties": {
"digest": {
"type": "string",
"description": "the seat list's sha256, the object's name in seat-lists"
},
"size": {
"type": "integer",
"minimum": 0,
"description": "the seat list's size in bytes"
},
"chunks": {
"type": "integer",
"minimum": 0,
"description": "how many chunks are sent"
}
},
"required": [
"digest",
"size",
"chunks"
]
},
"chunks": true
},
{
"name": "revision",
"description": "The catalog half of the revision view (ADR 0656 §6): one catalog graph revision with its entries whole, the trunk heads, the seat definitions by digest, and each manifest's verdict and fingerprint; the trunk's newest when no revision and no candidate is named, or a candidate's for its group and heads. Answered by the holder from what it holds, in its own runtime (ADR 0663), in pages of entries. Reads only. A watched branch with no revision yet answers {none-yet: true} alone (design 47 G section 530).",
@@ -312,7 +355,7 @@
},
{
"name": "registrations",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed.",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed. Filtered by module or repository while it reads and paged by the cursor next, at most 768 KB a page (design 47 H2 §806, §811).",
"input": {
"type": "object",
"properties": {
@@ -323,6 +366,14 @@
"history": {
"type": "boolean",
"description": "with every version of the one module"
},
"repository": {
"type": "string",
"description": "only the registrations of this repository, <owner>/<name>, applied while reading (design 47 H2 §806)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
}
},
@@ -344,6 +395,18 @@
},
"fill": {
"$ref": "#/defs/Fill"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §806)"
},
"total": {
"type": "integer",
"description": "how many registrations the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
@@ -657,6 +720,32 @@
"source": {
"type": "integer"
},
"call": {
"type": "string",
"description": "what made the revision, as the revision's call names it (design 47 H-A-212, H-A-213); absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string"
},
@@ -1448,6 +1537,13 @@
"$ref": "#/defs/Registration"
},
"description": "a module's registration"
},
{
"key": "source.<owner>.<name>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "a source-only registration of a repository with no module (design 47 H2 §815)"
}
]
},
@@ -1462,6 +1558,13 @@
"$ref": "#/defs/Registration"
},
"description": "one version of a module's registration"
},
{
"key": "source.<owner>.<name>.<version>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "one version of a source-only registration (design 47 H2 §815)"
}
]
},
@@ -1594,6 +1697,10 @@
"type": "string",
"description": "its manifest's verdict: accepted, refused or held"
},
"class": {
"type": "string",
"description": "core or leaf: core when its manifest claims a seat, leaf when it claims none; an entry without it reads as leaf (design 47 H2 H-A-394, H-A-431)"
},
"fp": {
"type": "string",
"description": "its fingerprint (src2: and 64 hex digits); absent when it has none"
@@ -1871,6 +1978,32 @@
"type": "integer",
"description": "the source revision it was taken in from; for a candidate, the source revision its heads are merged onto"
},
"call": {
"type": "string",
"description": "what made the revision (design 47 H-A-212, H-A-213): a take-in's the gate's call its source revision names, a re-pin's release of <module> <version>, a take-in again's take-in again of <repository>; absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217): a take-in's, a re-pin's on a module's release, a take-in again's, a recompute's that moved a fingerprint (its call naming the reason); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string",
"description": "a candidate's group"
@@ -1927,6 +2060,10 @@
"$ref": "#/defs/TakeInEntry"
},
"description": "the movers of the take-in that wrote it, so a redelivered source-moved whose revision is kept says take-in.taken again from them, recomputing nothing (design 47 H §743, H-A-92); absent for one with no mover"
},
"base": {
"type": "integer",
"description": "the newest kept revision of its branch below it, which the take-in that wrote it pinned for its pipeline: the base of the validate step's case before (design 47 H-A-147, H-A-151, H-A-154); absent on the branch's first take-in"
}
},
"required": [
@@ -2078,14 +2215,15 @@
},
"Registration": {
"type": "object",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve; or a source-only registration of a repository with no module (design 47 H2 §815): its origin, one watched branch, its policy and its check, naming no module and no path, kept under source.<owner>.<name>",
"properties": {
"v": {
"type": "integer",
"description": "the layout version"
},
"module": {
"type": "string"
"type": "string",
"description": "the module; absent for a source-only registration"
},
"origin": {
"type": "string",
@@ -2093,7 +2231,7 @@
},
"path": {
"type": "string",
"description": "the path of its manifest in the repository"
"description": "the path of its manifest in the repository; absent for a source-only registration"
},
"branches": {
"type": "array",
@@ -2121,12 +2259,14 @@
"at": {
"type": "string",
"format": "date-time"
},
"check": {
"$ref": "#/defs/SourceCheck",
"description": "for a source-only registration, the one step its heads run (design 47 H2 §815)"
}
},
"required": [
"module",
"origin",
"path",
"branches",
"policy"
]
@@ -2157,9 +2297,10 @@
"placed",
"review required",
"unknown module",
"nothing moves"
"nothing moves",
"holds-manifest"
],
"description": "why no ask was raised"
"description": "why no ask was raised; holds-manifest: a source-only registration whose repository holds a module.json at its root or under modules/ at the branch's head (design 47 H2 §815; H-A-450)"
},
"words": {
"type": "string",
@@ -2469,6 +2610,34 @@
"ref",
"language"
]
},
"SourceCheck": {
"type": "object",
"description": "the check of a source-only registration: a build seat and a step kind, run at the repository's root, never a free command (design 47 H2 §815)",
"properties": {
"seat": {
"type": "string",
"enum": [
"node-build-go",
"node-build-node",
"node-build-image"
],
"description": "the build seat that runs it"
},
"step": {
"type": "string",
"enum": [
"lint",
"unit",
"integration"
],
"description": "the step kind"
}
},
"required": [
"seat",
"step"
]
}
},
"bodies": {
@@ -2567,5 +2736,6 @@
"call"
]
}
}
},
"form": 5
}
+51 -8
View File
@@ -9,7 +9,7 @@
"verbs": [
{
"name": "deliveries",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group.",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group. Filtered by repository, module, outcome and since while it reads, at most 768 KB a page, capped saying the rest is read from the cursor next (design 47 H2 §811).",
"input": {
"properties": {
"all": {
@@ -31,13 +31,55 @@
"state": {
"description": "one state, e.g. delivering or held",
"type": "string"
},
"module": {
"type": "string",
"description": "only the deliveries that move this module, applied while reading (design 47 H2 §811)"
},
"outcome": {
"type": "string",
"description": "only the deliveries that ended with this outcome, applied while reading (design 47 H2 §811)"
},
"since": {
"type": "string",
"format": "date-time",
"description": "only the deliveries opened at or after this time, applied while reading (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
},
"type": "object"
},
"answer": {
"type": "object",
"description": "what deliveries answers, as its description says"
"description": "what deliveries answers, as its description says",
"properties": {
"deliveries": {
"type": "array",
"items": {
"type": "object",
"description": "one delivery's record, as the gate keeps it"
},
"description": "this page's deliveries, the open ones first, then the newest"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §811)"
},
"total": {
"type": "integer",
"description": "how many deliveries the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
"deliveries"
]
},
"class": "read"
},
@@ -196,7 +238,7 @@
"name": "record-opened",
"body": {
"type": "object",
"description": "a delivery record opened for one source revision of a merge call (design 47 H \u00a7737)",
"description": "a delivery record opened for one source revision of a merge call (design 47 H §737)",
"properties": {
"record": {
"type": "string",
@@ -319,7 +361,7 @@
"subject": "source-moved.<branch>.<source>",
"body": {
"type": "object",
"description": "a source revision of a watched branch, named once per merge call (design 47 H \u00a7737)",
"description": "a source revision of a watched branch, named once per merge call (design 47 H §737)",
"properties": {
"v": {
"type": "integer"
@@ -337,7 +379,7 @@
},
"start": {
"type": "boolean",
"description": "true only for a branch's first revision (design 47 H \u00a7768)"
"description": "true only for a branch's first revision (design 47 H §768)"
},
"heads": {
"type": "array",
@@ -448,7 +490,7 @@
},
"call": {
"type": "string",
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H \u00a7737, H-A-33)"
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H §737, H-A-33)"
}
},
"required": [
@@ -512,7 +554,7 @@
"name": "heads",
"template": "state",
"history": 1,
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H \u00a7740)",
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H §740)",
"key-forms": [
{
"key": "<repository>.<branch>",
@@ -672,5 +714,6 @@
"head"
]
}
}
},
"form": 2
}
+203 -24
View File
@@ -1,11 +1,12 @@
{
"format": 1,
"form": 3,
"seat": "node-engine",
"scope": "node",
"grain": "whole",
"domain": "Core",
"decision": "novox/hq ADR 0563",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 §3, §4): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 §2).",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 \u00a73, \u00a74): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 \u00a72).",
"acts": [
{
"step": "compose",
@@ -15,7 +16,7 @@
"verbs": [
{
"name": "hand-over",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 §3, §5): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 \u00a73, \u00a75): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"input": {
"properties": {
"path": {
@@ -39,7 +40,7 @@
},
{
"name": "access-act",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 §7, ADR 0563 §3, §4), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 \u00a77, ADR 0563 \u00a73, \u00a74), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"input": {
"properties": {
"access": {
@@ -68,7 +69,7 @@
},
{
"name": "judge-directories",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 §2). Read-only: changes no owner or mode.",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 \u00a72). Read-only: changes no owner or mode.",
"input": {
"properties": {},
"type": "object"
@@ -80,7 +81,7 @@
},
{
"name": "setuid-search",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 §2); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 \u00a72); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"input": {
"properties": {
"why": {
@@ -97,7 +98,7 @@
},
{
"name": "root-free",
"description": "Whether this machine is root-free (novox/hq ADR 0259 §8, ADR 0563 §6): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"description": "Whether this machine is root-free (novox/hq ADR 0259 \u00a78, ADR 0563 \u00a76): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"input": {
"properties": {},
"type": "object"
@@ -121,7 +122,7 @@
},
{
"name": "acts",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 §9): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 \u00a79): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"input": {
"properties": {
"id": {
@@ -242,7 +243,7 @@
"type": "string"
},
"digest": {
"description": "a composition's digest (sha256:…), to read that revision rather than the latest",
"description": "a composition's digest (sha256:\u2026), to read that revision rather than the latest",
"type": "string"
},
"module": {
@@ -287,7 +288,7 @@
},
"self": {
"type": "boolean",
"description": "the node composes the module itself (ADR 0547 §2)"
"description": "the node composes the module itself (ADR 0547 \u00a72)"
},
"backup": {
"type": "string",
@@ -517,6 +518,27 @@
"withheld-unknown": {
"type": "string",
"description": "withheld unknown: the grants part does not answer, when its verb withheld did not answer"
},
"withheld-parts": {
"type": "array",
"description": "each part a compose kept because its read did not answer, with why (design 08 control-verbs \u00a74, H-A-321): for the packet filter's holder the part node-packet-filter.allowed, its filter file kept as it runs",
"items": {
"type": "object",
"required": [
"part",
"why"
],
"properties": {
"part": {
"type": "string",
"description": "the read asked, as <seat>.<verb>"
},
"why": {
"type": "string",
"description": "why it did not answer, naming the holder asked"
}
}
}
}
},
"required": [
@@ -529,6 +551,63 @@
},
"class": "read"
},
{
"name": "composition-diff",
"description": "One module's composed values read by resource (design 47 H2 \u00a7813 (3), H-A-349 DQ-12b): given a module and a revision or a digest of its composition, the entries that differ between the composition that runs and that one, per resource, environment entries by name, a secret's value masked. Read-only. Answered by this machine's engine alone.",
"class": "read",
"input": {
"type": "object",
"required": [
"module"
],
"properties": {
"module": {
"type": "string",
"description": "the module, as placed on this machine; node for the node's own"
},
"revision": {
"type": "integer",
"description": "the revision of the module's composition key to compare with, from the revisions the bucket keeps; give it or digest"
},
"digest": {
"type": "string",
"description": "the digest (sha256:\u2026) of the composition to compare with; give it or revision"
}
}
},
"answer": {
"type": "object",
"required": [
"node",
"module",
"resources"
],
"properties": {
"node": {
"type": "string",
"description": "the node"
},
"module": {
"type": "string",
"description": "the module"
},
"running": {
"type": "string",
"description": "the digest of the composition that runs; absent when nothing runs"
},
"other": {
"$ref": "#/defs/Revision"
},
"resources": {
"type": "array",
"description": "each resource with an entry that differs; empty when none differs",
"items": {
"$ref": "#/defs/CompositionDiffResource"
}
}
}
}
},
{
"name": "compose",
"description": "Compose this machine's modules now and say how it went, so a composition that failed, or a module held, recovers without a restart: what the pass refused or held, each with why, and when the engine composes again on its own after a seat that did not answer (a deadline, no responders: retried with a growing wait; a refusal never). With module, that module's apply is also tried again. Changes only what a pass the engine makes on its own would change.",
@@ -595,7 +674,7 @@
},
{
"name": "compose-candidate",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 §7). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 \u00a77). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"optional": true,
"input": {
"properties": {
@@ -640,7 +719,7 @@
"unready",
"not-judged"
],
"description": "the node's verdict (ADR 0593 §7, §9)"
"description": "the node's verdict (ADR 0593 \u00a77, \u00a79)"
},
"modules": {
"type": "array",
@@ -686,7 +765,7 @@
{
"name": "manifest-reads",
"optional": true,
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 §3) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 \u00a73) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"input": {
"type": "object",
"properties": {}
@@ -720,7 +799,7 @@
"node",
"stated-at"
],
"description": "what this machine's engine reads of a manifest (ADR 0618 §3)"
"description": "what this machine's engine reads of a manifest (ADR 0618 \u00a73)"
},
"class": "read"
},
@@ -787,7 +866,7 @@
},
{
"name": "seat-list",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 §7): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 \u00a77): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"input": {
"type": "object",
"properties": {}
@@ -798,7 +877,7 @@
},
{
"name": "seat-list-again",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 §7), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 \u00a77), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"input": {
"type": "object",
"properties": {}
@@ -1057,6 +1136,52 @@
"$ref": "#/defs/ProcessBuilds"
},
"class": "read"
},
{
"name": "converged",
"description": "The node's convergence state, which the node-engine keeps (ADR 0168, ADR 0683; design 33 control-verbs \u00a710): adopted or converged, since when it became so, for an adopted node the kind of the firewall found, and the node's links as the engine classifies them: the tunnel's interface and the outward links (design 47 H-A-325). Read-only: the holder of node-packet-filter asks it at its start and at every allow and disallow, and refuses when it does not answer.",
"class": "read",
"input": {
"type": "object",
"properties": {}
},
"answer": {
"type": "object",
"required": [
"state",
"tunnel",
"outward"
],
"properties": {
"state": {
"type": "string",
"enum": [
"adopted",
"converged"
],
"description": "the node's mode: adopted (the found firewall's terms) or converged (the mesh's own filter)"
},
"since": {
"type": "string",
"description": "when the node became so, RFC 3339; absent where the engine recorded no time for it"
},
"found": {
"type": "string",
"description": "the kind of the firewall found, for an adopted node"
},
"tunnel": {
"type": "string",
"description": "the private network's tunnel interface on this node, as the engine's filter render names it"
},
"outward": {
"type": "array",
"items": {
"type": "string"
},
"description": "the links of this node that face outside, as the engine classifies them for its filter render (ADR 0140); an allowance with no interface never opens one"
}
}
}
}
],
"events": [
@@ -1205,6 +1330,10 @@
"type": "boolean",
"description": "the move changes the build alone"
},
"run": {
"type": "string",
"description": "the composition run's pipeline sequence, in decimal, the module was applied from (design 47 H2 §813 (1), H-A-388): a restarted engine applies no older run again"
},
"kept": {
"type": "array",
"items": {
@@ -1696,7 +1825,7 @@
"description": "one finding of the observer that wrote it"
}
],
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 §2, ADR 0636 §1); today `machine.<node>.seat-list-unread`"
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 \u00a72, ADR 0636 \u00a71); today `machine.<node>.seat-list-unread`"
},
{
"name": "bounds",
@@ -1708,7 +1837,7 @@
"key": "<what>.<id>",
"value": {
"type": "object",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G §560, A-77)",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G \u00a7560, A-77)",
"properties": {
"v": {
"type": "integer",
@@ -1815,7 +1944,7 @@
},
"auto": {
"type": "boolean",
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 §4)"
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 \u00a74)"
}
},
"required": [
@@ -1825,7 +1954,7 @@
"at",
"state"
],
"description": "one act asked through the seat, as acts reads it (ADR 0563 §9)"
"description": "one act asked through the seat, as acts reads it (ADR 0563 \u00a79)"
},
"ActSaid": {
"type": "object",
@@ -1870,7 +1999,7 @@
"state",
"node"
],
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 §1)"
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 \u00a71)"
},
"Acts": {
"type": "object",
@@ -1961,7 +2090,7 @@
"at",
"why"
],
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 §4)"
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 \u00a74)"
},
"Module": {
"type": "object",
@@ -2061,7 +2190,7 @@
"why",
"judged"
],
"description": "the engine's root-free verdict (ADR 0563 §6)"
"description": "the engine's root-free verdict (ADR 0563 \u00a76)"
},
"Said": {
"type": "object",
@@ -2106,7 +2235,7 @@
},
"SeatList": {
"type": "object",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 §7)",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 \u00a77)",
"properties": {
"status": {
"type": "object",
@@ -2451,6 +2580,10 @@
"type": "string"
}
},
"declaration-reads": {
"type": "integer",
"description": "the declaration Version its engine reads (design 47 H2 §813 (12), H-A-416 (2), H-A-419): the composer writes this node's declaration at the lower of its own Version and this one, 1 when none is stated"
},
"runner-capabilities": {
"type": "array",
"items": {
@@ -3160,7 +3293,7 @@
},
"Running": {
"type": "object",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 §2), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 \u00a72), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"properties": {
"v": {
"type": "integer",
@@ -3331,6 +3464,52 @@
"step",
"since"
]
},
"CompositionDiffEntry": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "the entry: an environment entry by its name, else the part of the resource that differs"
},
"running": {
"type": "string",
"description": "its value in the running composition; absent where the running one lacks it or the value is a secret"
},
"other": {
"type": "string",
"description": "its value in the other composition; absent where the other lacks it or the value is a secret"
},
"masked": {
"type": "boolean",
"description": "the value is a secret, so neither value is given"
}
},
"description": "one entry that differs between the running composition and the other"
},
"CompositionDiffResource": {
"type": "object",
"required": [
"resource",
"entries"
],
"properties": {
"resource": {
"type": "string",
"description": "the resource, as the composition names it"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/defs/CompositionDiffEntry"
},
"description": "the entries of the resource that differ"
}
},
"description": "one resource with the entries of it that differ"
}
}
}
+7
View File
@@ -370,6 +370,13 @@ func TestTheBootstrapEqualsTheTestsSeatList(t *testing.T) {
t.Errorf("%s: bootstrap/%s.json differs from seatlisttest/seats/%s.json", b.Seat, b.Seat, b.Seat)
}
}
// Design 47 H2, H-A-452: the tests' seat list holds the seats the live list holds, the recovery seat among them, so a
// test judges a manifest against the seats the running validator judges it against.
for _, seat := range []string{"mesh-builds", "mesh-delivery-view", "mesh-grants", "mesh-pipeline-runner", "mesh-recovery"} {
if _, ok := tests[seat]; !ok {
t.Errorf("seatlisttest holds no definition of %s", seat)
}
}
}
// A host whose path for the seat's events became live after the seat spoke reads the list at once, once: a read
File diff suppressed because it is too large Load Diff
+1 -1
View File
@@ -193,7 +193,7 @@
},
{
"name": "remove",
"description": "Remove one tagged version; the holder refuses an untagged one but for the retention removal of a bundle, archive or copied base by the artifact sweep's holder. Every removal emits removed with its reason. A tagged version the store cannot remove alone, because another tag names its digest, stays whole, its tag and bytes kept: the answer says kept with the reason shared-digest and the tags still naming the digest, removed false, and kept is emitted, never removed; the caller ends there without a retry.",
"description": "Remove one tagged version; the holder refuses an untagged one but for the retention removal of a bundle, archive or copied base, which the artifact sweep's holder asks; the caller is not judged (design 47 H2 §813 (7)). Every removal emits removed with its reason. A tagged version the store cannot remove alone, because another tag names its digest, stays whole, its tag and bytes kept: the answer says kept with the reason shared-digest and the tags still naming the digest, removed false, and kept is emitted, never removed; the caller ends there without a retry.",
"input": {
"type": "object",
"properties": {
@@ -0,0 +1,563 @@
{
"format": 1,
"seat": "mesh-builds",
"scope": "mesh",
"grain": "whole",
"domain": "Delivery",
"decision": "novox/hq ADR 0666",
"description": "The builder's seat: it says each artifact it published and each agreed toolchain, and answers a module's reserved version. Held once for the mesh (design 47 G section 52, section 307).",
"verbs": [
{
"name": "reserved",
"class": "read",
"description": "A module's reserved version with each artifact's digest, for a registry holder deciding whether to publish; asked by the module or by a package's name in its ecosystem (design 47 G section 369, section 478; design 51, Publishing).",
"input": {
"type": "object",
"properties": {
"module": {
"type": "string",
"description": "the module; give this or name"
},
"name": {
"type": "string",
"description": "a package's or an image's name in its ecosystem (the Go module path, the npm name, the image name), in place of module; a name no entry carries, or more than one entry carries, is answered error naming it (design 47 G section 478, section 491)"
},
"version": {
"type": "string",
"description": "the version, when asked for a particular one"
}
},
"required": []
},
"answer": {
"type": "object",
"properties": {
"module": {
"type": "string",
"description": "the module"
},
"version": {
"type": "string",
"description": "the reserved version, MAJOR.MINOR.PATCH"
},
"artifacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifact": {
"type": "string",
"description": "the artifact reference, <module>:<artifact>"
},
"digest": {
"type": "string",
"description": "its digest once built; empty before"
}
},
"required": [
"artifact"
]
}
},
"released": {
"type": "boolean",
"description": "true when the version is released: the catalog holds it, and artifacts are the ones its release recorded with their digests; false when it is reserved (design 47 G 582, 679)"
},
"error": {
"type": "string",
"description": "a name no entry carries, or a version neither reserved nor released, naming which; set alone (design 47 G 582, 679)"
}
},
"description": "the reservation or release, or the error; module, version and artifacts are present whenever error is not (design 47 G 679)"
}
},
{
"name": "published",
"class": "read",
"description": "Whether an artifact built at a build fingerprint is published, from the builder's reservations and the registries' record, for the pipeline runner writing a mover's wait on a package: a package published before the wait was written is read, not waited for (design 47 H-A-326, H-A-328, H-A-274).",
"input": {
"type": "object",
"properties": {
"module": {
"type": "string",
"description": "the module that builds the package"
},
"artifact": {
"type": "string",
"description": "the package's artifact reference, <module>:<artifact>"
},
"fingerprint": {
"type": "string",
"description": "the build fingerprint the package is built at, which the answer is matched by"
}
},
"required": [
"module",
"artifact",
"fingerprint"
]
},
"answer": {
"type": "object",
"properties": {
"published": {
"type": "boolean",
"description": "true when the artifact built at the fingerprint is published; a number a take-over withdrew is never published (design 47 H-A-331)"
},
"version": {
"type": "string",
"description": "the version it is published at, MAJOR.MINOR.PATCH, when published"
},
"digest": {
"type": "string",
"description": "the published artifact's digest, when published; absent for a release kept before the digest was kept (design 47 H-A-331)"
},
"at": {
"type": "string",
"format": "date-time",
"description": "when the builder heard or confirmed the publish, when published; absent for a mark written before the publish time was kept (design 47 H-A-331)"
}
},
"required": [
"published"
]
}
},
{
"name": "drop",
"description": "End an ask on the seat's work queue for a caller that no longer waits for it (its step ended by its bound): one waiting is ended dropped when it is pulled, one taken is cancelled; both end the step dropped, naming who dropped it and why, so no holder works on it after (design 47 H2 §778; ADR 0664 §4).",
"input": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the ask's id"
},
"by": {
"type": "string",
"description": "who drops it"
},
"why": {
"type": "string",
"description": "why the caller no longer waits"
}
},
"required": [
"id",
"why"
]
},
"answer": {
"type": "object",
"description": "whether the ask was held here"
},
"class": "act"
}
],
"accepts": [
{
"name": "step",
"body": {
"$ref": "#/defs/StepRun"
},
"max-age": "24h",
"max-msgs": 10000,
"ack-wait": "60s",
"in-progress": "20s",
"max-ack-pending": 1000,
"max-deliveries": 5,
"duplicates-window": "2m"
}
],
"events": [
{
"name": "package-published",
"keep": {
"max-age-days": 90,
"max-mib": 128
},
"body": {
"$ref": "#/defs/PackagePublished"
}
},
{
"name": "toolchain-agreed",
"keep": {
"max-age-days": 90,
"max-mib": 16
},
"body": {
"$ref": "#/defs/ToolchainAgreed"
}
},
{
"name": "step-ended",
"subject": "step-ended.<node>",
"body": {
"$ref": "#/defs/StepEnded"
},
"keep": {
"max-age-days": 90,
"max-mib": 32
}
},
{
"name": "ask-taken",
"subject": "ask-taken.<ask>",
"body": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"description": "the ask's id"
},
"node": {
"type": "string",
"description": "the node whose holder took it"
},
"at": {
"type": "string",
"format": "date-time",
"description": "when it was taken"
}
},
"required": [
"ask",
"node",
"at"
],
"description": "the seat's holder took the ask from the seat's work queue, at the pull: only the holder says it; the runner arms the ask's bound from it (design 47 H2 §777, §778)"
}
},
{
"name": "version-reserved",
"body": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"artifact": {
"type": "string"
},
"path": {
"type": "string",
"description": "the package's path"
},
"version": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"revision": {
"type": "string",
"description": "the catalog revision the reservation was made at"
}
},
"required": [
"module",
"artifact",
"path",
"version",
"fingerprint",
"revision"
],
"description": "the builder reserved a version for a module's artifact at a fingerprint: the indexer re-pins once, at the reservation (design 47 H2 §805)"
}
}
],
"family": {
"name": "mesh-builds.events",
"max-age-days": 7
},
"defs": {
"Dependency": {
"type": "object",
"properties": {
"part": {
"type": "string",
"description": "the dependency's part: for kind 1 the package's artifact reference, <module>:<artifact>; for kind 3 the agreed toolchain's part (design 47 G 466, 673)"
},
"kind": {
"type": "integer",
"enum": [
1,
3
],
"description": "1 an imported package, 3 the build toolchain (design 47 G section 374)"
},
"version": {
"type": "string",
"description": "the version of the dependency the build resolved"
},
"digest": {
"type": "string",
"description": "the digest of the part, as the build used it"
}
},
"required": [
"part",
"kind",
"version",
"digest"
],
"description": "a dependency the build resolved: one item of kind 1 for each resolved package and one of kind 3 for the toolchain, named by the build module in its step key and carried by the builder (design 47 G 374, 673)"
},
"PackagePublished": {
"type": "object",
"properties": {
"v": {
"type": "integer"
},
"artifact": {
"type": "string",
"description": "the package's artifact reference, <module>:<artifact>, from the catalog entry"
},
"module": {
"type": "string",
"description": "the module"
},
"version": {
"type": "string",
"description": "the version the build reserved, MAJOR.MINOR.PATCH"
},
"digest": {
"type": "string",
"description": "the published artifact's digest"
},
"branch": {
"type": "string",
"description": "the watched branch the build was made from"
},
"source": {
"type": "integer",
"description": "the source revision of that branch the build was made from"
},
"revision": {
"type": "integer",
"description": "the catalog revision number of that branch the build was made from, the indexer's count (design 47 H-A-218, H-A-220); absent from a reservation made before the field"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/defs/Dependency"
},
"description": "each dependency the build resolved, with its version and digest"
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"v",
"artifact",
"module",
"version",
"digest",
"branch",
"source"
],
"description": "one artifact published at the module's reserved version (design 47 G section 52, section 334)"
},
"ToolchainAgreed": {
"type": "object",
"properties": {
"v": {
"type": "integer"
},
"language": {
"type": "string",
"description": "the language whose agreed toolchain changed"
},
"version": {
"type": "string",
"description": "the agreed toolchain's version"
},
"digests": {
"type": "array",
"description": "each digest the nodes reporting the agreed version report, as it stood when the version was agreed, with those nodes (design 47 G section 472, section 495)",
"items": {
"type": "object",
"properties": {
"digest": {
"type": "string",
"description": "the toolchain part's digest"
},
"nodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "the nodes reporting that digest"
}
},
"required": [
"digest",
"nodes"
]
}
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"v",
"language",
"version",
"digests"
],
"description": "the agreed toolchain of a language changed (design 47 G section 376, ADR 0584 section 1)"
},
"StepRun": {
"type": "object",
"description": "the build step of one module's pipeline (design 47 G section 230, A-97): the runner asks the seat mesh-builds to build a candidate's entries, each named by its fingerprint, and the builder, the one entry point for a candidate, takes the ask and answers the step's end",
"properties": {
"pipeline": {
"type": "string",
"description": "the runner's pipeline key, <branch>.<revision>.<module>, a branch escaped as a key's name is"
},
"step": {
"type": "string",
"enum": [
"build"
]
},
"branch": {
"type": "string",
"description": "the watched branch, or the branch of a run on request"
},
"revision": {
"type": "integer",
"description": "the catalog graph revision of the branch the pipeline runs for"
},
"source": {
"type": "integer",
"description": "the source revision of the watched branch; absent for a run on request"
},
"rerun": {
"type": "boolean",
"description": "the step is asked again by the runner's rerun"
},
"by": {
"type": "string",
"description": "for a rerun, the caller the runtime proved"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/defs/BuildEntry"
},
"description": "each entry the candidate's build builds, by module and fingerprint"
}
},
"required": [
"pipeline",
"step",
"branch",
"entries"
]
},
"StepEnded": {
"type": "object",
"description": "the build step's end, said by the builder on the node it runs on (design 47 G A-97; ADR 0666 section 21): the runner takes it only from that holder's account, naming the ask and each entry's fingerprint it was asked at",
"properties": {
"v": {
"type": "integer",
"description": "the layout version"
},
"id": {
"type": "string",
"description": "the ask's id"
},
"pipeline": {
"type": "string"
},
"step": {
"type": "string",
"enum": [
"build"
]
},
"node": {
"type": "string",
"description": "the node the builder ran it on, as in the subject"
},
"outcome": {
"type": "string",
"enum": [
"passed",
"failed",
"nothing to run",
"could not run"
],
"description": "never passed for a build that built nothing"
},
"said": {
"type": "string",
"description": "why it failed or could not run: the entry not built, the part not heard"
},
"rerun": {
"type": "boolean"
},
"by": {
"type": "string",
"description": "for a rerun, the caller the runtime proved"
},
"started": {
"type": "string",
"format": "date-time"
},
"ended": {
"type": "string",
"format": "date-time"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/defs/BuildEntry"
},
"description": "each entry the step built, by module and fingerprint"
},
"packages": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "the pins the step's entries were built with, each mesh package's version by its module path, the ones the builder took from the registry for a package the entry named with none included; the runner asks the entry's held test steps with them (H-A-207)"
}
},
"required": [
"id",
"pipeline",
"step",
"node",
"outcome",
"entries"
]
},
"BuildEntry": {
"type": "object",
"description": "one entry a candidate's build builds: a module at the fingerprint of its build inputs, and the commit that fingerprint was read at",
"properties": {
"module": {
"type": "string"
},
"commit": {
"type": "string"
},
"fingerprint": {
"type": "string",
"description": "the module's build-input fingerprint at the commit"
}
},
"required": [
"module",
"fingerprint"
]
}
}
}
@@ -253,6 +253,49 @@
},
"class": "read"
},
{
"name": "seat-list",
"class": "read",
"description": "The trunk's seat list as the mesh holds it, the object of the holder's objects seat-lists of that digest (design 47 H2 §814, §820; H-A-441, H-A-443): its digest and size, then its bytes (the definitions resolved, a JSON array in the form of a composer request's seats, sorted by seat) in chunks of at most 512 KiB on the chunk subject of the call, each acknowledged by the caller on the ack subject within 30 seconds. A validate run's asker fills the request's seats from these bytes. Reads only.",
"input": {
"type": "object",
"properties": {
"call": {
"type": "string",
"description": "128 random bits the caller chooses: the subject token of this send's chunks and acknowledgements",
"minLength": 1
}
},
"required": [
"call"
]
},
"answer": {
"type": "object",
"properties": {
"digest": {
"type": "string",
"description": "the seat list's sha256, the object's name in seat-lists"
},
"size": {
"type": "integer",
"minimum": 0,
"description": "the seat list's size in bytes"
},
"chunks": {
"type": "integer",
"minimum": 0,
"description": "how many chunks are sent"
}
},
"required": [
"digest",
"size",
"chunks"
]
},
"chunks": true
},
{
"name": "revision",
"description": "The catalog half of the revision view (ADR 0656 §6): one catalog graph revision with its entries whole, the trunk heads, the seat definitions by digest, and each manifest's verdict and fingerprint; the trunk's newest when no revision and no candidate is named, or a candidate's for its group and heads. Answered by the holder from what it holds, in its own runtime (ADR 0663), in pages of entries. Reads only. A watched branch with no revision yet answers {none-yet: true} alone (design 47 G section 530).",
@@ -312,7 +355,7 @@
},
{
"name": "registrations",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed.",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed. Filtered by module or repository while it reads and paged by the cursor next, at most 768 KB a page (design 47 H2 §806, §811).",
"input": {
"type": "object",
"properties": {
@@ -323,6 +366,14 @@
"history": {
"type": "boolean",
"description": "with every version of the one module"
},
"repository": {
"type": "string",
"description": "only the registrations of this repository, <owner>/<name>, applied while reading (design 47 H2 §806)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
}
},
@@ -344,6 +395,18 @@
},
"fill": {
"$ref": "#/defs/Fill"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §806)"
},
"total": {
"type": "integer",
"description": "how many registrations the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
@@ -657,6 +720,32 @@
"source": {
"type": "integer"
},
"call": {
"type": "string",
"description": "what made the revision, as the revision's call names it (design 47 H-A-212, H-A-213); absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string"
},
@@ -1448,6 +1537,13 @@
"$ref": "#/defs/Registration"
},
"description": "a module's registration"
},
{
"key": "source.<owner>.<name>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "a source-only registration of a repository with no module (design 47 H2 §815)"
}
]
},
@@ -1462,6 +1558,13 @@
"$ref": "#/defs/Registration"
},
"description": "one version of a module's registration"
},
{
"key": "source.<owner>.<name>.<version>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "one version of a source-only registration (design 47 H2 §815)"
}
]
},
@@ -1594,6 +1697,10 @@
"type": "string",
"description": "its manifest's verdict: accepted, refused or held"
},
"class": {
"type": "string",
"description": "core or leaf: core when its manifest claims a seat, leaf when it claims none; an entry without it reads as leaf (design 47 H2 H-A-394, H-A-431)"
},
"fp": {
"type": "string",
"description": "its fingerprint (src2: and 64 hex digits); absent when it has none"
@@ -1871,6 +1978,32 @@
"type": "integer",
"description": "the source revision it was taken in from; for a candidate, the source revision its heads are merged onto"
},
"call": {
"type": "string",
"description": "what made the revision (design 47 H-A-212, H-A-213): a take-in's the gate's call its source revision names, a re-pin's release of <module> <version>, a take-in again's take-in again of <repository>; absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217): a take-in's, a re-pin's on a module's release, a take-in again's, a recompute's that moved a fingerprint (its call naming the reason); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string",
"description": "a candidate's group"
@@ -1927,6 +2060,10 @@
"$ref": "#/defs/TakeInEntry"
},
"description": "the movers of the take-in that wrote it, so a redelivered source-moved whose revision is kept says take-in.taken again from them, recomputing nothing (design 47 H §743, H-A-92); absent for one with no mover"
},
"base": {
"type": "integer",
"description": "the newest kept revision of its branch below it, which the take-in that wrote it pinned for its pipeline: the base of the validate step's case before (design 47 H-A-147, H-A-151, H-A-154); absent on the branch's first take-in"
}
},
"required": [
@@ -2078,14 +2215,15 @@
},
"Registration": {
"type": "object",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve; or a source-only registration of a repository with no module (design 47 H2 §815): its origin, one watched branch, its policy and its check, naming no module and no path, kept under source.<owner>.<name>",
"properties": {
"v": {
"type": "integer",
"description": "the layout version"
},
"module": {
"type": "string"
"type": "string",
"description": "the module; absent for a source-only registration"
},
"origin": {
"type": "string",
@@ -2093,7 +2231,7 @@
},
"path": {
"type": "string",
"description": "the path of its manifest in the repository"
"description": "the path of its manifest in the repository; absent for a source-only registration"
},
"branches": {
"type": "array",
@@ -2121,12 +2259,14 @@
"at": {
"type": "string",
"format": "date-time"
},
"check": {
"$ref": "#/defs/SourceCheck",
"description": "for a source-only registration, the one step its heads run (design 47 H2 §815)"
}
},
"required": [
"module",
"origin",
"path",
"branches",
"policy"
]
@@ -2157,9 +2297,10 @@
"placed",
"review required",
"unknown module",
"nothing moves"
"nothing moves",
"holds-manifest"
],
"description": "why no ask was raised"
"description": "why no ask was raised; holds-manifest: a source-only registration whose repository holds a module.json at its root or under modules/ at the branch's head (design 47 H2 §815; H-A-450)"
},
"words": {
"type": "string",
@@ -2469,6 +2610,34 @@
"ref",
"language"
]
},
"SourceCheck": {
"type": "object",
"description": "the check of a source-only registration: a build seat and a step kind, run at the repository's root, never a free command (design 47 H2 §815)",
"properties": {
"seat": {
"type": "string",
"enum": [
"node-build-go",
"node-build-node",
"node-build-image"
],
"description": "the build seat that runs it"
},
"step": {
"type": "string",
"enum": [
"lint",
"unit",
"integration"
],
"description": "the step kind"
}
},
"required": [
"seat",
"step"
]
}
},
"bodies": {
@@ -2567,5 +2736,6 @@
"call"
]
}
}
},
"form": 5
}
@@ -0,0 +1,96 @@
{
"format": 1,
"seat": "mesh-delivery-view",
"scope": "mesh",
"grain": "whole",
"domain": "Delivery",
"decision": "novox/hq ADR 0540",
"description": "The status view of deliveries (ADR 0540): it serves no verb and says no seat event; its tools and its events delivered, moving, settled and stuck stay its holder's own, and it keeps the person's answers given in the web view.",
"states": [
{
"name": "answers",
"template": "state",
"view": true,
"history": 5,
"description": "the person's answer in the web view to an ask of the seat mesh-wants' state asks of a kind that needs no proof of who answered; only the holder writes a key, and only the holder deletes it, once the ask's key has left asks (design 47 G section 717)",
"key-forms": [
{
"key": "hold.<module>.<fingerprint>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under hold.<module>.<fingerprint> (design 47 G A-299)"
},
{
"key": "restore.<node>.<module>.<fingerprint>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under restore.<node>.<module>.<fingerprint> (design 47 G A-299)"
},
{
"key": "backup.<node>.<module>.<fingerprint>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under backup.<node>.<module>.<fingerprint> (design 47 G A-299)"
},
{
"key": "record.<node>.<module>.<digest>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under record.<node>.<module>.<digest> (design 47 G A-299)"
},
{
"key": "outside.<node>.<module>.<fingerprint>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under outside.<node>.<module>.<fingerprint> (design 47 G A-299)"
},
{
"key": "revert.<node>.<module>.<fingerprint>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under revert.<node>.<module>.<fingerprint> (design 47 G A-299)"
},
{
"key": "assignments.<proposal>.view",
"value": {
"$ref": "#/defs/Answer"
},
"description": "the status view's answer to the ask of the seat mesh-wants' state asks under assignments.<proposal> (design 47 G A-299)"
}
]
}
],
"defs": {
"Answer": {
"type": "object",
"description": "the status view's answer to an ask",
"properties": {
"v": {
"type": "integer"
},
"asking": {
"type": "string",
"description": "the asking it answers"
},
"option": {
"type": "string",
"description": "the option the person chose"
},
"words": {
"type": "string",
"description": "the person's words with it"
}
},
"required": [
"asking",
"option"
]
}
}
}
@@ -9,7 +9,7 @@
"verbs": [
{
"name": "deliveries",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group.",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group. Filtered by repository, module, outcome and since while it reads, at most 768 KB a page, capped saying the rest is read from the cursor next (design 47 H2 §811).",
"input": {
"properties": {
"all": {
@@ -31,13 +31,55 @@
"state": {
"description": "one state, e.g. delivering or held",
"type": "string"
},
"module": {
"type": "string",
"description": "only the deliveries that move this module, applied while reading (design 47 H2 §811)"
},
"outcome": {
"type": "string",
"description": "only the deliveries that ended with this outcome, applied while reading (design 47 H2 §811)"
},
"since": {
"type": "string",
"format": "date-time",
"description": "only the deliveries opened at or after this time, applied while reading (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
},
"type": "object"
},
"answer": {
"type": "object",
"description": "what deliveries answers, as its description says"
"description": "what deliveries answers, as its description says",
"properties": {
"deliveries": {
"type": "array",
"items": {
"type": "object",
"description": "one delivery's record, as the gate keeps it"
},
"description": "this page's deliveries, the open ones first, then the newest"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §811)"
},
"total": {
"type": "integer",
"description": "how many deliveries the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
"deliveries"
]
},
"class": "read"
},
@@ -196,7 +238,7 @@
"name": "record-opened",
"body": {
"type": "object",
"description": "a delivery record opened for one source revision of a merge call (design 47 H \u00a7737)",
"description": "a delivery record opened for one source revision of a merge call (design 47 H §737)",
"properties": {
"record": {
"type": "string",
@@ -319,7 +361,7 @@
"subject": "source-moved.<branch>.<source>",
"body": {
"type": "object",
"description": "a source revision of a watched branch, named once per merge call (design 47 H \u00a7737)",
"description": "a source revision of a watched branch, named once per merge call (design 47 H §737)",
"properties": {
"v": {
"type": "integer"
@@ -337,7 +379,7 @@
},
"start": {
"type": "boolean",
"description": "true only for a branch's first revision (design 47 H \u00a7768)"
"description": "true only for a branch's first revision (design 47 H §768)"
},
"heads": {
"type": "array",
@@ -448,7 +490,7 @@
},
"call": {
"type": "string",
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H \u00a7737, H-A-33)"
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H §737, H-A-33)"
}
},
"required": [
@@ -512,7 +554,7 @@
"name": "heads",
"template": "state",
"history": 1,
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H \u00a7740)",
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H §740)",
"key-forms": [
{
"key": "<repository>.<branch>",
@@ -672,5 +714,6 @@
"head"
]
}
}
},
"form": 2
}
@@ -0,0 +1,293 @@
{
"format": 1,
"seat": "mesh-grants",
"scope": "mesh",
"grain": "whole",
"domain": "Identity and access",
"decision": "novox/hq ADR 0656, ADR 0547, ADR 0636",
"description": "Who may say what on the bus: the grants part composes each module's membership, its buckets, logs and streams, the bus's user list and grants (design 47 'The grants part'). An acting part of the step grant (ADR 0656 1): an entry whose grant waits for its new version is held on its running build within the bound, said by wait-held and wait-ended; a store passing 80 % of its cap is said by filling, and back below 70 % by room; grants-for answers the grants a candidate would compose (design 47 G 331, 441).",
"acts": [
{
"step": "grant",
"on": "every"
}
],
"verbs": [
{
"name": "grants-for",
"description": "The grants a candidate would compose, per module: the grants it would add and remove against the branch's newest, each named by its subject and verb. The candidate's catalog half is taken by mesh-catalog's revision (design 47 G 441).",
"class": "read",
"input": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "the candidate's source revision"
},
"run": {
"type": "string",
"description": "or the id of a run"
},
"branch": {
"type": "string",
"description": "its watched branch"
}
},
"required": [
"branch"
],
"additionalProperties": false
},
"answer": {
"$ref": "#/defs/GrantsFor"
}
},
{
"name": "withheld",
"description": "The marked subjects withheld from each module a node's runtime carries, and why: where its tool runner does not state approval-mark/1, or its reading is not the running runner's (design 46 approval mark 6).",
"class": "read",
"input": {
"type": "object",
"properties": {
"node": {
"type": "string",
"description": "the node whose runtime's withheld subjects are asked"
}
},
"required": [
"node"
],
"additionalProperties": false
},
"answer": {
"$ref": "#/defs/Withheld"
}
}
],
"events": [
{
"name": "wait-held",
"body": {
"$ref": "#/defs/Wait"
}
},
{
"name": "wait-ended",
"body": {
"$ref": "#/defs/Wait"
}
},
{
"name": "filling",
"body": {
"$ref": "#/defs/Fill"
}
},
{
"name": "room",
"body": {
"$ref": "#/defs/Fill"
}
}
],
"family": {
"name": "mesh-grants.events",
"max-age-days": 7
},
"defs": {
"Wait": {
"type": "object",
"description": "a granting wait the grants part holds: an entry whose grant waits until the grants part's new version runs (design 47 *Each step's wait is its own part's*)",
"properties": {
"step": {
"type": "string",
"description": "the step, grant",
"enum": [
"grant"
]
},
"part": {
"type": "string",
"description": "the acting part waited for"
},
"version": {
"type": "string",
"description": "its new version's fingerprint"
},
"module": {
"type": "string",
"description": "the entry that waits"
},
"fp": {
"type": "string",
"description": "the entry's fingerprint, whose grant waits"
},
"since": {
"type": "string",
"format": "date-time"
},
"bound": {
"type": "string",
"description": "a duration such as 10m"
},
"how": {
"type": "string",
"description": "on wait-ended: ran or released",
"enum": [
"ran",
"released"
]
},
"by": {
"type": "string",
"description": "on a release, who released it and why"
},
"clock-from": {
"type": "string",
"format": "date-time",
"description": "when the new version's build was done, as the builder's build.ended says; the bound's clock starts there (design 47 G 266)"
}
},
"required": [
"step",
"part",
"version",
"module",
"since",
"bound",
"clock-from"
]
},
"Fill": {
"type": "object",
"description": "a store's fill against its cap",
"properties": {
"store": {
"type": "string",
"description": "the store"
},
"bytes": {
"type": "integer"
},
"cap": {
"type": "integer",
"description": "bytes"
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"store",
"bytes",
"cap"
]
},
"Grant": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "the bus subject"
},
"verb": {
"type": "string",
"description": "the verb or event the grant is for"
}
},
"required": [
"subject",
"verb"
]
},
"GrantsFor": {
"type": "object",
"description": "the grants a candidate would compose, per module, added and removed against the branch's newest",
"properties": {
"modules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"added": {
"type": "array",
"items": {
"$ref": "#/defs/Grant"
}
},
"removed": {
"type": "array",
"items": {
"$ref": "#/defs/Grant"
}
}
},
"required": [
"module",
"added",
"removed"
]
}
},
"error": {
"type": "string",
"description": "why it could not be answered: the catalog half of the candidate is not held"
}
}
},
"Withheld": {
"type": "object",
"description": "a node's withheld subjects, by module",
"properties": {
"node": {
"type": "string"
},
"modules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module": {
"type": "string"
},
"subjects": {
"type": "array",
"items": {
"$ref": "#/defs/WithheldSubject"
}
}
},
"required": [
"module",
"subjects"
]
}
}
},
"required": [
"node",
"modules"
]
},
"WithheldSubject": {
"type": "object",
"description": "one subject withheld, and why",
"properties": {
"subject": {
"type": "string"
},
"why": {
"type": "string"
}
},
"required": [
"subject",
"why"
]
}
}
}
@@ -135,6 +135,66 @@
"outcome"
]
}
},
{
"name": "attempt-changed",
"subject": "attempt-changed.<condition>.<attempt>",
"keep": {
"max-age-days": 7,
"max-mib": 16,
"last-per-subject": true
},
"body": {
"type": "object",
"description": "an attempt as the attempts state holds it, whole, with until, or removed: true when the healer ends it; said again for every open attempt at the healers' start (design 47 G 541, 665)",
"properties": {
"healer": {
"type": "string"
},
"condition": {
"type": "string"
},
"kind": {
"type": "string"
},
"budget-key": {
"type": "string",
"description": "what the budget counts by: the condition's key unless the healer says another"
},
"act": {
"type": "string"
},
"outcome": {
"type": "string",
"enum": [
"acting",
"acted",
"failed",
"escalated"
]
},
"said": {
"type": "string"
},
"begun": {
"type": "string",
"format": "date-time"
},
"finished": {
"type": "string",
"format": "date-time"
},
"until": {
"type": "string",
"format": "date-time",
"description": "the end of that key's lifetime, which the keeper drops the attempt at on its own clock"
},
"removed": {
"type": "boolean",
"description": "true when the healer ends the attempt"
}
}
}
}
],
"family": {
@@ -154,6 +154,39 @@
"type": "object",
"description": "what was judged or asked again"
}
},
{
"name": "placement",
"description": "Read the placements of one module as the assignments rows hold them: for each watched branch a node runs it from, the nodes that run it from there.",
"optional": true,
"input": {
"properties": {
"module": {
"description": "the module",
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"answer": {
"properties": {
"placements": {
"type": "array",
"items": {
"$ref": "#/defs/ModulePlacement"
},
"description": "one per branch and build, the nodes that run the module from it"
}
},
"required": [
"placements"
],
"type": "object"
},
"class": "read"
}
],
"events": [
@@ -190,6 +223,7 @@
{
"name": "assignments",
"template": "state",
"view": true,
"key-forms": [
{
"key": "<node>.node",
@@ -316,6 +350,13 @@
"assignments": {
"$ref": "#/defs/Assignments",
"description": "the node's assignments with the proposal laid over it; absent when the proposal takes its key away"
},
"added": {
"type": "object",
"additionalProperties": {
"$ref": "#/defs/AddedModule"
},
"description": "by module name, each module the candidate adds to this node without a want there: the `version` and `parts` the want it would write carries (design 47 G A-316); the node-engine builds such a module from this entry"
}
},
"required": [
@@ -364,6 +405,7 @@
{
"name": "seat-holders",
"template": "state",
"view": true,
"key-forms": [
{
"key": "<seat>",
@@ -1007,6 +1049,46 @@
"scope",
"holders"
]
},
"ModulePlacement": {
"type": "object",
"description": "the nodes that run a module from one watched branch",
"properties": {
"branch": {
"type": "string"
},
"build": {
"type": "string",
"description": "the fingerprint of the build these nodes run from the branch; absent, the newest delivered of the branch (design 47 H 750, H-A-39): one row per branch and build"
},
"nodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"branch",
"nodes"
]
},
"AddedModule": {
"type": "object",
"description": "what the want a candidate would write for a module carries of its build, in the want's own forms (the seat mesh-wants' state wants: `version` and `parts`; copied here because a seat definition cannot reuse another repository's seat's forms, design 47 G A-316)",
"properties": {
"version": {
"type": "string",
"description": "the module's released version, for people; none for a build of another watched branch (design 47 G section 379)"
},
"parts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "the digest of each of the module's parts, by `<module>:<artifact>` (design 47 G section 379)"
}
}
}
}
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+62 -1
View File
@@ -9,7 +9,7 @@
"verbs": [
{
"name": "get",
"description": "One secret, sealed to the public key the asker sends (the sealed box of ADR 0206), with its generation; answered only to an asker the vault allows, as the bus proved it. Never the value in the clear, and never to a private key.",
"description": "One secret, sealed to the public key the asker sends (the sealed box of ADR 0206), with its generation; answered only to an asker the vault allows, as the bus proved it, and a module's own secret put through own-put only to a process of the same module (design 47 H2 §822). Never the value in the clear, and never to a private key.",
"optional": true,
"input": {
"properties": {
@@ -640,6 +640,67 @@
"required": [
"retired"
]
},
"class": "act"
},
{
"name": "licence-put",
"description": "Hand the vault one of a licence's two secrets, its grant or its access token, from the licence manager, in two steps: name the licence by its key, the part and its generation and get a call and a key made for it; then send the call and the value sealed to that key. Keeps the newest generation and refuses an older one; says secret-changed with the secret's name and generation, never the value (novox/hq design 39 bus-and-switch §15).",
"optional": true,
"input": {
"properties": {
"call": {
"description": "the second step: the call the first step answered",
"type": "string"
},
"generation": {
"description": "the first step: the licence's generation",
"type": "number"
},
"licence": {
"description": "the first step: the licence's key",
"type": "string"
},
"part": {
"description": "the first step: grant or access",
"type": "string"
},
"sealed": {
"description": "the second step: the value sealed to the call's key — never the value",
"type": "string"
}
},
"type": "object"
},
"answer": {
"type": "object",
"description": "the holder's answer"
}
},
{
"name": "own-put",
"description": "Store a secret as the calling module's own, in two steps modelled on licence-put (design 47 H2 §822, H-A-345, H-A-349 DQ-7): name the secret and get a call and a key made for it (call, seal_to); then send the call and the value sealed to that key, and the vault keeps it under that name as the module's own, the module named by the caller's account as the bus proved it, never by an argument, keeping its newest generation only (name, generation). get answers it to a process of the same module, sealed to the process's key. The holder says each write in its journal without the value.",
"optional": true,
"input": {
"properties": {
"call": {
"description": "the second step: the call the first step answered",
"type": "string"
},
"name": {
"description": "the first step: the secret's name, among the calling module's own",
"type": "string"
},
"sealed": {
"description": "the second step: the value sealed to the call's key — never the value",
"type": "string"
}
},
"type": "object"
},
"answer": {
"type": "object",
"description": "the holder's answer: to the first step the call and the key to seal to (call, seal_to); to the second the secret's name and the generation kept (name, generation)"
}
}
],
+85 -4
View File
@@ -277,6 +277,36 @@
"run"
]
}
},
{
"name": "drop",
"description": "End an ask on the seat's work queue for a caller that no longer waits for it (its step ended by its bound): one waiting is ended dropped when it is pulled, one taken is cancelled; both end the step dropped, naming who dropped it and why, so no holder works on it after (design 47 H2 §778; ADR 0664 §4).",
"input": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the ask's id"
},
"by": {
"type": "string",
"description": "who drops it"
},
"why": {
"type": "string",
"description": "why the caller no longer waits"
}
},
"required": [
"id",
"why"
]
},
"answer": {
"type": "object",
"description": "whether the ask was held here"
},
"class": "act"
}
],
"accepts": [
@@ -284,7 +314,14 @@
"name": "step",
"body": {
"$ref": "#/defs/StepRun"
}
},
"max-age": "24h",
"max-msgs": 10000,
"ack-wait": "60s",
"in-progress": "20s",
"max-ack-pending": 1000,
"max-deliveries": 5,
"duplicates-window": "2m"
}
],
"events": [
@@ -434,7 +471,7 @@
},
{
"name": "pipeline-wanted",
"subject": "pipeline-wanted.<branch>.<source>",
"subject": "pipeline-wanted.<branch>.<revision>",
"keep": {
"max-age-days": 30,
"max-mib": 64
@@ -525,6 +562,34 @@
"at"
]
}
},
{
"name": "ask-taken",
"subject": "ask-taken.<ask>",
"body": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"description": "the ask's id"
},
"node": {
"type": "string",
"description": "the node whose holder took it"
},
"at": {
"type": "string",
"format": "date-time",
"description": "when it was taken"
}
},
"required": [
"ask",
"node",
"at"
],
"description": "the seat's holder took the ask from the seat's work queue, at the pull: only the holder says it; the runner arms the ask's bound from it (design 47 H2 §777, §778)"
}
}
],
"family": {
@@ -597,6 +662,10 @@
"type": "integer",
"minimum": 1,
"description": "the mover's tier in that pipeline's delivery order, from 1; the node-engine applies one pipeline's wants by it; absent with pipeline (design 47 H §750, §771, H-A-37)"
},
"run": {
"type": "string",
"description": "the pipeline sequence of the composition run that wrote this want, in decimal: the holder writes by compare-and-set refusing a lower run, and the node-engine applies a want again only when its run is newer than the one it applied (design 47 H2 §813 (1); H-A-355 (1))"
}
}
},
@@ -1701,6 +1770,13 @@
"verdict": {
"type": "object",
"description": "that machine's composer verdict (design 47 G §721)"
},
"unlisted": {
"type": "array",
"items": {
"type": "string"
},
"description": "the module names of the assignments left out of the machine's composition, those no watched branch's newest revision lists, written when the run starts and read by every step's judgement and by the resume (design 47 H-A-152, H-A-153)"
}
},
"required": [
@@ -1718,7 +1794,7 @@
},
"pipeline": {
"type": "string",
"description": "the runner's pipeline key, <branch>.<source>, a branch escaped as a key's name is (design 47 H §746)"
"description": "the runner's pipeline key, <branch>.<revision>, a branch escaped as a key's name is (design 47 H §746, H-A-213 (4))"
},
"branch": {
"type": "string"
@@ -1726,6 +1802,10 @@
"source": {
"type": "integer"
},
"revision": {
"type": "integer",
"description": "the pipeline's catalog revision number, the number of its key; the indexer frees the pins of that revision, not of another revision of the same source (design 47 H-A-214); absent from an older event"
},
"outcome": {
"type": "string",
"enum": [
@@ -1775,5 +1855,6 @@
"step": "place",
"on": "every"
}
]
],
"form": 2
}
@@ -45,6 +45,12 @@
"body": {
"$ref": "#/defs/StepAsk"
}
},
{
"name": "install",
"body": {
"$ref": "#/defs/StepAsk"
}
}
],
"description": "The Node build module on a node: it takes the asks of the builder and the checker, runs them as steps and answers.",
+203 -24
View File
@@ -1,11 +1,12 @@
{
"format": 1,
"form": 3,
"seat": "node-engine",
"scope": "node",
"grain": "whole",
"domain": "Core",
"decision": "novox/hq ADR 0563",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 §3, §4): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 §2).",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 \u00a73, \u00a74): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 \u00a72).",
"acts": [
{
"step": "compose",
@@ -15,7 +16,7 @@
"verbs": [
{
"name": "hand-over",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 §3, §5): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 \u00a73, \u00a75): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"input": {
"properties": {
"path": {
@@ -39,7 +40,7 @@
},
{
"name": "access-act",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 §7, ADR 0563 §3, §4), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 \u00a77, ADR 0563 \u00a73, \u00a74), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"input": {
"properties": {
"access": {
@@ -68,7 +69,7 @@
},
{
"name": "judge-directories",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 §2). Read-only: changes no owner or mode.",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 \u00a72). Read-only: changes no owner or mode.",
"input": {
"properties": {},
"type": "object"
@@ -80,7 +81,7 @@
},
{
"name": "setuid-search",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 §2); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 \u00a72); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"input": {
"properties": {
"why": {
@@ -97,7 +98,7 @@
},
{
"name": "root-free",
"description": "Whether this machine is root-free (novox/hq ADR 0259 §8, ADR 0563 §6): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"description": "Whether this machine is root-free (novox/hq ADR 0259 \u00a78, ADR 0563 \u00a76): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"input": {
"properties": {},
"type": "object"
@@ -121,7 +122,7 @@
},
{
"name": "acts",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 §9): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 \u00a79): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"input": {
"properties": {
"id": {
@@ -242,7 +243,7 @@
"type": "string"
},
"digest": {
"description": "a composition's digest (sha256:…), to read that revision rather than the latest",
"description": "a composition's digest (sha256:\u2026), to read that revision rather than the latest",
"type": "string"
},
"module": {
@@ -287,7 +288,7 @@
},
"self": {
"type": "boolean",
"description": "the node composes the module itself (ADR 0547 §2)"
"description": "the node composes the module itself (ADR 0547 \u00a72)"
},
"backup": {
"type": "string",
@@ -517,6 +518,27 @@
"withheld-unknown": {
"type": "string",
"description": "withheld unknown: the grants part does not answer, when its verb withheld did not answer"
},
"withheld-parts": {
"type": "array",
"description": "each part a compose kept because its read did not answer, with why (design 08 control-verbs \u00a74, H-A-321): for the packet filter's holder the part node-packet-filter.allowed, its filter file kept as it runs",
"items": {
"type": "object",
"required": [
"part",
"why"
],
"properties": {
"part": {
"type": "string",
"description": "the read asked, as <seat>.<verb>"
},
"why": {
"type": "string",
"description": "why it did not answer, naming the holder asked"
}
}
}
}
},
"required": [
@@ -529,6 +551,63 @@
},
"class": "read"
},
{
"name": "composition-diff",
"description": "One module's composed values read by resource (design 47 H2 \u00a7813 (3), H-A-349 DQ-12b): given a module and a revision or a digest of its composition, the entries that differ between the composition that runs and that one, per resource, environment entries by name, a secret's value masked. Read-only. Answered by this machine's engine alone.",
"class": "read",
"input": {
"type": "object",
"required": [
"module"
],
"properties": {
"module": {
"type": "string",
"description": "the module, as placed on this machine; node for the node's own"
},
"revision": {
"type": "integer",
"description": "the revision of the module's composition key to compare with, from the revisions the bucket keeps; give it or digest"
},
"digest": {
"type": "string",
"description": "the digest (sha256:\u2026) of the composition to compare with; give it or revision"
}
}
},
"answer": {
"type": "object",
"required": [
"node",
"module",
"resources"
],
"properties": {
"node": {
"type": "string",
"description": "the node"
},
"module": {
"type": "string",
"description": "the module"
},
"running": {
"type": "string",
"description": "the digest of the composition that runs; absent when nothing runs"
},
"other": {
"$ref": "#/defs/Revision"
},
"resources": {
"type": "array",
"description": "each resource with an entry that differs; empty when none differs",
"items": {
"$ref": "#/defs/CompositionDiffResource"
}
}
}
}
},
{
"name": "compose",
"description": "Compose this machine's modules now and say how it went, so a composition that failed, or a module held, recovers without a restart: what the pass refused or held, each with why, and when the engine composes again on its own after a seat that did not answer (a deadline, no responders: retried with a growing wait; a refusal never). With module, that module's apply is also tried again. Changes only what a pass the engine makes on its own would change.",
@@ -595,7 +674,7 @@
},
{
"name": "compose-candidate",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 §7). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 \u00a77). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"optional": true,
"input": {
"properties": {
@@ -640,7 +719,7 @@
"unready",
"not-judged"
],
"description": "the node's verdict (ADR 0593 §7, §9)"
"description": "the node's verdict (ADR 0593 \u00a77, \u00a79)"
},
"modules": {
"type": "array",
@@ -686,7 +765,7 @@
{
"name": "manifest-reads",
"optional": true,
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 §3) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 \u00a73) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"input": {
"type": "object",
"properties": {}
@@ -720,7 +799,7 @@
"node",
"stated-at"
],
"description": "what this machine's engine reads of a manifest (ADR 0618 §3)"
"description": "what this machine's engine reads of a manifest (ADR 0618 \u00a73)"
},
"class": "read"
},
@@ -787,7 +866,7 @@
},
{
"name": "seat-list",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 §7): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 \u00a77): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"input": {
"type": "object",
"properties": {}
@@ -798,7 +877,7 @@
},
{
"name": "seat-list-again",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 §7), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 \u00a77), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"input": {
"type": "object",
"properties": {}
@@ -1057,6 +1136,52 @@
"$ref": "#/defs/ProcessBuilds"
},
"class": "read"
},
{
"name": "converged",
"description": "The node's convergence state, which the node-engine keeps (ADR 0168, ADR 0683; design 33 control-verbs \u00a710): adopted or converged, since when it became so, for an adopted node the kind of the firewall found, and the node's links as the engine classifies them: the tunnel's interface and the outward links (design 47 H-A-325). Read-only: the holder of node-packet-filter asks it at its start and at every allow and disallow, and refuses when it does not answer.",
"class": "read",
"input": {
"type": "object",
"properties": {}
},
"answer": {
"type": "object",
"required": [
"state",
"tunnel",
"outward"
],
"properties": {
"state": {
"type": "string",
"enum": [
"adopted",
"converged"
],
"description": "the node's mode: adopted (the found firewall's terms) or converged (the mesh's own filter)"
},
"since": {
"type": "string",
"description": "when the node became so, RFC 3339; absent where the engine recorded no time for it"
},
"found": {
"type": "string",
"description": "the kind of the firewall found, for an adopted node"
},
"tunnel": {
"type": "string",
"description": "the private network's tunnel interface on this node, as the engine's filter render names it"
},
"outward": {
"type": "array",
"items": {
"type": "string"
},
"description": "the links of this node that face outside, as the engine classifies them for its filter render (ADR 0140); an allowance with no interface never opens one"
}
}
}
}
],
"events": [
@@ -1205,6 +1330,10 @@
"type": "boolean",
"description": "the move changes the build alone"
},
"run": {
"type": "string",
"description": "the composition run's pipeline sequence, in decimal, the module was applied from (design 47 H2 §813 (1), H-A-388): a restarted engine applies no older run again"
},
"kept": {
"type": "array",
"items": {
@@ -1696,7 +1825,7 @@
"description": "one finding of the observer that wrote it"
}
],
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 §2, ADR 0636 §1); today `machine.<node>.seat-list-unread`"
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 \u00a72, ADR 0636 \u00a71); today `machine.<node>.seat-list-unread`"
},
{
"name": "bounds",
@@ -1708,7 +1837,7 @@
"key": "<what>.<id>",
"value": {
"type": "object",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G §560, A-77)",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G \u00a7560, A-77)",
"properties": {
"v": {
"type": "integer",
@@ -1815,7 +1944,7 @@
},
"auto": {
"type": "boolean",
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 §4)"
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 \u00a74)"
}
},
"required": [
@@ -1825,7 +1954,7 @@
"at",
"state"
],
"description": "one act asked through the seat, as acts reads it (ADR 0563 §9)"
"description": "one act asked through the seat, as acts reads it (ADR 0563 \u00a79)"
},
"ActSaid": {
"type": "object",
@@ -1870,7 +1999,7 @@
"state",
"node"
],
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 §1)"
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 \u00a71)"
},
"Acts": {
"type": "object",
@@ -1961,7 +2090,7 @@
"at",
"why"
],
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 §4)"
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 \u00a74)"
},
"Module": {
"type": "object",
@@ -2061,7 +2190,7 @@
"why",
"judged"
],
"description": "the engine's root-free verdict (ADR 0563 §6)"
"description": "the engine's root-free verdict (ADR 0563 \u00a76)"
},
"Said": {
"type": "object",
@@ -2106,7 +2235,7 @@
},
"SeatList": {
"type": "object",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 §7)",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 \u00a77)",
"properties": {
"status": {
"type": "object",
@@ -2451,6 +2580,10 @@
"type": "string"
}
},
"declaration-reads": {
"type": "integer",
"description": "the declaration Version its engine reads (design 47 H2 §813 (12), H-A-416 (2), H-A-419): the composer writes this node's declaration at the lower of its own Version and this one, 1 when none is stated"
},
"runner-capabilities": {
"type": "array",
"items": {
@@ -3160,7 +3293,7 @@
},
"Running": {
"type": "object",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 §2), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 \u00a72), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"properties": {
"v": {
"type": "integer",
@@ -3331,6 +3464,52 @@
"step",
"since"
]
},
"CompositionDiffEntry": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "the entry: an environment entry by its name, else the part of the resource that differs"
},
"running": {
"type": "string",
"description": "its value in the running composition; absent where the running one lacks it or the value is a secret"
},
"other": {
"type": "string",
"description": "its value in the other composition; absent where the other lacks it or the value is a secret"
},
"masked": {
"type": "boolean",
"description": "the value is a secret, so neither value is given"
}
},
"description": "one entry that differs between the running composition and the other"
},
"CompositionDiffResource": {
"type": "object",
"required": [
"resource",
"entries"
],
"properties": {
"resource": {
"type": "string",
"description": "the resource, as the composition names it"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/defs/CompositionDiffEntry"
},
"description": "the entries of the resource that differ"
}
},
"description": "one resource with the entries of it that differ"
}
}
}
@@ -59,7 +59,7 @@
},
{
"name": "list",
"description": "Every entry of one directory with its type, owner, group, mode, size and, for a link, its target. At most 2000 entries; a longer directory is cut and says so. A place a secret is kept is refused by name. Read as the node's operator account, through sudo -n where its rights do not reach; a place a secret is kept, or a known credential file, is refused by name.",
"description": "Every entry of one directory with its type, owner, group, mode, size and, for a link, its target. At most 2000 entries; a longer directory is cut and says so. A place a secret is kept, at any depth beneath it, is listed too and marked secret-place: its entries, never their content; what reaches a process's memory or files (/proc/<pid>/environ, mem, fd, map_files, root, cwd) is refused by name. Read as the node's operator account, through sudo -n where its rights do not reach.",
"replaces": [
"ls",
"ls -la"
@@ -208,6 +208,44 @@
"type": "object"
}
},
{
"name": "kernel-log",
"description": "The kernel's messages (what journalctl -k gives) of this boot or an earlier one, at most 2000 lines, in a time window and narrowed to a priority and to lines holding a text when asked. A secret a line held is shown as [redacted: \u003cwhat it was\u003e].",
"replaces": [
"journalctl -k",
"journalctl -k -b -1",
"dmesg"
],
"input": {
"properties": {
"boot": {
"description": "which boot: 0 this boot (the default), -1 the one before, -2 the one before that, and so on (optional)",
"type": "string"
},
"lines": {
"description": "how many lines from the end of what matches (default 100, at most 2000)",
"type": "string"
},
"match": {
"description": "only the lines holding this text, as written — a fixed string, not a pattern (optional)",
"type": "string"
},
"priority": {
"description": "only entries this severe or more: 0-7 or emerg, alert, crit, err, warning, notice, info, debug (optional)",
"type": "string"
},
"since": {
"description": "the window's start: an RFC 3339 time (2026-10-07T09:30:00Z) or relative to now (-30min, -2h, yesterday) (optional)",
"type": "string"
},
"until": {
"description": "the window's end, in the same forms (optional; now when absent)",
"type": "string"
}
},
"type": "object"
}
},
{
"name": "failed",
"description": "Every failed unit on this machine, in the system manager and in the operator account's; a manager that does not answer is reported with its error, never as nothing failed.",
@@ -12,7 +12,7 @@
"verbs": [
{
"name": "hold",
"description": "Keep one untagged bundle, archive or copied base from removal by retention, as the artifact sweep's rules keep it (ADR 0617 \u00a72); never an image of the holder's own. Emits held.",
"description": "Keep one untagged bundle, archive or copied base from removal by retention, as the artifact sweep's rules keep it (ADR 0617 §2); never an image of the holder's own. Emits held.",
"input": {
"type": "object",
"properties": {
@@ -94,13 +94,21 @@
},
{
"name": "list",
"description": "What the store holds of one repository, or of every repository the seat holds when none is named: every manifest keeping one bundle or archive, each with its digest, whether it is an index (and the manifests an index names), the tags naming it, its size and whether it is held. Read from the store itself, so a manifest no tag names is listed too; it reads only (ADR 0632 \u00a73).",
"description": "What the store holds of one repository, or of every repository the seat holds when none is named: every manifest keeping one bundle or archive, each with its digest, whether it is an index (and the manifests an index names), the tags naming it, its size and whether it is held. Read from the store itself, so a manifest no tag names is listed too; it reads only (ADR 0632 §3). Filtered by name or module while it reads and paged by the cursor next, at most 768 KB a page, capped saying the rest is read from next (design 47 H2 §779, §811, §813 (7)).",
"input": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "the repository, <module>/<artifact>; every repository of the seat when not given"
},
"module": {
"type": "string",
"description": "only the repositories of this module, <module>/*, applied while reading (design 47 H2 §813 (7))"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
}
},
@@ -113,6 +121,18 @@
"$ref": "#/defs/Repository"
},
"description": "each repository named, in order of its name"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §811)"
},
"total": {
"type": "integer",
"description": "how many repositories the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
@@ -376,5 +396,6 @@
}
]
}
]
],
"form": 2
}
+3
View File
@@ -22,6 +22,9 @@ mesh-delivery d24d6a08905996841b62c723736339e809ca4625 modules/mesh-delivery-co
mesh-delivery 6e027de59773affe80d7bf45cf49d81292893ff1 modules/mesh-delivery-contracts/seats/mesh-delivery/seat.json, taken again as seat.json.captured (milestone 47/H1, C3)
mesh-delivery 9a55e6e8c0faa36dd96be2d90c13e5bb42be0bf3 modules/mesh-delivery-contracts/seats/git, mesh-delivery and mesh-catalog, taken again as seat.json.captured (milestone 47/H1, through C1d)
mesh-delivery d2d3ebbf44fbf0362edaf78d991615f564644615 modules/mesh-delivery-contracts/seats/git/seat.json, taken again as seat.json.captured (milestone 47/H2, D5)
mesh-contracts e6ed560e48216024a0ab6851074c134e69a9bc2b seats/node-engine/seat.json, taken again as seat.json.captured (milestone 47/H2, branch feat/47-H2, H-A-452)
mesh-delivery 80ff1afacca4c1d2e61b0e31139b140645c8088b modules/mesh-delivery-contracts/seats/mesh-delivery/seat.json, taken again as seat.json.captured (milestone 47/H2, branch feat/47-H2, H-A-452)
mesh-delivery 5e94328066198d72cf4fd5d6f1c57b6ad1c8e967 modules/mesh-delivery-contracts/seats/mesh-catalog/seat.json, taken again as seat.json.captured (milestone 47/H2, branch feat/47-H2-i, its form 5, H-A-452)
mesh-host cdcba9ca73755854d21e4e657d7e46c32b9b5265 internal/apply/placement_guard.go
The two seat copies are put back the same way (git show <commit>:<file> > <file>.captured, the path kept). To move the others, from this repository's go/ directory, with the two repositories checked out beside mesh-sdk:
@@ -1,11 +1,12 @@
{
"format": 1,
"form": 3,
"seat": "node-engine",
"scope": "node",
"grain": "whole",
"domain": "Core",
"decision": "novox/hq ADR 0563",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 §3, §4): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 §2).",
"description": "The node seat every node's engine holds (novox/hq ADR 0563, ADR 0618 \u00a73, \u00a74): its hand acts on the operator's warrant, its read-only judgements, its compositions and what it reads of a manifest. Each verb is answered on this node's subject, mesh.seat.node-engine.tool.<verb>.<node>, and each event is published on mesh.seat.node-engine.event.<event>.<node>, the node's name its last token, or, for an event whose subject names <node>, there (composed.<node>, running.<node>.<module>): the grants part grants a node's account only its own node's subjects (ADR 0363 \u00a72).",
"acts": [
{
"step": "compose",
@@ -15,7 +16,7 @@
"verbs": [
{
"name": "hand-over",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 §3, §5): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"description": "Hand a directory this machine uses as found to the mesh (novox/hq ADR 0563 \u00a73, \u00a75): the engine judges the path as it does every hand-over (absolute, as it states it, used as found, reached through no link) and refuses in words, or asks the operator on their channel at the level approve, binding the owner, group and mode it will set. Nothing changes on the call: only the operator's yes hands it over. One ask is open per path; acts shows where it stands.",
"input": {
"properties": {
"path": {
@@ -39,7 +40,7 @@
},
{
"name": "access-act",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 §7, ADR 0563 §3, §4), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"description": "Ask the operator for the take act on a library whose root holds data outside its group (novox/hq ADR 0328 \u00a77, ADR 0563 \u00a73, \u00a74), on the library's home engine: the access as declared and its root as last declared, judged and refused in words or asked at the level approve. Only the operator's yes sets the library's group, group write and setgid under its root. One ask is open per access.",
"input": {
"properties": {
"access": {
@@ -68,7 +69,7 @@
},
{
"name": "judge-directories",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 §2). Read-only: changes no owner or mode.",
"description": "Which of this machine's declared directories the engine would refuse to make or keep, one line each (novox/hq ADR 0563 \u00a72). Read-only: changes no owner or mode.",
"input": {
"properties": {},
"type": "object"
@@ -80,7 +81,7 @@
},
{
"name": "setuid-search",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 §2); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"description": "Throw away the engine's last search for setuid programs and start a full one (novox/hq ADR 0563 \u00a72); until it completes root-free answers that the machine is not judged yet. Refused while one runs, and when one was started within the hour, naming when the next may start.",
"input": {
"properties": {
"why": {
@@ -97,7 +98,7 @@
},
{
"name": "root-free",
"description": "Whether this machine is root-free (novox/hq ADR 0259 §8, ADR 0563 §6): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"description": "Whether this machine is root-free (novox/hq ADR 0259 \u00a78, ADR 0563 \u00a76): free only on the engine's own verdict, at most fifteen minutes old, that the account agents run as cannot become root without a person, and the login shell's execute not served here. Anything else is no pass, and says why. Answered by this machine's engine alone.",
"input": {
"properties": {},
"type": "object"
@@ -121,7 +122,7 @@
},
{
"name": "acts",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 §9): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"description": "Every act this machine's engine was asked through this seat (novox/hq ADR 0563 \u00a79): each hand-over, access act and setuid search, open, done or refused, with who asked, the ask and the operator's warrant. Read-only.",
"input": {
"properties": {
"id": {
@@ -242,7 +243,7 @@
"type": "string"
},
"digest": {
"description": "a composition's digest (sha256:…), to read that revision rather than the latest",
"description": "a composition's digest (sha256:\u2026), to read that revision rather than the latest",
"type": "string"
},
"module": {
@@ -287,7 +288,7 @@
},
"self": {
"type": "boolean",
"description": "the node composes the module itself (ADR 0547 §2)"
"description": "the node composes the module itself (ADR 0547 \u00a72)"
},
"backup": {
"type": "string",
@@ -517,6 +518,27 @@
"withheld-unknown": {
"type": "string",
"description": "withheld unknown: the grants part does not answer, when its verb withheld did not answer"
},
"withheld-parts": {
"type": "array",
"description": "each part a compose kept because its read did not answer, with why (design 08 control-verbs \u00a74, H-A-321): for the packet filter's holder the part node-packet-filter.allowed, its filter file kept as it runs",
"items": {
"type": "object",
"required": [
"part",
"why"
],
"properties": {
"part": {
"type": "string",
"description": "the read asked, as <seat>.<verb>"
},
"why": {
"type": "string",
"description": "why it did not answer, naming the holder asked"
}
}
}
}
},
"required": [
@@ -529,6 +551,63 @@
},
"class": "read"
},
{
"name": "composition-diff",
"description": "One module's composed values read by resource (design 47 H2 \u00a7813 (3), H-A-349 DQ-12b): given a module and a revision or a digest of its composition, the entries that differ between the composition that runs and that one, per resource, environment entries by name, a secret's value masked. Read-only. Answered by this machine's engine alone.",
"class": "read",
"input": {
"type": "object",
"required": [
"module"
],
"properties": {
"module": {
"type": "string",
"description": "the module, as placed on this machine; node for the node's own"
},
"revision": {
"type": "integer",
"description": "the revision of the module's composition key to compare with, from the revisions the bucket keeps; give it or digest"
},
"digest": {
"type": "string",
"description": "the digest (sha256:\u2026) of the composition to compare with; give it or revision"
}
}
},
"answer": {
"type": "object",
"required": [
"node",
"module",
"resources"
],
"properties": {
"node": {
"type": "string",
"description": "the node"
},
"module": {
"type": "string",
"description": "the module"
},
"running": {
"type": "string",
"description": "the digest of the composition that runs; absent when nothing runs"
},
"other": {
"$ref": "#/defs/Revision"
},
"resources": {
"type": "array",
"description": "each resource with an entry that differs; empty when none differs",
"items": {
"$ref": "#/defs/CompositionDiffResource"
}
}
}
}
},
{
"name": "compose",
"description": "Compose this machine's modules now and say how it went, so a composition that failed, or a module held, recovers without a restart: what the pass refused or held, each with why, and when the engine composes again on its own after a seat that did not answer (a deadline, no responders: retried with a growing wait; a refusal never). With module, that module's apply is also tried again. Changes only what a pass the engine makes on its own would change.",
@@ -595,7 +674,7 @@
},
{
"name": "compose-candidate",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 §7). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"description": "Compose a check's candidate on this machine in shadow, with its own sealed values and the indexer's manifest verdicts, and say per module placed here whether it composes (with its digest and whether the candidate changes it), is refused by the candidate or is held without it, each with why, and the verdict of the machine's own composition (novox/hq ADR 0593 \u00a77). Read-only: applies nothing and writes nothing. Answered by this machine's engine alone, within the asker's bound.",
"optional": true,
"input": {
"properties": {
@@ -640,7 +719,7 @@
"unready",
"not-judged"
],
"description": "the node's verdict (ADR 0593 §7, §9)"
"description": "the node's verdict (ADR 0593 \u00a77, \u00a79)"
},
"modules": {
"type": "array",
@@ -686,7 +765,7 @@
{
"name": "manifest-reads",
"optional": true,
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 §3) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"description": "The reader capabilities this machine's engine states (manifest words, forms and seat names it reads, novox/hq ADR 0618 \u00a73) and when it last stated them. An engine built before it said them states none, which a reader takes as the baseline. Read-only. Answered by this machine's engine alone.",
"input": {
"type": "object",
"properties": {}
@@ -720,7 +799,7 @@
"node",
"stated-at"
],
"description": "what this machine's engine reads of a manifest (ADR 0618 §3)"
"description": "what this machine's engine reads of a manifest (ADR 0618 \u00a73)"
},
"class": "read"
},
@@ -787,7 +866,7 @@
},
{
"name": "seat-list",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 §7): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"description": "The seat list this engine holds and what it waits for (novox/hq ADR 0636 \u00a77): each seat's source (trunk or bootstrap) and digest, the seats held from the bootstrap alone, the definitions refused, the last error and whether the seat mesh-catalog has answered. Read-only.",
"input": {
"type": "object",
"properties": {}
@@ -798,7 +877,7 @@
},
{
"name": "seat-list-again",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 §7), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"description": "Make this engine read the seat list from the seat mesh-catalog now (novox/hq ADR 0636 \u00a77), the recovery of a list unread; it answers what it holds afterwards, and the error when the read failed. A read that changed nothing still ends the engine's wait.",
"input": {
"type": "object",
"properties": {}
@@ -1057,6 +1136,52 @@
"$ref": "#/defs/ProcessBuilds"
},
"class": "read"
},
{
"name": "converged",
"description": "The node's convergence state, which the node-engine keeps (ADR 0168, ADR 0683; design 33 control-verbs \u00a710): adopted or converged, since when it became so, for an adopted node the kind of the firewall found, and the node's links as the engine classifies them: the tunnel's interface and the outward links (design 47 H-A-325). Read-only: the holder of node-packet-filter asks it at its start and at every allow and disallow, and refuses when it does not answer.",
"class": "read",
"input": {
"type": "object",
"properties": {}
},
"answer": {
"type": "object",
"required": [
"state",
"tunnel",
"outward"
],
"properties": {
"state": {
"type": "string",
"enum": [
"adopted",
"converged"
],
"description": "the node's mode: adopted (the found firewall's terms) or converged (the mesh's own filter)"
},
"since": {
"type": "string",
"description": "when the node became so, RFC 3339; absent where the engine recorded no time for it"
},
"found": {
"type": "string",
"description": "the kind of the firewall found, for an adopted node"
},
"tunnel": {
"type": "string",
"description": "the private network's tunnel interface on this node, as the engine's filter render names it"
},
"outward": {
"type": "array",
"items": {
"type": "string"
},
"description": "the links of this node that face outside, as the engine classifies them for its filter render (ADR 0140); an allowance with no interface never opens one"
}
}
}
}
],
"events": [
@@ -1205,6 +1330,10 @@
"type": "boolean",
"description": "the move changes the build alone"
},
"run": {
"type": "string",
"description": "the composition run's pipeline sequence, in decimal, the module was applied from (design 47 H2 §813 (1), H-A-388): a restarted engine applies no older run again"
},
"kept": {
"type": "array",
"items": {
@@ -1696,7 +1825,7 @@
"description": "one finding of the observer that wrote it"
}
],
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 §2, ADR 0636 §1); today `machine.<node>.seat-list-unread`"
"description": "the findings this node's engine raises about itself, one key per finding, in the layout of the seat mesh-conditions (its findings state): a key written raises the condition of the same key, a key deleted clears it (novox/hq ADR 0564 \u00a72, ADR 0636 \u00a71); today `machine.<node>.seat-list-unread`"
},
{
"name": "bounds",
@@ -1708,7 +1837,7 @@
"key": "<what>.<id>",
"value": {
"type": "object",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G §560, A-77)",
"description": "one bound a wait of the node-engine runs against, kept with its own time to live: its expiry is heard as the bus's delete marker and ends the wait (design 47 G \u00a7560, A-77)",
"properties": {
"v": {
"type": "integer",
@@ -1815,7 +1944,7 @@
},
"auto": {
"type": "boolean",
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 §4)"
"description": "the engine asked it itself, on finding a library's root holding data outside its group (ADR 0563 \u00a74)"
}
},
"required": [
@@ -1825,7 +1954,7 @@
"at",
"state"
],
"description": "one act asked through the seat, as acts reads it (ADR 0563 §9)"
"description": "one act asked through the seat, as acts reads it (ADR 0563 \u00a79)"
},
"ActSaid": {
"type": "object",
@@ -1870,7 +1999,7 @@
"state",
"node"
],
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 §1)"
"description": "what the seat says of an act: the act, the path or access, the caller as the runtime proved it and the ask (ADR 0563 \u00a71)"
},
"Acts": {
"type": "object",
@@ -1961,7 +2090,7 @@
"at",
"why"
],
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 §4)"
"description": "what a node-engine says when what it reads changed or its node returned (ADR 0618 \u00a74)"
},
"Module": {
"type": "object",
@@ -2061,7 +2190,7 @@
"why",
"judged"
],
"description": "the engine's root-free verdict (ADR 0563 §6)"
"description": "the engine's root-free verdict (ADR 0563 \u00a76)"
},
"Said": {
"type": "object",
@@ -2106,7 +2235,7 @@
},
"SeatList": {
"type": "object",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 §7)",
"description": "what an engine holds of the seat list (novox/hq ADR 0636 \u00a77)",
"properties": {
"status": {
"type": "object",
@@ -2451,6 +2580,10 @@
"type": "string"
}
},
"declaration-reads": {
"type": "integer",
"description": "the declaration Version its engine reads (design 47 H2 §813 (12), H-A-416 (2), H-A-419): the composer writes this node's declaration at the lower of its own Version and this one, 1 when none is stated"
},
"runner-capabilities": {
"type": "array",
"items": {
@@ -3160,7 +3293,7 @@
},
"Running": {
"type": "object",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 §2), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"description": "a module's build running on a node, and its health: what the node-engines of other nodes and the grants part decide a seat's pass from (ADR 0660 \u00a72), and the assigner reads a provider's and a canary's health and a put's end from (design 47 G 520); said again on the same subject each time healthy changes and for every module the have holds at the engine's start, kept last per subject with no age limit",
"properties": {
"v": {
"type": "integer",
@@ -3331,6 +3464,52 @@
"step",
"since"
]
},
"CompositionDiffEntry": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "the entry: an environment entry by its name, else the part of the resource that differs"
},
"running": {
"type": "string",
"description": "its value in the running composition; absent where the running one lacks it or the value is a secret"
},
"other": {
"type": "string",
"description": "its value in the other composition; absent where the other lacks it or the value is a secret"
},
"masked": {
"type": "boolean",
"description": "the value is a secret, so neither value is given"
}
},
"description": "one entry that differs between the running composition and the other"
},
"CompositionDiffResource": {
"type": "object",
"required": [
"resource",
"entries"
],
"properties": {
"resource": {
"type": "string",
"description": "the resource, as the composition names it"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/defs/CompositionDiffEntry"
},
"description": "the entries of the resource that differ"
}
},
"description": "one resource with the entries of it that differ"
}
}
}
@@ -253,6 +253,49 @@
},
"class": "read"
},
{
"name": "seat-list",
"class": "read",
"description": "The trunk's seat list as the mesh holds it, the object of the holder's objects seat-lists of that digest (design 47 H2 §814, §820; H-A-441, H-A-443): its digest and size, then its bytes (the definitions resolved, a JSON array in the form of a composer request's seats, sorted by seat) in chunks of at most 512 KiB on the chunk subject of the call, each acknowledged by the caller on the ack subject within 30 seconds. A validate run's asker fills the request's seats from these bytes. Reads only.",
"input": {
"type": "object",
"properties": {
"call": {
"type": "string",
"description": "128 random bits the caller chooses: the subject token of this send's chunks and acknowledgements",
"minLength": 1
}
},
"required": [
"call"
]
},
"answer": {
"type": "object",
"properties": {
"digest": {
"type": "string",
"description": "the seat list's sha256, the object's name in seat-lists"
},
"size": {
"type": "integer",
"minimum": 0,
"description": "the seat list's size in bytes"
},
"chunks": {
"type": "integer",
"minimum": 0,
"description": "how many chunks are sent"
}
},
"required": [
"digest",
"size",
"chunks"
]
},
"chunks": true
},
{
"name": "revision",
"description": "The catalog half of the revision view (ADR 0656 §6): one catalog graph revision with its entries whole, the trunk heads, the seat definitions by digest, and each manifest's verdict and fingerprint; the trunk's newest when no revision and no candidate is named, or a candidate's for its group and heads. Answered by the holder from what it holds, in its own runtime (ADR 0663), in pages of entries. Reads only. A watched branch with no revision yet answers {none-yet: true} alone (design 47 G section 530).",
@@ -312,7 +355,7 @@
},
{
"name": "registrations",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed.",
"description": "Every module's registration, or one with every version and who changed it on whose warrant (design 47 *A module's registration*). Its readers take a first view here, then hear registration-changed. Filtered by module or repository while it reads and paged by the cursor next, at most 768 KB a page (design 47 H2 §806, §811).",
"input": {
"type": "object",
"properties": {
@@ -323,6 +366,14 @@
"history": {
"type": "boolean",
"description": "with every version of the one module"
},
"repository": {
"type": "string",
"description": "only the registrations of this repository, <owner>/<name>, applied while reading (design 47 H2 §806)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
}
},
@@ -344,6 +395,18 @@
},
"fill": {
"$ref": "#/defs/Fill"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §806)"
},
"total": {
"type": "integer",
"description": "how many registrations the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
@@ -657,6 +720,32 @@
"source": {
"type": "integer"
},
"call": {
"type": "string",
"description": "what made the revision, as the revision's call names it (design 47 H-A-212, H-A-213); absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string"
},
@@ -1448,6 +1537,13 @@
"$ref": "#/defs/Registration"
},
"description": "a module's registration"
},
{
"key": "source.<owner>.<name>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "a source-only registration of a repository with no module (design 47 H2 §815)"
}
]
},
@@ -1462,6 +1558,13 @@
"$ref": "#/defs/Registration"
},
"description": "one version of a module's registration"
},
{
"key": "source.<owner>.<name>.<version>",
"value": {
"$ref": "#/defs/Registration"
},
"description": "one version of a source-only registration (design 47 H2 §815)"
}
]
},
@@ -1594,6 +1697,10 @@
"type": "string",
"description": "its manifest's verdict: accepted, refused or held"
},
"class": {
"type": "string",
"description": "core or leaf: core when its manifest claims a seat, leaf when it claims none; an entry without it reads as leaf (design 47 H2 H-A-394, H-A-431)"
},
"fp": {
"type": "string",
"description": "its fingerprint (src2: and 64 hex digits); absent when it has none"
@@ -1871,6 +1978,32 @@
"type": "integer",
"description": "the source revision it was taken in from; for a candidate, the source revision its heads are merged onto"
},
"call": {
"type": "string",
"description": "what made the revision (design 47 H-A-212, H-A-213): a take-in's the gate's call its source revision names, a re-pin's release of <module> <version>, a take-in again's take-in again of <repository>; absent for a candidate's"
},
"call-kind": {
"type": "string",
"enum": [
"take-in",
"release",
"take-in-again",
"recompute"
],
"description": "the kind of what made the revision, which a reader reads instead of call's words (design 47 H-A-213 (3), H-A-214, H-A-215, H-A-217): a take-in's, a re-pin's on a module's release, a take-in again's, a recompute's that moved a fingerprint (its call naming the reason); absent for a candidate's"
},
"module": {
"type": "string",
"description": "for call-kind release, the module released (H-A-215)"
},
"version": {
"type": "string",
"description": "for call-kind release, the version released (H-A-215)"
},
"repository": {
"type": "string",
"description": "for call-kind take-in-again, the repository taken in again (H-A-215)"
},
"group": {
"type": "string",
"description": "a candidate's group"
@@ -1927,6 +2060,10 @@
"$ref": "#/defs/TakeInEntry"
},
"description": "the movers of the take-in that wrote it, so a redelivered source-moved whose revision is kept says take-in.taken again from them, recomputing nothing (design 47 H §743, H-A-92); absent for one with no mover"
},
"base": {
"type": "integer",
"description": "the newest kept revision of its branch below it, which the take-in that wrote it pinned for its pipeline: the base of the validate step's case before (design 47 H-A-147, H-A-151, H-A-154); absent on the branch's first take-in"
}
},
"required": [
@@ -2078,14 +2215,15 @@
},
"Registration": {
"type": "object",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve",
"description": "a module's registration (ADR 0666 section 2; design 47 *A module's registration*): its git origin, its manifest's path, its watched branches and its policy, every version with who changed it and the warrant of the operator's Approve; or a source-only registration of a repository with no module (design 47 H2 §815): its origin, one watched branch, its policy and its check, naming no module and no path, kept under source.<owner>.<name>",
"properties": {
"v": {
"type": "integer",
"description": "the layout version"
},
"module": {
"type": "string"
"type": "string",
"description": "the module; absent for a source-only registration"
},
"origin": {
"type": "string",
@@ -2093,7 +2231,7 @@
},
"path": {
"type": "string",
"description": "the path of its manifest in the repository"
"description": "the path of its manifest in the repository; absent for a source-only registration"
},
"branches": {
"type": "array",
@@ -2121,12 +2259,14 @@
"at": {
"type": "string",
"format": "date-time"
},
"check": {
"$ref": "#/defs/SourceCheck",
"description": "for a source-only registration, the one step its heads run (design 47 H2 §815)"
}
},
"required": [
"module",
"origin",
"path",
"branches",
"policy"
]
@@ -2157,9 +2297,10 @@
"placed",
"review required",
"unknown module",
"nothing moves"
"nothing moves",
"holds-manifest"
],
"description": "why no ask was raised"
"description": "why no ask was raised; holds-manifest: a source-only registration whose repository holds a module.json at its root or under modules/ at the branch's head (design 47 H2 §815; H-A-450)"
},
"words": {
"type": "string",
@@ -2469,6 +2610,34 @@
"ref",
"language"
]
},
"SourceCheck": {
"type": "object",
"description": "the check of a source-only registration: a build seat and a step kind, run at the repository's root, never a free command (design 47 H2 §815)",
"properties": {
"seat": {
"type": "string",
"enum": [
"node-build-go",
"node-build-node",
"node-build-image"
],
"description": "the build seat that runs it"
},
"step": {
"type": "string",
"enum": [
"lint",
"unit",
"integration"
],
"description": "the step kind"
}
},
"required": [
"seat",
"step"
]
}
},
"bodies": {
@@ -2567,5 +2736,6 @@
"call"
]
}
}
},
"form": 5
}
@@ -9,7 +9,7 @@
"verbs": [
{
"name": "deliveries",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group.",
"description": "Every delivery not final, and those that ended in the last day, one line each: its id (owner/repository@commit), its state, its group, what it waits for and since when. Narrowed by state, repository or group. Filtered by repository, module, outcome and since while it reads, at most 768 KB a page, capped saying the rest is read from the cursor next (design 47 H2 §811).",
"input": {
"properties": {
"all": {
@@ -31,13 +31,55 @@
"state": {
"description": "one state, e.g. delivering or held",
"type": "string"
},
"module": {
"type": "string",
"description": "only the deliveries that move this module, applied while reading (design 47 H2 §811)"
},
"outcome": {
"type": "string",
"description": "only the deliveries that ended with this outcome, applied while reading (design 47 H2 §811)"
},
"since": {
"type": "string",
"format": "date-time",
"description": "only the deliveries opened at or after this time, applied while reading (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor the previous page answered, opaque; absent for the first page (design 47 H2 §779)"
}
},
"type": "object"
},
"answer": {
"type": "object",
"description": "what deliveries answers, as its description says"
"description": "what deliveries answers, as its description says",
"properties": {
"deliveries": {
"type": "array",
"items": {
"type": "object",
"description": "one delivery's record, as the gate keeps it"
},
"description": "this page's deliveries, the open ones first, then the newest"
},
"capped": {
"type": "boolean",
"description": "yes when the answer stopped at 768 KB; the rest is read from next (design 47 H2 §811)"
},
"total": {
"type": "integer",
"description": "how many deliveries the filters hold in all (design 47 H2 §811)"
},
"next": {
"type": "string",
"description": "the cursor of the next page, opaque; empty at the end (design 47 H2 §779)"
}
},
"required": [
"deliveries"
]
},
"class": "read"
},
@@ -196,7 +238,7 @@
"name": "record-opened",
"body": {
"type": "object",
"description": "a delivery record opened for one source revision of a merge call (design 47 H \u00a7737)",
"description": "a delivery record opened for one source revision of a merge call (design 47 H §737)",
"properties": {
"record": {
"type": "string",
@@ -319,7 +361,7 @@
"subject": "source-moved.<branch>.<source>",
"body": {
"type": "object",
"description": "a source revision of a watched branch, named once per merge call (design 47 H \u00a7737)",
"description": "a source revision of a watched branch, named once per merge call (design 47 H §737)",
"properties": {
"v": {
"type": "integer"
@@ -337,7 +379,7 @@
},
"start": {
"type": "boolean",
"description": "true only for a branch's first revision (design 47 H \u00a7768)"
"description": "true only for a branch's first revision (design 47 H §768)"
},
"heads": {
"type": "array",
@@ -448,7 +490,7 @@
},
"call": {
"type": "string",
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H \u00a7737, H-A-33)"
"description": "the merge call that moved it; a call the newest revision already carries writes nothing (design 47 H §737, H-A-33)"
}
},
"required": [
@@ -512,7 +554,7 @@
"name": "heads",
"template": "state",
"history": 1,
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H \u00a7740)",
"description": "each head the forge bridge's head-moved said that source.<branch> does not name for that repository; deleted when source.<branch> names it (design 47 H §740)",
"key-forms": [
{
"key": "<repository>.<branch>",
@@ -672,5 +714,6 @@
"head"
]
}
}
},
"form": 2
}
+1
View File
@@ -1,3 +1,4 @@
buscompose/nats.go: mesh-grants
catalogue/environment_into.go: node-environment
catalogue/environment_into.go: node-login-shell
catalogue/environment_into.go: node-power