Repository navigation
PCSM-295: Document finalization after source loss - #86
rasika-chivate wants to merge 19 commits into
Conversation
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Documents existing finalization behavior when the source cluster is lost (PCSM 1.1.0), emphasizing that finalization can succeed without guaranteeing the target is fully caught up, and pointing users to prerequisite checks and a step-by-step procedure.
Changes:
- Added a limitation describing why finalization after source loss can’t guarantee complete data.
- Added a new “Finalize after losing the source cluster” procedure with warnings and specific status fields to review.
- Added an FAQ entry that links to the procedure and summarizes the risk/requirements.
| File | Description |
|---|---|
| docs/limitations.md | Adds an explicit limitation + link to the detailed procedure. |
| docs/install/usage.md | Introduces a new procedural section with warnings, prerequisites, and follow-up checks. |
| docs/faq.md | Adds a user-facing Q&A summarizing the behavior and linking to the procedure. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Adnan <[email protected]>
Co-authored-by: Adnan <[email protected]>
|
Checked the actual content against all review comments, including those already marked resolved. Completed the remaining gaps in three separate commits.
Validation: MkDocs build, GitHub Vale passed. The limitations link raised by Copilot was already correct; verified its rendered destination and anchor, so |
There was a problem hiding this comment.
🔵 Needs a closer look
SME confirmation is needed for PCSM 1.1.0 source-unavailable startup and index-recovery claims affecting data-loss decisions, because linked testing and implementation evidence is unavailable and existing API documentation does not establish those behaviors.
No open issues 🎉
Review effort: Balanced
Co-authored-by: Adnan <[email protected]>
Co-authored-by: Adnan <[email protected]>

Documents existing finalization behavior after source loss for PCSM 1.1.0. Initial sync must be complete. Users can finalize and use the target, but finalization cannot establish that all source changes reached it.
Jira: https://perconadev.atlassian.net/browse/PCSM-295
Changes and placement
docs/install/usage.md: adds Finalize after losing the source cluster under Finalize the replication, before finalization status. Includes missing-data warning, initial-sync and progress checks, pause caveat, and links to finalization/index checks.docs/limitations.md: adds Finalization after source loss with a link to the procedure.docs/faq.md: adds Can I use the target if the source cluster goes down? beside the failure-handling answer.Existing pages remain in navigation. New headings appear automatically in page TOCs; no new navigation section or page is needed, so
mkdocs-base.ymlis unchanged.Claim-to-source map
docs/api.mdGET /status and POST /finalize;docs/install/usage.mdfinalization sections;docs/multiple-targets.mdcompletion checks on mainNo feature implementation PR is linked in the ticket. This is a documentation-only clarification based on recorded tests and SME guidance. No claims about guaranteed data loss size, timing, or freshness are made.
Validation
git diff --checkpassed; complete diff reviewed.mkdocs buildpassed using the existing documentation dependencies.about-docs.mdforreference/contributing.md.