Refine physical backup and restore documentation#346
Conversation
Clarify the definition of physical backup and restore processes, update warnings regarding encryption key management, and improve overall readability.
There was a problem hiding this comment.
Pull request overview
Refines the “Physical backups and restores” documentation to better explain the physical restore flow and strengthen guidance around encryption key management during restores.
Changes:
- Rewords the physical backup/restore definitions and removes duplicated content.
- Clarifies that restore involves temporary/intermediate
mongodstarts and updates log-file behavior wording. - Updates the encryption admonition from “important” to “warning” and expands key-rotation / key-retention guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| !!! warning | ||
|
|
||
| Make sure that you know which master encryption key was used and keep it safe, as this key is required for the restore. | ||
| The master encryption key is not stored as part of the backup. Make sure that you know which encryption key was used at the time of each backup (and back it up separately). If using a key management system, make sure to enable key versioning (Vault does this by default). Do NOT delete old key versions as these are still required for restoring "old" backups that happened before key rotation. |
There was a problem hiding this comment.
In this warning, the terminology switches from "master encryption key" to the more generic "encryption key", which can be ambiguous (e.g., readers may not realize you mean the master key and/or its specific version at backup time). Consider using consistent terminology throughout and explicitly calling out that the restore requires the same master key version/ID that was active when the backup was taken.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rasika-chivate
temporarily deployed
to
igroene-patch-13 - pbm-docs PR #346
Render
Destroyed
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rasika-chivate
temporarily deployed
to
igroene-patch-13 - pbm-docs PR #346
Render
Destroyed
Clarify the definition of physical backup and restore processes, update warnings regarding encryption key management, and improve overall readability.