docs(readme): document clustering and add replication/HA roadmap - #185
Merged
Conversation
- add cluster mode to features list - expand clustering section: one-line summary, manual quickstart, full command table (INFO, NODES, SLOTS, KEYSLOT, MYID, MEET, ADDSLOTS, DELSLOTS, FORGET, SETSLOT, COUNTKEYSINSLOT, GETKEYSINSLOT, MIGRATE, RESTORE, ASKING), note on upcoming REPLICATE/FAILOVER - add cluster config flags to configuration table (--cluster-enabled, --cluster-bootstrap, --cluster-port-offset, --cluster-node-timeout) - describe cluster mode in architecture section alongside sharded and concurrent modes - update status table: phase 5 stays in progress (clients not started), add phase 6 (replication/HA) as next, brief description of what remains - update stats: 1,049 tests, ~22k LOC (~41k with tests/comments)
kacy
added a commit
that referenced
this pull request
Feb 19, 2026
- add cluster mode to features list - expand clustering section: one-line summary, manual quickstart, full command table (INFO, NODES, SLOTS, KEYSLOT, MYID, MEET, ADDSLOTS, DELSLOTS, FORGET, SETSLOT, COUNTKEYSINSLOT, GETKEYSINSLOT, MIGRATE, RESTORE, ASKING), note on upcoming REPLICATE/FAILOVER - add cluster config flags to configuration table (--cluster-enabled, --cluster-bootstrap, --cluster-port-offset, --cluster-node-timeout) - describe cluster mode in architecture section alongside sharded and concurrent modes - update status table: phase 5 stays in progress (clients not started), add phase 6 (replication/HA) as next, brief description of what remains - update stats: 1,049 tests, ~22k LOC (~41k with tests/comments)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
summary
the readme's clustering section existed but didn't explain what the cluster actually does or show how to start one manually. this PR fills in the gaps and adds the replication/HA roadmap now that the cluster module is architecturally complete.
changes:
make clustershortcut, showing--cluster-enabled,--cluster-bootstrap,CLUSTER MEET, and slot assignmentREPLICATEandFAILOVERare coming next — with a pointer to the status table--cluster-enabled,--cluster-bootstrap,--cluster-port-offset,--cluster-node-timeout)what was tested
cargo build --workspace— clean buildcargo clippy --workspace -- -D warnings— zero warningscargo fmt --check— clean (one unrelated formatting fix in integration tests included)design considerations
the manual quickstart uses
$(seq 0 5460 | tr '\n' ' ')for slot assignment. this is realistic for documentation — in practicemake clusterhandles it. the replication roadmap is kept brief in the README (one paragraph + status row) since the detailed design lives in the implementation plan.