Skip to content

Commit

Permalink
Adde troubleshooting cases
Browse files Browse the repository at this point in the history
  • Loading branch information
nastena1606 committed Jun 11, 2024
1 parent 4f3f01c commit 62f60da
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/pmm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@ Check PMM documentation for the following guides:
* [How to configure PMM to monitor MongoDB :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/setting-up/client/mongodb.html)
* [Backup management for MongoDB in PMM :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/backup_mongo.html).

Having issues with backups? Check the [Troubleshoot backup management via Percona Monitoring and Management](troubleshoot/pbm-pmm.md) for help.




7 changes: 7 additions & 0 deletions docs/troubleshoot/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,10 @@ Yes. The preconditions for both Point-in-Time Recovery restore and regular resto

You cannot install PBM on MacBook using the package manager. PBM packages are available and tested for Linux distributions only. However, you can run PBM on MacBook as a Docker container. See the [Run in Docker](../install/docker.md) guide for guidelines.

## Can I connect PBM to MongoDB with disabled authorization?

While we **don’t recommend** disabling authorization for MongoDB due to security considerations, there might be scenarios (such as testing environments) where you need to connect PBM (Percona Backup Manager) to a MongoDB instance without authentication. Follow these steps to ensure a successful setup:

1. If you’ve set the [`bindIP` :octicons-link-external-16:](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-net.bindIp) configuration parameter for your `mongod` or `mongos` processes, ensure that the `localhost` value is included in the list of allowed IP addresses. The `pbm-agent` process connects to its local MongoDB node using a standalone type of connection.
2. Make sure the MongoDB connection URI string for pbm-agents includes `localhost` as part of the host information.
3. In the MongoDB connection URI string for the PBM CLI, exclude the `authSource` parameter as it otherwise enforces authorization.
9 changes: 9 additions & 0 deletions docs/troubleshoot/pbm-pmm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Troubleshoot backup management via Percona Monitoring and Management

If you are facing issues with physical backups and restores via PMM, follow these troubleshooting steps:

1. Ensure that the user running the `pmm` process has sufficient permissions within PBM. You can find detailed instructions in the [PMM documentation :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/setting-up/client/mongodb.html#create-pmm-account-and-set-permissions).
2. Make sure you have specified the user from step 1 in the MongoDB connection URI string for `pbm-agent` processes.
3. Confirm that the system user who runs the `pbm-agent` process (by default, `mongod`) has the read / write access to both the MongoDB dbpath and the backup storage location.
4. Examine the `systemd` restart policy for the user mentioned in step 4. Ensure it is not set to `always` or `on-success`. During physical restores, the database must not be automatically restarted as this is controlled by the `pbm-agent`.

9 changes: 6 additions & 3 deletions docs/usage/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,23 @@ To restore a backup, use the [`pbm restore`](../reference/pbm-commands.md#pbm-re

2. Shut down all `mongos` nodes to stop clients from accessing the database while restore is in progress. This ensures that the final restored data doesn’t differ from the backed-up data.

3. For PBM version 2.3.1 and earlier, manually disable point-in-time recovery if it is enabled. To learn more about point-in-time recovery, see [Point-in-time recovery](../features/point-in-time-recovery.md).
3. Shut down all `pmm-agent` and other clients that can do the write operations to the database. This is required to ensure data consistency after the restore.

4. For PBM version 2.3.1 and earlier, manually disable point-in-time recovery if it is enabled. To learn more about point-in-time recovery, see [Point-in-time recovery](../features/point-in-time-recovery.md).

=== ":material-database-refresh-outline: Physical"

1. Shut down all `mongos` nodes as the database won't be available while the restore is in progress.
2. Stop the arbiter nodes manually since there's no `pbm-agent` on these nodes to do that automatically.
2. Shut down all `pmm-agent` and other clients that can do the write operations to the database. This is required to ensure data consistency after the restore.
3. Stop the arbiter nodes manually since there's no `pbm-agent` on these nodes to do that automatically.

=== ":material-select-multiple: Selective"

You can restore a specific database or a collection either from a full or a selective backup. Read about [known limitations of selective restores](../features/selective-backup.md#known-limitations-of-selective-backups-and-restores).

=== ":simple-databricks: Incremental"

Before you start, shut down all `mongos` nodes as the database won’t be available while the restore is in progress.
Before you start, shut down all `mongos` nodes, `pmm-agent` processes and clients that can do writes to the database as it won’t be available while the restore is in progress.


## Restore a database
Expand Down
1 change: 1 addition & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ nav:
- Overview: troubleshoot/index.md
- 'Diagnose PBM': 'troubleshoot/troubleshooting.md'
- 'Check status': 'troubleshoot/status.md'
- 'Troubleshoot backup management via PMM': 'troubleshoot/pbm-pmm.md'
- troubleshoot/faq.md
- Release notes:
- "Release notes index": "release-notes.md"
Expand Down

0 comments on commit 62f60da

Please sign in to comment.