Embeddable Java Raft

Java Raft for metadata and coordination.

Embed a CP core inside your Java service when metadata, coordination, or lock state must stay strongly consistent.

  • Embeddable library, not a turnkey data platform
  • You keep control over transport, persistence, and failure behavior
Start Documentation Open Setup Read the FAQ See Use Cases
Fastest path to first signal

Quick Start

Run one local test to see leader election, quorum, and commit behavior from the repository root.

Command Gradle test target 
./gradlew :microraft-tutorial:test \
  --tests io.microraft.tutorial.OperationCommitTest
Java 11 build target 3-node local tutorial
Quorum + commit flow

Start here

Use this order if you are seeing MicroRaft for the first time.

1

Run a local test

Verify the local 3-node flow first.

Open guide 2

Learn the abstractions

Move to Main Abstractions and the atomic register tutorial.

Open guide 3

Check rollout readiness

Use monitoring, troubleshooting, and rollout guidance before production.

Open checklist

What you can build

These are the clearest fits for an embeddable Java Raft core.

Metadata stores

Keep shard maps, ownership records, and cluster metadata strongly consistent.

View recipe

Coordination services

Drive control-plane decisions, registrations, elections, and state transitions with ordered commits.

View recipe

Distributed locks

Build fencing-token-based lock services with explicit consistency and failure semantics.

View recipe

Use MicroRaft when

  • you need a CP core inside a Java service
  • you want to own transport and persistence
  • you care about explicit failure semantics

Choose your next read

Move from fit to rollout only when you need that level of detail.

Decide if it fits

Read the positioning, tradeoffs, and use-case guidance before you commit to an embeddable CP core.

Open guide

Read the FAQ

Get short answers on fit, scope, and what MicroRaft is not.

Open FAQ

Open the production checklist

Validate persistence, observability, transport, and failure handling before rollout.

Open checklist

Browse source and Javadoc

Go straight to GitHub and Javadoc when you want implementation detail instead of onboarding guidance.

Open source and API