Reference | QuorumKit

📄️ Public API overview

QuorumKit has two sets of public headers. Both are installed with the library.

This page is the normative contract for the include/braft/ surface.

This page is the normative contract for mixed-version clusters and tooling that speak the legacy braft wire protocol.

This page is the normative contract for storage backends in QuorumKit.

This page defines the backend-neutral representation used to bootstrap one storage backend family from another.

This page defines how QuorumKit decides whether two storage states are equivalent enough for bootstrap, dual write, cutover, and rollback.

This page defines what QuorumKit means by a supported rolling migration.

Top level

Canonical API -- The QuorumKit public headers under include/quorumkit/. New code should target this surface.

Three example programs live under examples/. Each one is a self-contained replicated service that you can build and run locally.