Repository navigation
PBM-1813: Document time series logical restores in 2.17.0 - #407
Open
rasika-chivate wants to merge 9 commits into
Open
rasika-chivate wants to merge 9 commits into
rasika-chivate wants to merge 9 commits into
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Conflicting source guidance on TTL-monitor preparation timing needs human confirmation against the implementation.
Review effort: Balanced
Findings: None
What changed in this PR
Documents PBM 2.17.0 logical restore behavior for time series collections within the existing restore guidance.
Changes:
- Explains validation bypass, expiration limitations, and restore-target TTL preparation.
- Adds cross-references and updates the logical restore navigation label.
| File | Description |
|---|---|
| mkdocs-base.yml | Expands the logical restore navigation label. |
| docs/usage/restore.md | Adds time series restore guidance and warnings. |
| docs/usage/pitr-tutorial.md | Links recovery users to preparation guidance. |
| docs/features/logical.md | Summarizes validation bypass and links restore guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…://github.com/percona/pbm-docs into PBM-1813-document-time-series-restores-2.17.0
boris-ilijic
approved these changes
Oct 5, 2026
jcechace
approved these changes
Oct 6, 2026
This branch was successfully deployed
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.

Document time series logical restore behavior for PBM 2.17.0. Oplog replay bypasses document validation to avoid failures on intermediate document states, including time series backups made during sustained writes. Describe the remaining expiration limitation and preparation on the restore target.
Jira: https://perconadev.atlassian.net/browse/PBM-1813
Implementation: percona/percona-backup-mongodb#1381 (merged)
Related issue: https://perconadev.atlassian.net/browse/PBM-1763
Placement
Add "Restore time series collections" to docs/usage/restore.md before "Restore a database". Add links from docs/features/logical.md and docs/usage/pitr-tutorial.md. Update the existing logical restore navigation label in mkdocs-base.yml to include time series collections. The new section appears in the restore page's TOC; no separate page or duplicate sidebar entry is needed.
Base: main
Head: PBM-1813-document-time-series-restores-2.17.0
Validation
Source map
The target-only per-instance preparation and restoration of original settings apply the documented node-local parameter semantics. The related limitation draft in #401 remains separate; no dependency on its unmerged page anchor is introduced.
TTL-monitor timing is confirmed. Jakub corrected the September 28 PBM-1763 comment on October 5 to say "for the duration of the restore" and confirmed the correction in PBM-1813 comment 479456: https://perconadev.atlassian.net/browse/PBM-1813?focusedCommentId=479456. This agrees with the implementation PR's instruction to disable the monitor before restore. The documentation keeps it disabled throughout logical restore, including PITR, and restores each target instance's original setting afterward. Historical and rebase TTL modes discussed in Jira are proposals and are not documented as supported behavior. An earlier automated PR summary describes TTL management that is absent from the final diff; it is not used as evidence.
Latest validation: MkDocs build and git diff --check passed after applying the TTL timing clarification. Verified the rendered guidance, page TOC, numbered-step command block, and warning. Existing unrelated link warnings remain.