Skip to content

Update the backup-and-recovery guide for crash-safe restores and the 5.4 peer refusal - #794

Merged
kriszyp merged 4 commits into
mainfrom
docs/restore-publication-protocol
Nov 5, 2026
Merged

kriszyp merged 4 commits into
mainfrom
docs/restore-publication-protocol

Conversation

@cb1kenobi

@cb1kenobi cb1kenobi commented Nov 3, 2026 •

Copy link
Copy Markdown
Member
The author updating the restore manual at a library lectern

⊙ Problem

Publish every restore_backup through one crash-safe protocol (harper#3920) changes what restore_backup does in 5.4. The backup-and-recovery guide still says target_database needs the server stopped and that an interrupted restore always leaves the database unloadable. Its replicated-cluster runbook would also now fail, because a restore refuses to run while the node lists peers.

The v5 reference and the 5.4 release notes have moved into harper's docs/, so this PR's reference and release-note changes now ship in harper#3920 itself. Only the Learn guide, which stays in this repo, is left here.

❓ Your call: is a runbook step that removes the node's peers the right guidance?

harper#3920 refuses a restore while system.hdb_nodes or replication.routes names a peer, even one the network has isolated. The runbook now says to remove the node's peers before restoring and add them back at re-entry. The alternative is to document an override, which the code does not have.

💡 Solution

  • The restore constraints now say that target_database works online as of v5.4.0, what an interrupted restore leaves (as it was, restored, or blocked), and that a restore refuses on a node with replication peers.
  • Step 2 of the in-place recovery runbook removes the node's peers before restoring, and step 6 adds them back before replication reconnects.

✅ Verification

  • Every new claim was checked against harper#3920's code: the fence, startup recovery and the peer census.
  • Two review rounds (Codex, Gemini and the Harper domain pass) converged on the original four-page change; their findings are fixed.
  • The trimmed branch differs from main only in this page.

🤖 Generated with Claude Code

Related PRs: #788 overlaps (moved the reference and 5.4 notes this PR used to edit into harper; those edits now ship in harper#3920)
Complexity: easy

Review-Coverage: authored=claude; ran=gemini,codex; adjudicated=domain; blocked=cursor-composer(auth); declined=cursor-grok,muse; rounds=2; full=1 @ 8e3b081

Review-Attention: skim ~2m (decisions: peer-refusal-guidance, restore-option-scope) @ 8e3b081

cb1kenobi and others added 3 commits November 3, 2026 11:36
… new restore_backup options for 5.4

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ers, stale limitations and 5.4 release notes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for database backup and recovery operations to align with the v5.4.0 release. The changes cover online restores using target_database, replication peer restrictions, pre-copy verification checks, crash survival behaviors, and new parameters like accept_incompatible_backup. The review feedback recommends formatting adjustments for the <VersionBadge> component, advising against its mid-sentence usage in prose and correcting its type attribute for new features.

Comment thread reference/backups/operations.md Resolved
Comment thread reference/backups/operations.md Resolved
Comment thread reference/backups/operations.md Resolved
@github-actions
github-actions Bot temporarily deployed to pr-794 November 3, 2026 18:04 Inactive
@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-794

This preview will update automatically when you push new commits.

@kriszyp

kriszyp commented Nov 5, 2026

Copy link
Copy Markdown
Member

Heads-up: the v5 reference and the 5.4 release notes now live in the code repos (documentation#788, harper#3944, harper-pro#1237). reference/ and release-notes/v5-lincoln/5.4.md no longer exist on main here, so this PR's changes to them need to move. Thanks for your patience with the shuffle!

  • Reference pages go to docs/reference/ at the same relative path, in HarperFast/harper (in HarperFast/harper-pro for replication/, web-application-firewall/, and the Pro sections of core pages, which are _pro-*.md partials there).
  • 5.4 release notes become one fragment file per change in docs/release-notes/v5-lincoln/5.4/ of the repo the change ships in. The fragment format is in harper's docs/README.md.
  • If the code change this documents is still in an open PR, the docs can go in that same PR now; no companion PR needed.
  • Changes to other files here (learn/, fabric/, the v4 reference) stay in this repo.

— Claude Opus 5.5

…rper's docs/

The reference and release-note changes this branch carried moved to HarperFast/harper#3920, which carries its own docs since the v5 reference moved into harper. Only the Learn page change stays here.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cb1kenobi cb1kenobi changed the title Document crash-safe restores, the restore proof and peer refusal, and the new restore_backup options for 5.4 Update the backup-and-recovery guide for crash-safe restores and the 5.4 peer refusal Nov 5, 2026
@github-actions
github-actions Bot temporarily deployed to pr-794 November 5, 2026 05:49 Inactive
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-794

This preview will update automatically when you push new commits.

@cb1kenobi
cb1kenobi marked this pull request as ready for review November 5, 2026 17:40
@cb1kenobi
cb1kenobi requested a review from a team as a code owner November 5, 2026 17:40
@kriszyp
kriszyp merged commit 0b23a24 into main Nov 5, 2026
18 checks passed
@kriszyp
kriszyp deleted the docs/restore-publication-protocol branch November 5, 2026 17:41
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

This branch was previously deployed

1 inactive deployment
pr-794 — 8e3b081e Deployed Nov 5, 2026 by github-actions[bot]
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.

2 participants