async-raft - GitLite

KO | EN

gitlite — search

#python #golang #rust #linux #nodejs #macos #windows #awesome #awesome-list #vue #pytorch #ios #mcp #openai

async-raft

(★ 1,092)

An implementation of the Raft distributed consensus protocol using the Tokio framework.

File Explorer

Download Latest Version (.zip)

- - ci.yaml
  - pages.yaml
  - release-memstore.yaml
  - release-raft.yaml
- pull_request_template.md
- - config.rs
  - error.rs
  - lib.rs
  - metrics.rs
  - network.rs
  - raft.rs
  - storage.rs
- - client_reads.rs
  - client_writes.rs
  - compaction.rs
  - current_leader.rs
  - dynamic_membership.rs
  - initialization.rs
  - non_voter_restart.rs
  - shutdown.rs
  - singlenode.rs
  - stepdown.rs
- Cargo.toml
- README.md
- - cluster-controls.md
  - cluster-formation.md
  - dynamic-membership.md
  - get-to-it.md
  - getting-started.md
  - metrics.md
  - network.md
  - overview.md
  - putting-it-all-together.md
  - raft.md
  - storage.md
  - SUMMARY.md
- - lib.rs
  - test.rs
- Cargo.toml
- README.md
.gitignore
book.toml
Cargo.toml
CHANGELOG.md
clippy.toml
CONTRIBUTING.md
LICENSE-APACHE
LICENSE-MIT
raft-essentials.md
README.md
rustfmt.toml

# Installation Guide

1. Get the code

git clone https://github.com/async-raft/async-raft

Downloads the entire project code from GitHub to your computer.

cd async-raft

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">async raft</h1>
<div align="center">
    <strong>
        An implementation of the <a href="https://raft.github.io/">Raft distributed consensus protocol</a> using <a href="https://tokio.rs/">the Tokio framework</a>. Please ⭐ on <a href="https://github.com/async-raft/async-raft">github</a>!
    </strong>
</div>
<br/>
<div align="center">

[![Build Status](https://github.com/async-raft/async-raft/workflows/ci/badge.svg?branch=master)](https://github.com/async-raft/async-raft/actions)
[![Discord Chat](https://img.shields.io/discord/845414467234693170?logo=discord&style=flat-square)](https://discord.gg/DYSDaBjwaA)
[![Crates.io](https://img.shields.io/crates/v/async-raft.svg)](https://crates.io/crates/async-raft)
[![docs.rs](https://docs.rs/async-raft/badge.svg)](https://docs.rs/async-raft)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)](https://raw.githubusercontent.com/async-raft/async-raft/master/LICENSE)
![Crates.io](https://img.shields.io/crates/d/async-raft.svg)
![Crates.io](https://img.shields.io/crates/dv/async-raft.svg)

</div>
<br/>

Blazing fast Rust, a modern consensus protocol, and a reliable async runtime — this project intends to provide a consensus backbone for the next generation of distributed data storage systems (SQL, NoSQL, KV, Streaming, Graph ... or maybe something more exotic).

[The guide](https://async-raft.github.io/async-raft) is the best place to get started, followed by [the docs](https://docs.rs/async-raft/latest/async_raft/) for more in-depth details.

This crate differs from other Raft implementations in that:
- It is fully reactive and embraces the async ecosystem. It is driven by actual Raft events taking place in the system as opposed to being driven by a `tick` operation. Batching of messages during replication is still used whenever possible for maximum throughput.
- Storage and network integration is well defined via two traits `RaftStorage` & `RaftNetwork`. This provides applications maximum flexibility in being able to choose their storage and networking mediums. See the [storage](https://async-raft.github.io/async-raft/storage.html) & [network](https://async-raft.github.io/async-raft/network.html) chapters of the guide for more details.
- All interaction with the Raft node is well defined via a single public `Raft` type, which is used to spawn the Raft async task, and to interact with that task. The API for this system is clear and concise. See the [raft](https://async-raft.github.io/async-raft/raft.html) chapter in the guide.
- Log replication is fully pipelined and batched for optimal performance. Log replication also uses a congestion control mechanism to help keep nodes up-to-date as efficiently as possible.
- It fully supports dynamic cluster membership changes according to the Raft spec. See the [`dynamic membership`](https://async-raft.github.io/async-raft/dynamic-membership.html) chapter in the guide. With full support for leader stepdown, and non-voter syncing.
- Details on initial cluster formation, and how to effectively do so from an application's perspective, are discussed in the [cluster formation](https://async-raft.github.io/async-raft/cluster-formation.html) chapter in the guide.
- Automatic log compaction with snapshots, as well as snapshot streaming from the leader node to follower nodes is fully supported and configurable.
- The entire code base is [instrumented with tracing](https://docs.rs/tracing/). This can be used for [standard logging](https://docs.rs/tracing/latest/tracing/index.html#log-compatibility), or for [distributed tracing](https://docs.rs/tracing/latest/tracing/index.html#related-crates), and the verbosity can be [statically configured at compile time](https://docs.rs/tracing/latest/tracing/level_filters/index.html) to completely remove all instrumentation below the configured level.

This implementation strictly adheres to the [Raft spec](https://raft.github.io/raft.pdf) (*pdf warning*), and all data models use the same nomenclature found in the spec for better understandability. This implementation of Raft has integration tests covering all aspects of a Raft cluster's lifecycle including: cluster formation, dynamic membership changes, snapshotting, writing data to a live cluster and more.

If you are building an application using this Raft implementation, open an issue and let me know! I would love to add your project's name & logo to a users list in this project.

### contributing
Check out the [CONTRIBUTING.md](https://github.com/async-raft/async-raft/blob/master/CONTRIBUTING.md) guide for more details on getting started with contributing to this project.

### license
async-raft is licensed under the terms of the MIT License or the Apache License 2.0, at your choosing.

----

**NOTE:** the appearance of the "section" symbols `§` throughout this project are references to specific sections of the Raft spec.