Skip to content

Improve clarity in restore documentation #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
igroene wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −2
Open

Improve clarity in restore documentation #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/usage/restore-physical.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Considerations

1. Disable point-in-time recovery. A restore and point-in-time recovery oplog slicing are incompatible operations and cannot be run simultaneously.
1. Disable point-in-time recovery. Restore and point-in-time recovery oplog slicing operations are incompatible with each other and cannot be run simultaneously.

```bash
pbm config --set pitr.enabled=false
Expand All @@ -13,7 +13,7 @@
2. The Percona Server for MongoDB version for both backup and restore data must be within the same major release.
3. Make sure all nodes in the cluster are healthy (i.e. report either PRIMARY or SECONDARY). Each `pbm-agent` needs to be able to connect to its local node and run queries in order to perform the restore.
4. For PBM versions before 2.1.0, physical restores are not supported for deployments with arbiter nodes.
5. At the end of a physical restore the database will be left down by `pbm-agent`. See the [Post-restore steps](#post-restore-steps) for instructions to resume normal operations.
5. After a physical restore completes, the database remains offline because it is intentionally left down by `pbm-agent`. To bring the database back to normal operation, follow the steps in [Post-restore steps](#post-restore-steps).

## Before you start

Expand All @@ -38,6 +38,12 @@

## Restore a database

!!! warning

If Encryption at Rest is enabled, the restore requires access to the same encryption key that was active when the backup was taken.
- For manually managed key files, update mongod.conf on all nodes to point to the original key before starting the restore procedure.
- For Hashicorp Vault-managed keys, ensure the historical key version is still available inside Vault. No changes to mongod.conf are required.

1. List the backups

```bash
Expand Down
Loading