From 6df52614fc0395fd41a8aa30ede8788148e1942d Mon Sep 17 00:00:00 2001 From: Xiang Li Date: Wed, 11 Nov 2015 09:20:25 -0800 Subject: [PATCH] raft: add more words about raft protocol --- raft/doc.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/raft/doc.go b/raft/doc.go index 6e3a1c81e..2926aa8f0 100644 --- a/raft/doc.go +++ b/raft/doc.go @@ -15,6 +15,11 @@ /* Package raft provides an implementation of the raft consensus algorithm. +Raft is a protocol by which a cluster of nodes can maintain a replicated state machine. +The state machine is kept in sync through the use of a replicated log. +For more details on Raft, you can read In Search of an Understandable Consensus Algorithm +(https://ramcloud.stanford.edu/raft.pdf) by Diego Ongaro and John Ousterhout. + Usage The primary object in raft is a Node. You either start a Node from scratch