diff options
Diffstat (limited to 'docs/dashboard.md')
| -rw-r--r-- | docs/dashboard.md | 41 |
1 files changed, 40 insertions, 1 deletions
diff --git a/docs/dashboard.md b/docs/dashboard.md index ec99f97..d11bf3c 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -387,6 +387,39 @@ archive retention (`replayWindow`, `archiveRetention`: epochs, an age, or both; empty, the defaults). The answer shows below: the remake's ID, or why it was refused (and the API's override, if any). The map shows the votes as they come. +## Federation + +In a swarm holding a store ([`guides/federation/`](guides/federation/README.md)), the +document box shows what counts, as this node reads it, instead of the document: its +title says `Federation`. `document` beside `remake…` shows the document underneath (the +events at `_continuum/events` and each node's protocol data), and `federation` the +federation again; the page keeps the choice. While shown, it is read every 5 s: + +* the current version, by its number and hash; the store, its checkpoint (`the root` + until the store moved to one) and how many events it took after it; the party this + node is of, and whether it votes for it by itself; +* **parties**: each party's keys and nodes, as they count, each node with its alias and + whether it is a member; +* **rules**: in order, each rule's path and who writes there; +* **values**: each place holding a value, as a tree by its path's segments, with its + value and who writes there by the rules; the field above it lists only the places + whose path holds what is typed in it; +* **proposals on version …**: each proposal on the current version, by its hash: + whether it passed, is dead, or can still pass; the parties voting `true` and `false`; + how many events propose it and how many votes are on it; and what its version changes + of the current one, a line each, as `continuum-party proposals` says it; +* **refused**: what this node refused by what it took before (keys voted twice: tell its + party), what it dropped as its operator says, and what it refused as every node does, + each with its kind and why. + +Where this node votes for its party by itself, a proposal that can still pass has `vote +true` and `vote false`: a vote through this node, by its party's record, cast on a +second click within 3 s (`vote true: sure?`), as a vote isn't taken back. The answer +shows beside them: the vote's ID, or why the node didn't cast it. Elsewhere the party +votes with its client (`continuum-party vote`), and the page says so. The page writes +no values: a party signs its writes with its key, which the page doesn't hold +(`continuum-party write`). + ## Console The messages this node exchanged with its peers, one by one: when (on the 24-hour @@ -533,4 +566,10 @@ Edits go through the store API too, as the user the page was opened as: `PUT items each on its own (`PUT /store/<path>/<index>`), a new key with `PUT /store/<path>/<key>`, an inserted item with `POST /store/<path>/<index>` (`-1` the end; an index past the end is refused), and `DELETE /store/<path>`. The dashboard itself -writes nothing to the document: only edits do. +writes nothing to the document: only edits and votes do. + +**The federation** is read through the events API: `GET /events` every 5 s, and where +the store's heads changed, `GET /events/counts`, `GET /events/refused`, and for each +proposal not read before, the first event proposing it (`GET /events/{id}`), whose +`proposal` is its version. Who writes at a place is the first rule whose path matches +it (`Version::writer`). A vote is `POST /admin/events/vote`. |
