diff --git a/docs/install/docker.md b/docs/install/docker.md index ef20801c..60171a3c 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -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. @@ -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 bash + $ docker exec -it --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: @@ -62,6 +62,8 @@ 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. @@ -69,7 +71,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 run --name pbm backup +$ docker exec -it --name pbm backup ``` where `` is the name you assigned to the container and `pbm backup` is the command to start a backup. @@ -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} \ No newline at end of file +[List backups](../usage/list-backup.md){.md-button} \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index e54630f1..4783d1a7 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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. diff --git a/docs/reference/configuration-options.md b/docs/reference/configuration-options.md index 37d41c24..bd3ba25f 100644 --- a/docs/reference/configuration-options.md +++ b/docs/reference/configuration-options.md @@ -250,6 +250,7 @@ storage: azure: account: container: + endpointUrl: prefix: credentials: key: @@ -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
+*Required*: NO + +The URL to access the data in Microsoft Azure Blob Storage. The default value is `https://.blob.core.windows.net`. + ### storage.azure.prefix *Type*: string
diff --git a/docs/release-notes.md b/docs/release-notes.md index ab524345..3810cd52 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -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) diff --git a/docs/release-notes/2.3.1.md b/docs/release-notes/2.3.1.md new file mode 100644 index 00000000..c673890e --- /dev/null +++ b/docs/release-notes/2.3.1.md @@ -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 + + \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 7fa328e0..3e604f5e 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -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 diff --git a/variables.yml b/variables.yml index 5ab1d988..1e29025b 100644 --- a/variables.yml +++ b/variables.yml @@ -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'