Skip to content

PBM-1813: Document time series logical restores in 2.17.0 - #407

Open
rasika-chivate wants to merge 9 commits into
mainfrom
PBM-1813-document-time-series-restores-2.17.0
Open

rasika-chivate wants to merge 9 commits into
mainfrom
PBM-1813-document-time-series-restores-2.17.0

Conversation

@rasika-chivate

@rasika-chivate rasika-chivate commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

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

  • git diff --check passed.
  • Standard mkdocs build passed.
  • Checked rendered heading and page TOC, sidebar label, warning, and both new cross-references.
  • Existing unrelated missing-link warning in docs/about-docs.md remains. No new navigation warning remains.
  • Reviewed applicable headings, paragraphs, callouts, and link rules in percona/doc-style-guide.

Source map

Claim Evidence
Restore failure on time series backups made during sustained writes PBM-1813 description and reproduction, https://perconadev.atlassian.net/browse/PBM-1813
Version 2.17.0 PBM-1813 fixVersions
Replay bypasses document validation without additional PBM configuration PR 1381 final pbm/oplog/db.go diff and TestApplyOpsBypassesDocumentValidation regression test
Expiration remains a separate restore limitation; manual TTL monitor preparation percona/percona-backup-mongodb#1381 (comment); final PR does not contain automatic TTL monitor management; Jakub's corrected September 28 comment in PBM-1763 (edited October 5) confirms manual disabling for the duration of the restore
Bucket structure error example Same implementation PR comment
ttlMonitorEnabled is a mongod parameter; changing it disables expiration and can affect internal operations https://www.mongodb.com/docs/v8.0/reference/parameters/#mongodb-parameter-param.ttlMonitorEnabled
expireAfterSeconds removes expired time series data https://www.mongodb.com/docs/v8.0/core/timeseries/timeseries-automatic-removal/
Sharded time series collections unsupported Existing target-branch docs/features/logical.md and docs/features/known-limitations.md

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.

Copilot AI 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.

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.

@rasika-chivate
rasika-chivate changed the base branch from 2.17.0 to main October 5, 2026 06:08

Copilot AI 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.

Copilot review overview

🔵 Needs a closer look

Conflicting source guidance on when to disable TTL monitoring needs feature-owner confirmation.

Review effort: Balanced
Findings: None

Copilot AI 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.

Copilot review overview

🟢 Approval recommended

Remaining feedback concerns minor documentation clarifications rather than blocking defects.

Review effort: Balanced
Findings: 1 Low severity

Open (1)

Comment thread docs/usage/restore.md

This branch was successfully deployed

1 active deployment
PBM-1813-document-time-series-restores-2.17.0 - pbm-docs-preview PR #407 — 6363ffef Deployed Oct 5, 2026 by nastena1606
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.

5 participants