aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/federation
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 13:41:35 +0000
committertv <tv@krebsco.de>2026-11-19 14:44:10 +0100
commit3b4d0cc4f167ca77d74110cb59c9c85276723965 (patch)
treee471f306b1e85fbedb47b75434ee31798ef7f703 /docs/guides/federation
parent9164ebfe9a4014cbbaaaff90c5a1d722e39457fd (diff)
docs: what a release's version says of upgrading to it
A release is tagged v<version>, and its version says, from the operator's side, how to upgrade to it from the release before: a patch one node at a time, fixes only (a fix to what the federation judges comes as a revision); a minor one node at a time still, adding to the API or bringing a revision the parties then pass; a major one every node close together, a flag day: no wire version both releases speak, a document, change or snapshot built otherwise, files the node can't restart with, the API or continuum-party changed other than by adding, or a new federation. Before 1.0.0 any release may be a flag day, and its tag's message says whether it is. operations.md and the federation's upgrades guide say so; a node speaking one wire version, every change of the format is a major release. architecture.md said wire formats grow by appending so that a swarm upgrades node by node, which no build does: every change bumps the version, and builds tell each other apart instead.
Diffstat (limited to 'docs/guides/federation')
-rw-r--r--docs/guides/federation/upgrades.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/guides/federation/upgrades.md b/docs/guides/federation/upgrades.md
index 55dd921..f6964a6 100644
--- a/docs/guides/federation/upgrades.md
+++ b/docs/guides/federation/upgrades.md
@@ -8,16 +8,18 @@ design's ([`federation.md`](../../federation.md),
## Upgrading continuum
A node of a federated swarm upgrades as any node does
-([`operations.md`](../../operations.md), [Upgrading](../../operations.md#upgrading)): one
-at a time, restarted with its files. Across a change of the wire format, upgraded nodes
-and the others don't talk, and the swarm is split until all are upgraded; a remake needs
-the same Automerge on every node, and one with another rejoins instead of switching. Until
-continuum's first release, take every upgrade as such a change.
+([`operations.md`](../../operations.md), [Upgrading](../../operations.md#upgrading)),
+restarted with its files, and a release's version says how: a patch or a minor release one
+node at a time, a major one every node close together. Across a change of the wire
+format, a major one, upgraded nodes and the others don't talk, and the swarm is split
+until all are upgraded; a remake needs the same Automerge on every node, and one with
+another rejoins instead of switching. Before 1.0.0, take every upgrade as a major one.
-Nobody runs every node of a federated swarm: each party's operators upgrade its nodes.
-Agree on when, among the parties, and upgrade close together. Which wire versions each
-node the parties list speaks, as far as a node heard from it, shows in
-`GET /events/counts` (`knows`, below: `wire`, the oldest and the newest).
+Nobody runs every node of a federated swarm: each party's operators upgrade its nodes. A
+patch or minor release each party takes when it likes; for a major one, agree on when,
+among the parties, and upgrade close together. Which wire versions each node the parties
+list speaks, as far as a node heard from it, shows in `GET /events/counts` (`knows`,
+below: `wire`, the oldest and the newest).
## The federation's number and its revision