Skip to content

PBM-1733 - Additional details about <node-list> #356

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

Merged
rasika-chivate merged 1 commit into from
Apr 17, 2026
Merged

PBM-1733 - Additional details about <node-list> #356

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
13 changes: 8 additions & 5 deletions docs/usage/backup-external.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
1. To make a snapshot-based backup, run the [`pbm backup`](../reference/pbm-commands.md#pbm-backup) command with the type `external`:

```bash
pbm backup -t external
pbm backup -t external
```

When executing the command, PBM does the following:
Expand All @@ -22,13 +22,17 @@
<node-list>
```

You also see the backup name.
In case of replica sets, `<node-list>` will include a single node.

Check warning on line 25 in docs/usage/backup-external.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/usage/backup-external.md#L25 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/usage/backup-external.md", "range": {"start": {"line": 25, "column": 44}}}, "severity": "WARNING"}
In case of sharded clusters, `<node-list>` will include a config node, and a node for each shard.

Check warning on line 26 in docs/usage/backup-external.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/usage/backup-external.md#L26 

[Vale.Spelling] Did you really mean 'sharded'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'sharded'?", "location": {"path": "docs/usage/backup-external.md", "range": {"start": {"line": 26, "column": 16}}}, "severity": "WARNING"}

Check warning on line 26 in docs/usage/backup-external.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/usage/backup-external.md#L26 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/usage/backup-external.md", "range": {"start": {"line": 26, "column": 48}}}, "severity": "WARNING"}
Node [priority](backup-priority.md) affects the nodes that are selected and included in `<node-list>`.

You also see the backup name.

2. (Optional) You can check the backup progress with the [`pbm describe-backup`](../reference/pbm-commands.md#pbm-describe-backup). The command output provides the backup state and what nodes are running backup.

3. At this stage, you need to copy the `dataDir` contents of each node in the `<node-list>` to the storage / make a snapshot using the technology of your choice.
3. At this stage, you need to copy the `dataDir` contents of each node in the `<node-list>` to the storage / make a snapshot using the technology of your choice.

4. After the copy/snapshot is complete, run the following command to close the `$backupCursor` and finish the backup:
4. After the copy/snapshot is complete, run the following command to close the `$backupCursor` and finish the backup:

```bash
pbm backup-finish <backup_name>
Expand All @@ -43,4 +47,3 @@

* [Backup and restore types](../features/backup-types.md)
* [Schedule backups](../usage/schedule-backup.md)

Loading