#raft #distributed-systems #ha

raft

The rust language implementation of Raft algorithm

5 releases (3 breaking)

0.3.1 Jul 12, 2018
0.3.0 Jun 11, 2018
0.2.0 May 14, 2018
0.1.0 Feb 26, 2018
0.0.0 Jun 17, 2015

#42 in Algorithms

Download history 191/week @ 2018-05-05 74/week @ 2018-05-12 417/week @ 2018-05-19 77/week @ 2018-05-26 30/week @ 2018-06-02 20/week @ 2018-06-09 305/week @ 2018-06-16 266/week @ 2018-06-23 479/week @ 2018-06-30 239/week @ 2018-07-07 340/week @ 2018-07-14 509/week @ 2018-07-21 338/week @ 2018-07-28

1,058 downloads per month

Raft

Build Status Documentation

Problem and Importance

When building a distributed system one principal goal is often to build in fault-tolerance. That is, if one particular node in a network goes down, or if there is a network partition, the entire cluster does not fall over. The cluster of nodes taking part in a distributed consensus protocol must come to agreement regarding values, and once that decision is reached, that choice is final.

Distributed Consensus Algorithms often take the form of a replicated state machine and log. Each state machine accepts inputs from its log, and represents the value(s) to be replicated, for example, a hash table. They allow a collection of machines to work as a coherent group that can survive the failures of some of its members.

Two well known Distributed Consensus Algorithms are Paxos and Raft. Paxos is used in systems like Chubby by Google, and Raft is used in things like tikv or etcd. Raft is generally seen as a more understandable and simpler to implement than Paxos.

Design

Raft replicates the state machine through logs. If you can ensure that all the machines have the same sequence of logs, after applying all logs in order, the state machine will reach a consistent state.

A complete Raft model contains 4 essential parts:

  1. Consensus Module, the core consensus algorithm module;

  2. Log, the place to keep the Raft logs;

  3. State Machine, the place to save the user data;

  4. Transport, the network layer for communication.

The design of the Raft crate

Note: This Raft implementation in Rust includes the core Consensus Module only, not the other parts. The core Consensus Module in the Raft crate is customizable, flexible, and resilient. You can directly use the Raft crate, but you will need to build your own Log, State Machine and Transport components.

Developing the Raft crate

raft is intended to track the latest stable, though you'll need to use nightly to simulate a full CI build with clippy.

Using rustup you can get started this way:

rustup override set stable
rustup toolchain install nightly

In order to have your PR merged running the following must finish without error:

cargo +nightly test --features dev

You may optionally want to install cargo-watch to allow for automated rebuilding while editing:

cargo watch -s "cargo check --features dev"

If proto file eraftpb.proto changed, run the command to regenerate eraftpb.rs:

protoc proto/eraftpb.proto --rust_out=src

You can check Cargo.toml to find which version of protobuf-codegen is required.

Acknowledgments

Thanks etcd for providing the amazing Go implementation!

Projects using the Raft crate

  • TiKV, a distributed transactional key value database powered by Rust and Raft.

Links for Further Research

Apache-2.0 license

Dependencies

Reverse deps