Skip to content

Commit

Permalink
Fixes after the first install of PBM (#158)
Browse files Browse the repository at this point in the history
* Fix broken link

* Fix expression

* Fix broken link

* Fix docker exec commands

--name option does not exist for `docker exec`

* Fix typo

* Fix doc extension html -> md

Co-authored-by: Anastasia Alexandrova <[email protected]>

* Fix doc extension html -> md

Co-authored-by: Anastasia Alexandrova <[email protected]>

---------

Co-authored-by: Anastasia Alexandrova <[email protected]>
  • Loading branch information
boris-ilijic and nastena1606 authored Mar 4, 2024
1 parent 39c7a51 commit cfd075d
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/details/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
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).
2 changes: 1 addition & 1 deletion docs/details/pbm-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/install/configure-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.md#mongodb-connection-strings) section.

## External authentication support in Percona Backup for MongoDB

Expand Down
4 changes: 2 additions & 2 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Percona Backup for MongoDB requires the remote storage where to store data. Use
1. Start a Bash session:

```{.bash data-prompt="$"}
$ docker exec -it --name <container-name> bash
$ docker exec -it <container-name> bash
```

2. Create a YAML configuration file:
Expand Down Expand Up @@ -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 <container-name> pbm backup
$ docker exec -it <container-name> pbm backup
```

where `<container-name>` is the name you assigned to the container and `pbm backup` is the command to start a backup.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/pbm-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit cfd075d

Please sign in to comment.