aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/federation/README.md
blob: 5a443064455fd0b32674b3ab74eb75f9b6c8ecec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Guides to a federated swarm

How to start, run and use a swarm kept by parties that don't trust each other. The design
([`federation.md`](../../federation.md)) says what the rules are; these say how to live
by them, in its words.

* [`getting-started.md`](getting-started.md): two parties start a federation, write,
  read, and let a third one in.
* [`running-a-node.md`](running-a-node.md): a node's options and files, who syncs, what
  its API lets in, and joining.
* [`writing-and-reading.md`](writing-and-reading.md): places, values, what counts, why
  a write is refused, and signing again after a move.
* [`proposing-and-voting.md`](proposing-and-voting.md): writing a version, proposing it,
  voting by a record, and when a proposal passes or dies.
* [`keys.md`](keys.md): the keys a version names and those of a key set, changing them,
  and a stolen key.
* [`checkpoints.md`](checkpoints.md): what a checkpoint does, proposing and backing one,
  signing again after a move, and nodes that weren't there.
* [`when-things-go-wrong.md`](when-things-go-wrong.md): a version a node refused, a party
  that voted twice, choosing a side, and a node doing less than it should.
* [`forking-and-following.md`](forking-and-following.md): when to fork, making and
  checking a fork, and following one.
* [`promises.md`](promises.md): what holds whatever the parties do, what doesn't, and
  what that asks of a party, an operator and an application.
* [`common-changes.md`](common-changes.md): the next version, and recipes for letting a
  party in, taking one out, giving places, zones and blocks, and keys named anew.
* [`voting-by-itself.md`](voting-by-itself.md): a node voting and proposing for its party
  by its operator's rules: its key, its record, following, proposing checkpoints.
* [`refusals-and-drops.md`](refusals-and-drops.md): what a node refuses and what of it
  is its own, the store file, dropping events and taking them back.
* [`remakes.md`](remakes.md): compactions only, the electorate, the snapshot, putting
  again after a switch, two epochs for one, and rejoining.
* [`upgrades.md`](upgrades.md): upgrading the nodes of a federated swarm, and what the
  federation's number says.
* [`watching.md`](watching.md): what a node's API and its log say that needs an operator
  or a party.
* [`building-on-the-api.md`](building-on-the-api.md): an application reading what
  counts and writing as a party, through the client or with code of its own.
* [`designing-rules.md`](designing-rules.md): how rules match, namespaces, zones and
  blocks, what is nobody's by its spelling, what rules cost, and the krebs registry's.