rivven-cluster 0.0.17

Distributed clustering for Rivven - SWIM membership, Raft consensus, ISR replication
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! # Rivven Cluster
//!
//! Distributed clustering for Rivven with:
//! - **SWIM Protocol**: Scalable membership and failure detection
//! - **Raft Consensus**: Metadata coordination and leader election
//! - **ISR Replication**: Partition data replication with high watermarks
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────────────────────────┐
//! │                      Rivven Node                            │
//! ├──────────────┬──────────────┬───────────────────────────────┤
//! │    SWIM      │     Raft     │       ISR Replication         │
//! │  Membership  │   Metadata   │         Data Layer            │
//! ├──────────────┼──────────────┼───────────────────────────────┤
//! │ • Node disco │ • Topics     │ • Partition leaders           │
//! │ • Health chk │ • Partitions │ • Follower fetch              │
//! │ • Failure    │ • Assignments│ • High watermark              │
//! │   detection  │ • ISR state  │ • Catch-up sync               │
//! └──────────────┴──────────────┴───────────────────────────────┘
//! ```
//!
//! ## Deployment Modes
//!
//! - **Standalone**: Single node, zero configuration, all partitions local
//! - **Cluster**: Multi-node with SWIM membership, Raft metadata, ISR replication
//!
//! ## Example Usage
//!
//! ```rust,ignore
//! use rivven_cluster::{ClusterConfig, ClusterCoordinator, TopicConfig};
//!
//! // Standalone mode (zero config)
//! let config = ClusterConfig::standalone();
//! let coordinator = ClusterCoordinator::standalone(config).await?;
//!
//! // Create a topic
//! coordinator.create_topic(TopicConfig::new("events", 6, 1)).await?;
//!
//! // Cluster mode
//! let config = ClusterConfig::cluster()
//!     .node_id("node-1")
//!     .seeds(vec!["node-2:9093", "node-3:9093"])
//!     .build();
//! let mut coordinator = ClusterCoordinator::new(config).await?;
//! coordinator.start().await?;
//! ```

pub mod config;
pub mod consumer_coordinator;
pub mod coordinator;
pub mod error;
pub mod membership;
pub mod metadata;
pub mod node;
pub mod observability;
pub mod partition;
pub mod placement;
pub mod protocol;
#[cfg(feature = "quic")]
pub mod quic_transport;
pub mod raft;
pub mod replication;
#[cfg(feature = "raft")]
pub mod storage;
pub mod transport;

// Re-export main types
pub use config::{
    ClusterConfig, ClusterMode, RaftConfig, ReplicationConfig, SwimConfig, TopicDefaults,
};
pub use consumer_coordinator::{ConsumerCoordinator, CoordinatorError, CoordinatorResult};
pub use coordinator::{ClusterCoordinator, ClusterHealth, CoordinatorState};
pub use error::{ClusterError, Result};
pub use membership::{Membership, MembershipEvent, SwimMessage};
pub use metadata::{ClusterMetadata, MetadataCommand, MetadataResponse, MetadataStore};
pub use node::{Node, NodeCapabilities, NodeId, NodeInfo, NodeState};
pub use observability::{init_metrics, ClusterMetrics, NetworkMetrics, RaftMetrics};
pub use partition::{PartitionId, PartitionState, TopicConfig, TopicState};
pub use placement::{PartitionPlacer, PlacementConfig, PlacementStrategy};
pub use protocol::{Acks, ClusterRequest, ClusterResponse};
#[cfg(feature = "quic")]
pub use quic_transport::{QuicConfig, QuicStats, QuicTransport, TlsConfig};
pub use raft::{
    hash_node_id, LogStore, NetworkFactory as RaftNetworkFactory, RaftController, RaftNode,
    RaftNodeConfig, RaftNodeId, StateMachine as MetadataStateMachine, TypeConfig as RaftTypeConfig,
};
pub use replication::{PartitionReplication, ReplicationManager};
#[cfg(feature = "raft")]
pub use storage::RedbLogStore;
pub use transport::{Transport, TransportConfig};

/// Re-export common types
pub mod prelude {
    pub use crate::config::*;
    pub use crate::coordinator::*;
    pub use crate::error::*;
    pub use crate::node::*;
    pub use crate::partition::*;
    pub use crate::protocol::Acks;
    pub use crate::raft::RaftController;
}