Skip to content

docs: add resumable transfer (checkpoint) limitation documentation#1023

Merged
suxb201 merged 2 commits intov4from
readme
Mar 2, 2026
Merged

docs: add resumable transfer (checkpoint) limitation documentation#1023
suxb201 merged 2 commits intov4from
readme

Conversation

@suxb201
Copy link
Member

@suxb201 suxb201 commented Mar 2, 2026

Summary

  • Add documentation clarifying that RedisShake 4.x does not support resumable transfer (checkpoint) or cluster topology change awareness
  • Explain the complexity of implementing production-grade checkpoint (requires Redis + tool + components cooperation)
  • Recommend commercial products (DTS, Tair Global Active-Active) for long-term sync scenarios
  • Clarify RedisShake is best suited for one-time data migration

Changes

  • README.md: Add two limitation points (checkpoint + topology awareness)
  • docs/src/zh/others/checkpoint.md: New article explaining checkpoint limitations (Chinese)
  • docs/src/en/others/checkpoint.md: New article explaining checkpoint limitations (English)
  • docs/src/zh/guide/mode.md: Add brief reference to checkpoint article
  • docs/src/en/guide/mode.md: Add brief reference to checkpoint article
  • docs/.vitepress/zh.ts: Add sidebar navigation entry
  • docs/.vitepress/en.ts: Add sidebar navigation entry

Related Issues

Addresses common questions from users about resumable transfer support.

🤖 Generated with Claude Code

suxb201 and others added 2 commits March 2, 2026 11:13
RedisShake 4.x does not support resumable transfer or cluster topology
change awareness. This commit adds documentation to clarify these
limitations.

Changes:
- README: Split limitations into two points (checkpoint + topology)
- Add dedicated checkpoint.md in zh/en others/ folder
- Update mode.md to reference the new checkpoint article
- Add sidebar navigation entries for checkpoint

Key points:
- Explains what resumable transfer is with examples (DTS, Tair Global Active-Active)
- Clarifies that production-grade checkpoint requires Redis + tool + components cooperation
- RedisShake alone cannot achieve robust checkpoint
- Best suited for one-time migration; use DTS/Global Active-Active for long-term sync

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add more detailed logging to help diagnose intermittent CI failures
in wait_for_sync(), specifically when marker key deletion times out.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@suxb201 suxb201 merged commit c18db27 into v4 Mar 2, 2026
10 checks passed
@suxb201 suxb201 deleted the readme branch March 2, 2026 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant