Revise restore external documentation for accuracy#367
Open
igroene wants to merge 5 commits into
Open
Conversation
Updated documentation to reflect changes in restore process and clarify usage of 'last_write_time'. Added optional point in time recovery step.
Clarified instructions on saving oplog slices and replaying them on backups, including updates on physical backups and storage-level snapshots.
Updated links in oplog-replay.md to point to the correct restore documentation for physical and snapshot backups.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates PBM documentation around external (snapshot-based) restores and oplog replay to better reflect the current restore/PITR flow and clarify how last_write_time should be used.
Changes:
- Switched restore timestamp wording to reference
last_write_timeand added an optional post-restore oplog replay (PITR) step in the external restore guide. - Reworked
oplog-replaydocumentation structure/wording, including clearer separation for physical vs storage-level snapshot scenarios. - Minor formatting/link cleanup (e.g., URL whitespace).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/usage/restore-external.md | Clarifies restore timing via last_write_time and adds an optional oplog replay (PITR) post-restore step. |
| docs/usage/oplog-replay.md | Rephrases/restructures oplog replay docs, adding/clarifying storage-level snapshot guidance and updating related links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| 4. Start the balancer and start `mongos` nodes. | ||
| 4. Optional. Perform point in time recovery by running [`pbm oplog-replay`](./oplog-replay.md#oplog-replay-for-physical-backups) using the `last_write_time` as the start, for example: |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
rasika-chivate
temporarily deployed
to
igroene-patch-15 - pbm-docs PR #367
Render
Destroyed
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Updated documentation to reflect changes in restore process and clarify usage of 'last_write_time'. Added optional point in time recovery step.