Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3855 from xiang90/raft_doc

Browse Source 
raft: add more words about raft protocol
This commit is contained in:
Josh Wood 2015-11-11 09:42:32 -08:00
commit 0aa4ce0606
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
raft/doc.go
View File

@ -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