Skip to content

Commit

Permalink
Merged changes from main branch:
Browse files Browse the repository at this point in the history
modified:   docs/install/docker.md
	modified:   docs/reference/configuration-options.md
	modified:   docs/release-notes.md
	new file:   docs/release-notes/2.3.1.md
	modified:   mkdocs-base.yml
  • Loading branch information
nastena1606 committed Dec 8, 2023
1 parent c7aeeed commit dca260b
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 8 deletions.
14 changes: 8 additions & 6 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Where:

* `container-name` is the name you want to assign to your container.
* `PBM_MONGODB-URI` is a [MongoDB Connection URI](https://docs.mongodb.com/manual/reference/connection-string/) string used to connect to MongoDB nodes. See the [Initial setup](initial-setup.md) how to create the PBM user.
* `tag-multi` is the tag specifying the version you need. For example, `2.3.0-multi`. The `multi` part of the tag serves to identify the architecture (x86_64 or ARM64) and pull the respective image. See the [full list of tags](https://hub.docker.com/r/perconalab/percona-backup-mongodb/tags).
* `tag-multi` is the tag specifying the version you need. For example, `{{release}}-multi`. The `multi` part of the tag serves to identify the architecture (x86_64 or ARM64) and pull the respective image. See the [full list of tags](https://hub.docker.com/r/perconalab/percona-backup-mongodb/tags).

Note that every MongoDB node (including replica set secondary members and config server replica set nodes) requires a separate instance of Percona Backup for MongoDB. Thus, a typical, 3-node MongoDB replica set requires three instances of Percona Backup for MongoDB.

Expand All @@ -34,16 +34,16 @@ Percona Backup for MongoDB requires the remote storage where to store data. Use
1. Start a Bash session:

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

2. Create a YAML configuration file:

```{.bash data-prompt="$"}
$ touch /tmp/pbm_config.yaml
$ vi /tmp/pbm_config.yaml
```

3. Specify remote storage parameters in the config file. The following example is for S3-compatible backup storage. Check what [other storages are supported](../details/storage-configuration.md):
3. Specify remote storage parameters in the config file. The following example is for S3-compatible backup storage. Check what [other storages are supported](../details/storage-configuration.md) and [examples of storage configurations](../details/storage-config-example.md):

```yaml
storage:
Expand All @@ -62,14 +62,16 @@ Percona Backup for MongoDB requires the remote storage where to store data. Use
$ pbm config --file /tmp/pbm_config.yaml
```

The command output displays your uploaded configuration.

## Run Percona Backup for MongoDB

Percona Backup for MongoDB command line utility (`pbm`) provides the set of commands to control backups: create, restore, cancel backups, etc.

For example, to start a backup, use the following command:

```{.bash data-prompt="$"}
$ docker run --name <container-name> pbm backup
$ docker exec -it --name <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 All @@ -78,4 +80,4 @@ In the same way you can run other pbm commands. Find the full list of available

## Next steps

[List backups :material-arrow-right:](../usage/list-backup.md){.md-button}
[List backups](../usage/list-backup.md){.md-button}
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quickstart guide

Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restore of [MongoDB sharded clusters and replica sets](details/deployments.md). [Read more](index.md).
Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restore of [MongoDB sharded clusters and replica sets](details/deployments.md). [Learn how PBM works](intro.md).

Find the list of supported platforms for Percona Backup for MongoDB on the [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page.

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ storage:
azure:
account: <string>
container: <string>
endpointUrl: <string>
prefix: <string>
credentials:
key: <your-access-key>
Expand All @@ -269,6 +270,13 @@ The name of your storage account.

The name of the storage container. See the [Container names](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#container-names) for naming conventions.

### storage.azure.endpointUrl

*Type*: string <br>
*Required*: NO

The URL to access the data in Microsoft Azure Blob Storage. The default value is `https://<storage-account>.blob.core.windows.net`.

### storage.azure.prefix

*Type*: string <br>
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Percona Backup for MongoDB release notes

* [Percona Backup for MongoDB 2.3.1](release-notes/2.3.1.md)
* [Percona Backup for MongoDB 2.3.0](release-notes/2.3.0.md)
* [Percona Backup for MongoDB 2.2.1](release-notes/2.2.1.md)
* [Percona Backup for MongoDB 2.2.0](release-notes/2.2.0.md)
Expand Down
26 changes: 26 additions & 0 deletions docs/release-notes/2.3.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Percona Backup for MongoDB 2.3.1 (2023-12-04)

[Installation](../installation.md){.md-button}


Percona Backup for MongoDB is a distributed, low-impact solution for consistent backups of MongoDB sharded clusters and replica sets. This is a tool for creating consistent backups across a MongoDB sharded cluster (or a non-sharded replica set), and for restoring those backups to a specific point in time.

## Release Highlights

* Added support for Percona Server for MongoDB 7.0.
* The ability to define custom endpoints when using Microsoft Azure Blob Storage for backups
* Improved PBM Docker image to allow making physical backups with the shared `mongodb` data volume
* Updated Golang libraries that include fixes for the security vulnerability CVE-2023-39325.


## Improvements

* [PBM-1195](https://jira.percona.com/browse/PBM-1195) - Allow custom endpointUrl for Azure storage
* [PBM-1205](https://jira.percona.com/browse/PBM-1205) - Change the user in PBM Docker image to `mongod`


## Bugs Fixed

* [PBM-1193](https://jira.percona.com/browse/PBM-1193) - Fixed the `pbm-agent` failure when the connection to PSMDB is lost


1 change: 1 addition & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ nav:
- troubleshoot/faq.md
- Release notes:
- "Release notes index": "release-notes.md"
- release-notes/2.3.1.md
- release-notes/2.3.0.md
- release-notes/2.2.1.md
- release-notes/2.2.0.md
Expand Down
2 changes: 1 addition & 1 deletion variables.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PBM Variables set for HTML output
# See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path

release: '2.3.0'
release: '2.3.1'
version: '2.3'

0 comments on commit dca260b

Please sign in to comment.