From 76b4f5ed09431fb2ac841f3282498aca7fedf552 Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Thu, 18 Jan 2024 10:03:18 +0100 Subject: [PATCH] PBM-1187 Added --wait flag to pbm config description Fixed broken reference links modified: docs/reference/pbm-commands.md modified: docs/troubleshoot/faq.md modified: docs/usage/cancel-backup.md modified: docs/usage/list-backup.md --- docs/reference/pbm-commands.md | 1 + docs/troubleshoot/faq.md | 4 ++-- docs/usage/cancel-backup.md | 2 +- docs/usage/list-backup.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/reference/pbm-commands.md b/docs/reference/pbm-commands.md index 78a1b89e..030707fa 100644 --- a/docs/reference/pbm-commands.md +++ b/docs/reference/pbm-commands.md @@ -105,6 +105,7 @@ The command accepts the following flags: | `--file=FILE` | Upload the config information from a YAML file | | `--set=SET` | Set a new config option value. Specify the option in the `` format. | | `-o`, `--out=text` | Shows the output format as either plain text or a JSON object. Supported values: text, json | +| `-w`, `--wait` | Wait for resync of the backup list with the storage to finish. You can only use this flag together with the `--force-resync` flag.| ??? "PBM configuration output" diff --git a/docs/troubleshoot/faq.md b/docs/troubleshoot/faq.md index e4ebf70b..8afda496 100644 --- a/docs/troubleshoot/faq.md +++ b/docs/troubleshoot/faq.md @@ -5,7 +5,7 @@ `mongodump` is a "logical" backup solution only while Percona Backup for MongoDB supports both logical and physical backups. Both solutions have equal performance for non-sharded replica sets. However, as opposed to `mongodump`, Percona Backup for MongoDB allows you to achieve the following goals: * Make consistent backups and restores in sharded clusters. -* Backup / restore both the whole data set and specific namespaces —— databases and collections. (See [Selective backup and restore](features/selective-backup.md) for more information.) +* Backup / restore both the whole data set and specific namespaces —— databases and collections. (See [Selective backup and restore](../features/selective-backup.md) for more information.) * Restore your database to a specific point in time. * Run backups / restores on each replica set in parallel while `mongodump` runs in one process on `mongos` node. @@ -17,7 +17,7 @@ Starting with version 2.0.1, you can change the time zone for ``pbm logs`` outpu ## Can I restore a single collection with Percona Backup for MongoDB? -Yes. Starting with version 2.0.0, you can restore a single collection with Percona Backup for MongoDB. This functionality is available for logical backups and restores only. To learn more, see [Selective backup and restore](features/selective-backup.md). +Yes. Starting with version 2.0.0, you can restore a single collection with Percona Backup for MongoDB. This functionality is available for logical backups and restores only. To learn more, see [Selective backup and restore](../features/selective-backup.md). ## Can I back up specific shards in a cluster? diff --git a/docs/usage/cancel-backup.md b/docs/usage/cancel-backup.md index 20d5b13f..3bfef7c8 100644 --- a/docs/usage/cancel-backup.md +++ b/docs/usage/cancel-backup.md @@ -10,7 +10,7 @@ $ pbm cancel-backup Backup cancellation has started ``` -After the command execution, the backup is marked as canceled in the [pbm status](../manage/status.md) output: +After the command execution, the backup is marked as canceled in the [pbm status](../troubleshoot/status.md) output: ```{.bash data-prompt="$"} $ pbm status diff --git a/docs/usage/list-backup.md b/docs/usage/list-backup.md index 732e8583..1b3d349e 100644 --- a/docs/usage/list-backup.md +++ b/docs/usage/list-backup.md @@ -2,7 +2,7 @@ !!! note - As of version 1.4.0, the `pbm list` command provides the information only about completed backups. To check for running backups, use the [`pbm status`](../reference/pbm-commands.md#pbm-status). For more information, see [Percona Backup for MongoDB status](../manage/status.md). + As of version 1.4.0, the `pbm list` command provides the information only about completed backups. To check for running backups, use the [`pbm status`](../reference/pbm-commands.md#pbm-status). For more information, see [Percona Backup for MongoDB status](../troubleshoot/status.md). For Percona Backup for MongoDB version 1.3.4 and earlier, the `pbm list` command provides the running backup listed with an ‘In progress’ label. When that is absent, the backup is complete.