Expand description
§Openraft Document
If you’re starting to build an application with Openraft, check out
To maintain an Openraft cluster, e.g., add or remove nodes, refer to
cluster_control
:cluster_formation
describes how to form a cluster;dynamic membership
describes how to add or remove nodes without downtime;node lifecycle
describes the transition of a node’s state;
When upgrading an Openraft application, consult:
To learn about the data structures used in Openraft and the commit protocol, see
feature_flags
;data
:Vote
is the core in a distributed system;Log pointers
shows how Openraft tracks entries in the log;Leader lease
explains leader lease for a Leader and a Follower;Extended membership
explains how members are organized in Openraft;Effective membership
explains when membership config takes effect;
components
explains the components in Openraft;RaftStateMachine
is the core API for managing the state machine and snapshot functionalities;
protocol
:
Contributors who want to understand the internals of Openraft can find relevant information in
internal
:- Architecture shows the overall architecture of Openraft;
- Threading describes the threading model of Openraft;
Finally, the archived and discarded documents:
obsolete
describes obsolete design documents and why they are discarded;
Modules§
- Managing Clusters: Adding/Removing Nodes
- Components and sub systems of the openraft project.
- Data structures used by the Openraft protocol, such log, vote, snapshot, membership etc.
- FAQ
- Feature flags
- Getting Started with Openraft
- Openraft internal design and implementation
- Obsolete Designs
- The protocol used by Openraft to replicate data.
- Guide for upgrading from older version Openraft