Skip to content

Commit da0ff35

Browse files
committed
adminguide: document Raft upgrading process
1 parent d392d62 commit da0ff35

File tree

2 files changed

+165
-115
lines changed

2 files changed

+165
-115
lines changed

docs/adminguide.asciidoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,6 +519,20 @@ The `robustirc-removepeer` tool has safety checks in place to make sure that
519519
the network can still reach quorum after removing the node you ask it to
520520
remove.
521521

522+
=== Upgrading to the Raft protocol version 3 ===
523+
524+
Since RobustIRC was released, the `hashicorp/raft` package which RobustIRC is
525+
using has introduced a new protocol version.
526+
527+
To upgrade your network from Raft protocol version 1 (the default) to version 3
528+
(the new version), use the following steps:
529+
530+
1. Ensure the RobustIRC binary is recent enough: on the status page, it should
531+
list “protocol_version” in the “Raft Stats” column.
532+
2. Take down one node. Bring it back up again with the
533+
`-raft_protocol_version=2` flag. Repeat until all nodes are on version 2.
534+
3. Repeat step 1 with `-raft_protocol_version=3`.
535+
522536
=== Healing partitions ===
523537

524538
In case your network becomes partitioned, you have two options:

0 commit comments

Comments
 (0)