README.md

---

Overview

An industrial-grade C++ implementation of RAFT consensus algorithm and replicated state machine based on brpc. braft is designed and implemented for scenarios demanding for high workload and low overhead of latency, with the consideration for easy-to-understand concepts so that engineers inside Baidu can build their own distributed systems individually and correctly.

It's widely used inside Baidu to build highly-available systems, such as:

• Storage systems: Key-Value, Block, Object, File ...
• SQL storages: HA MySQL cluster, distributed transactions, NewSQL systems ...
• Meta services: Various master modules, Lock services ...

Getting Started

• Build brpc which is the main dependency of braft.

• Compile braft with cmake

  $ mkdir bld && cd bld && cmake .. && make

• Play braft with examples.

• Installing from vcpkg

  You can download and install braft using the vcpkg dependency manager:

  git clone https://github.com/Microsoft/vcpkg.git
  cd vcpkg
  ./bootstrap-vcpkg.sh
  ./vcpkg integrate install
  ./vcpkg install braft

  The braft port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

Docs

• Read overview to know what you can do with braft.
• Read benchmark to have a quick view about performance of braft
• Build Service based on braft
• Access Service based on braft
• Cli tools
• Replication Model
• Consensus protocol:
  • RAFT
  • Paxos
  • ZAB
  • QJM