diff options
Diffstat (limited to 'docs/operations.md')
| -rw-r--r-- | docs/operations.md | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/docs/operations.md b/docs/operations.md index 0f906eb..4f3d6f2 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -125,20 +125,27 @@ continuum --version A node upgrades by restarting with its files. What to know: -* **The wire format.** Each change to it bumps a version byte, and nodes ignore - messages of another version. Across such a change, upgraded nodes and the others - don't talk: the swarm is split until every node is upgraded, both sides go on - writing, and they merge then. Each logs it, at warn, once per peer, naming both - versions and the node to upgrade (`Peer speaks another wire version: a newer build - (wire version 53; this one speaks 52): upgrade this node to talk with it; ignoring its - messages`, or of an older build, `upgrade that node`). With each handshake, a - node says which versions it speaks, and the newest revision of the federation it knows - (SPEAKS, outside the versions; [`peers.md`](peers.md), - [Handshake and join](peers.md#handshake-and-join)); a build from before SPEAKS, before - 0.0.1, logs it as another wire version, `version=0`, once of the peer, and reads the - peer's other messages where they are of its version. - A node speaks one version, so every change of the format is a major release; before - 1.0.0, take every upgrade as one, and upgrade all nodes close together. +* **The wire format.** Each change to it is a new version (the first byte of every + message), and a build speaks several side by side, from the oldest to the newest + `--version` names: it reads each, and writes to each node the newest both speak. A + node says which versions it speaks, and the newest revision of the federation it knows, + ahead of each proof of who it is and with each handshake (SPEAKS, outside the versions, + as are the proofs; [`peers.md`](peers.md), + [Handshake and join](peers.md#handshake-and-join)); it writes a node the oldest it + speaks until that node says. So a release whose versions meet the last one's rolls out + node by node, in any order: a release adds a version and keeps the older ones, and a + later one leaves the oldest out. A release's tag says whether it rolls out so + ([`development.md`](development.md), [Releasing](development.md#releasing)). + Nodes sharing no version don't talk: the swarm is split until every node is upgraded, + both sides go on writing, and they merge then. Each logs it, at warn, once per peer, + naming both versions and the node to upgrade (`Peer speaks another wire version: a + newer build (wire version 54; this one speaks 52): upgrade this node to talk with it; + ignoring its messages`, or of an older build, `upgrade that node`). 0.0.1 logs `Peer + speaks another wire version (another build); ignoring its messages`, with the peer's + version and its own (`ours`): upgrade the node whose version is the lower. A + build from before SPEAKS, before 0.0.1, logs SPEAKS as another wire version, + `version=0`, once of the peer, and reads the peer's other messages where they are of + its version. * **Automerge.** A remake needs every node to build the same snapshot, byte for byte, so the same Automerge version everywhere; a node with another one rejoins instead of switching ([`remakes.md`](remakes.md), [Limits](remakes.md#limits)). Don't remake while |
