From 7b6db5ad8247851ee1b9b6a932f6a774f60dd3b1 Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Fri, 1 Mar 2024 19:06:33 +0100 Subject: [PATCH 1/7] Fix broken link --- docs/details/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/details/cli.md b/docs/details/cli.md index f44eb5e2..a162191f 100644 --- a/docs/details/cli.md +++ b/docs/details/cli.md @@ -13,4 +13,4 @@ configuration-like step that should be done for practical ease though. (Without `PBM_MONGODB_URI`, the `--mongodb-uri` command line argument will need to be specified each time.) -To learn how to set the `PBM_MONGODB_URI` environment variable, see [Set the MongoDB connection URI for `pbm` CLI](../install/initial-setup.md#set-mongodburi-pbm-cli). For more information about MongoDB URI connection strings, see [Authentication](authentication.md). \ No newline at end of file +To learn how to set the `PBM_MONGODB_URI` environment variable, see [Set the MongoDB connection URI for `pbm` CLI](../install/configure-authentication.html#set-the-mongodb-connection-uri-for-pbm-cli). For more information about MongoDB URI connection strings, see [Authentication](authentication.md). From 11729890714dec43435914675829ac9ab598658c Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Fri, 1 Mar 2024 19:06:56 +0100 Subject: [PATCH 2/7] Fix expression --- docs/details/pbm-agent.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/details/pbm-agent.md b/docs/details/pbm-agent.md index d6ae7c5b..3c8b6576 100644 --- a/docs/details/pbm-agent.md +++ b/docs/details/pbm-agent.md @@ -2,7 +2,7 @@ A `pbm-agent` is a process that runs backup, restore, delete, and other operations available with Percona Backup for MongoDB. -A `pbm-agent` instance must run on each `mongod` instance. This includes replica set nodes that are currently secondaries and config server replica set nodes in a sharded cluster. +A `pbm-agent` instance must run for each `mongod` instance. This includes replica set nodes that are currently secondaries and config server replica set nodes in a sharded cluster. An operation is triggered when the [`pbm` CLI](../reference/glossary.md#pbm-cli) makes an update to the [PBM Control collection](../reference/glossary.md#pbm-control-collections). All `pbm-agents` monitor changes to the PBM control collections, but only one `pbm-agent` in each replica set will be elected to execute an operation. The elections are done by a random choice among secondary nodes. If no secondary nodes respond, then the `pbm-agent` on the primary node is elected for an operation. @@ -10,4 +10,4 @@ The elected `pbm-agent` acquires a lock for an operation. This prevents mutually When the operation is complete, the `pbm-agent` releases the lock and updates the PBM control collections. -A single `pbm-agent` is involved with only one cluster (or non-sharded replica set). The `pbm` CLI utility can connect to any cluster to which it has network access, so it is possible for one user to list and launch backups or restores on many clusters. \ No newline at end of file +A single `pbm-agent` is involved with only one cluster (or non-sharded replica set). The `pbm` CLI utility can connect to any cluster to which it has network access, so it is possible for one user to list and launch backups or restores on many clusters. From b8901e656c1e7d7e26b6066fb719bdf2fdfb582c Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Fri, 1 Mar 2024 19:14:45 +0100 Subject: [PATCH 3/7] Fix broken link --- docs/install/configure-authentication.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install/configure-authentication.md b/docs/install/configure-authentication.md index 2f2cc5c9..36299346 100644 --- a/docs/install/configure-authentication.md +++ b/docs/install/configure-authentication.md @@ -129,7 +129,7 @@ Use the following command: export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin&replSetName=xxxx" ``` -For more information about what connection string to specify, refer to the [pbm connection string](../details/authentication.md#mongodb-connection-strings-a-reminder-or-primer) section. +For more information about what connection string to specify, refer to the [pbm connection string](../details/authentication.html#mongodb-connection-strings) section. ## External authentication support in Percona Backup for MongoDB @@ -182,4 +182,4 @@ PBM_MONGODB_URI="mongodb://:@ Date: Mon, 4 Mar 2024 12:09:24 +0100 Subject: [PATCH 4/7] Fix docker exec commands --name option does not exist for `docker exec` --- docs/details/pbm-agent.md | 2 +- docs/install/configure-authentication.md | 2 +- docs/install/docker.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/details/pbm-agent.md b/docs/details/pbm-agent.md index 3c8b6576..93b4befd 100644 --- a/docs/details/pbm-agent.md +++ b/docs/details/pbm-agent.md @@ -10,4 +10,4 @@ The elected `pbm-agent` acquires a lock for an operation. This prevents mutually When the operation is complete, the `pbm-agent` releases the lock and updates the PBM control collections. -A single `pbm-agent` is involved with only one cluster (or non-sharded replica set). The `pbm` CLI utility can connect to any cluster to which it has network access, so it is possible for one user to list and launch backups or restores on many clusters. +A single `pbm-agent` is involved with only one cluster (or non-sharded replica set). The `pbm` CLI utility can connect to any cluster to which it has network access, so it is possible for one user to list and launch backups or restores on many clusters. \ No newline at end of file diff --git a/docs/install/configure-authentication.md b/docs/install/configure-authentication.md index 36299346..fff17ab9 100644 --- a/docs/install/configure-authentication.md +++ b/docs/install/configure-authentication.md @@ -182,4 +182,4 @@ PBM_MONGODB_URI="mongodb://:@ bash + $ docker exec -it bash ``` 2. Create a YAML configuration file: @@ -76,7 +76,7 @@ Percona Backup for MongoDB command line utility (`pbm`) provides the set of comm For example, to start a backup, use the following command: ```{.bash data-prompt="$"} -$ docker exec -it --name pbm backup +$ docker exec -it pbm backup ``` where `` is the name you assigned to the container and `pbm backup` is the command to start a backup. From 554537e9e816eec763c959e3280434f619b4df97 Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Mon, 4 Mar 2024 13:03:03 +0100 Subject: [PATCH 5/7] Fix typo --- docs/reference/pbm-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/pbm-commands.md b/docs/reference/pbm-commands.md index 78a1b89e..0d9adddc 100644 --- a/docs/reference/pbm-commands.md +++ b/docs/reference/pbm-commands.md @@ -26,7 +26,7 @@ The command accepts the following flags: | `--compression-level` | Configure the compression level from 0 to 10. The default value depends on the compression method used. | | `-o`, `--out=text` | Shows the output format as either plain text or a JSON object. Supported values: `text`, `json` | | `--wait` | Wait for the backup to finish. The flag blocks the shell session.| -| `-l`, `--list-files` | For external backups only. Shows the list of fines per node to copy.| +| `-l`, `--list-files` | For external backups only. Shows the list of files per node to copy.| | `--ns="database.collection"`| Makes a logical backup of the specified namespace - the database and collection(s). To back up all collections in the database, specify the value in the `--ns="database.*"` format. In version 2.0.0, only a single namespace is supported for the backup.| ??? "JSON output" From 71a0b32b32b9e9e133e619b1b16a790c5d6c7a7e Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Mon, 4 Mar 2024 18:18:33 +0100 Subject: [PATCH 6/7] Fix doc extension html -> md Co-authored-by: Anastasia Alexandrova --- docs/details/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/details/cli.md b/docs/details/cli.md index a162191f..7c2dbaae 100644 --- a/docs/details/cli.md +++ b/docs/details/cli.md @@ -13,4 +13,4 @@ configuration-like step that should be done for practical ease though. (Without `PBM_MONGODB_URI`, the `--mongodb-uri` command line argument will need to be specified each time.) -To learn how to set the `PBM_MONGODB_URI` environment variable, see [Set the MongoDB connection URI for `pbm` CLI](../install/configure-authentication.html#set-the-mongodb-connection-uri-for-pbm-cli). For more information about MongoDB URI connection strings, see [Authentication](authentication.md). +To learn how to set the `PBM_MONGODB_URI` environment variable, see [Set the MongoDB connection URI for `pbm` CLI](../install/configure-authentication.md#set-the-mongodb-connection-uri-for-pbm-cli). For more information about MongoDB URI connection strings, see [Authentication](authentication.md). From dda8ef282dd7a9baefabee8cd6e0954e72bc861b Mon Sep 17 00:00:00 2001 From: Boris Ilijic Date: Mon, 4 Mar 2024 18:18:48 +0100 Subject: [PATCH 7/7] Fix doc extension html -> md Co-authored-by: Anastasia Alexandrova --- docs/install/configure-authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/configure-authentication.md b/docs/install/configure-authentication.md index fff17ab9..b20bfaea 100644 --- a/docs/install/configure-authentication.md +++ b/docs/install/configure-authentication.md @@ -129,7 +129,7 @@ Use the following command: export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin&replSetName=xxxx" ``` -For more information about what connection string to specify, refer to the [pbm connection string](../details/authentication.html#mongodb-connection-strings) section. +For more information about what connection string to specify, refer to the [pbm connection string](../details/authentication.md#mongodb-connection-strings) section. ## External authentication support in Percona Backup for MongoDB