PBM-1131 Release notes 2.2.0 (#123)

PBM-1131 Release notes 2.2.0

modified:   docs/release-notes.md
new file:   docs/release-notes/2.2.0.md
modified:   mkdocs-base.yml
modified:   variables.yml

docs/features/backup-types.md

@@ -8,7 +8,7 @@ You can use several types of database backups and restores to develop your backu
 | [Physical](physical.md) | GA      | 2.0.0         | Sharded clusters and non-sharded replica sets | Yes (starting with 4.2.15-16, 4.4.6-8 and higher, 5.0.x, 6.0.x) | No | 
 | [Selective](selective-backup.md) | [Tech preview](../reference/glossary.md#technical-preview-feature)| 2.0.0         | Sharded clusters (starting with version 2.0.3) and non-sharded replica sets. Sharded collections are not yet supported. | Yes | Yes | 
 | [Incremental](incremental-backup.md) | GA | 2.1.0 (Supported for PSMDB versions 4.2.24-24, 4.4.18-18, 5.0.2-1, 6.0.2-1 and higher) | Sharded clusters and non-sharded replica sets | Yes  | No |  
-| [Point-in-time recovery](point-in-time-recovery.md) | GA (automatic for logical backups, manual for physical backups) | 1.3.0   | Sharded clusters and non-sharded replica sets | Yes | Yes | 
-| [Snapshot-based](snapshots.md) | Tech preview](../reference/glossary.md#technical-preview-feature) | 2.2.0 | Sharded clusters and non-sharded replica sets | Yes | No | 
+| [Point-in-time recovery](point-in-time-recovery.md) | GA | 1.3.0 (logical), 2.0.0 (physical manually), 2.2.0 (physical automated)  | Sharded clusters and non-sharded replica sets | Yes | Yes |
+| [Snapshot-based](snapshots.md) | [Tech preview](../reference/glossary.md#technical-preview-feature) | 2.2.0 | Sharded clusters and non-sharded replica sets | Yes | No | 
 
 

docs/index.md

@@ -14,7 +14,6 @@ With Percona Backup for MongoDB, you can make backups on a running server and re
 
 ![image](_images/backups-infographic.png)
 
-
 * [Logical backups](features/logical.md) to back up and / or migrate data to different platforms and database versions
 * [Physical backups](features/physical.md) to speed up performance for large (multi-terabyte) data sets
 * [Selective backups](features/selective-backup.md) to work with the desired data set

docs/release-notes.md

@@ -1,5 +1,6 @@
 # Percona Backup for MongoDB release notes
 
+* [Percona Backup for MongoDB 2.2.0](release-notes/2.2.0.md)
 * [Percona Backup for MongoDB 2.1.0](release-notes/2.1.0.md)
 * [Percona Backup for MongoDB 2.0.5](release-notes/2.0.5.md)
 * [Percona Backup for MongoDB 2.0.4](release-notes/2.0.4.md)

docs/release-notes/2.1.0.md

@@ -11,7 +11,7 @@ Percona Backup for MongoDB is a distributed, low-impact solution for consistent
 
 * [Incremental physical backups](../features/incremental-backup.md) are now generally available enabling you to use them in production environments. Note that due to the changes in metadata files required for the restore, backups made with previous PBM versions are incompatible for the restore with PBM 2.1.0. 
 * You can now [selectively back up and restore sharded collections](../features/selective-backup.md#sharded-collections). This improves the management of a desired subset of data in sharded clusters and saves you extra costs on data storage and transfer. This is the tech preview feature due to some [known limitations](../features/selective-backup.md#known-limitations).
-* Benefit from up to 7.5 times faster physical restore performance with the support of parallel download of data chunks from the S3 storage.
+* Benefit from up to 19 times faster physical restore performance with the support of [parallel download of data chunks from the S3 storage](../usage/restore.md#parallel-data-download).
 * Improved deletion of old backups and point-in-time recovery oplog chunks simplifies the automation of backup storage cleanup.
 * The improved handling of master keys for data at rest encryption in Percona Server for MongoDB and the retrieval of the key ID/secret path by PBM from a backup simplifies the environment preparation for the physical restore and improves the restore flow.
 * The support of AWS tokens for the access to the S3 storage improves the security of your infrastructure and the integration with applications that interact with AWS resources via tokens.

docs/release-notes/2.2.0.md

@@ -0,0 +1,38 @@
+# Percona Backup for MongoDB 2.2.0 (2023-07-13)
+
+| Release date | July 13, 2023  |
+|------------- | ---------------|
+| Installation | [Installing Percona Backup for MongoDB](../installation.md) |
+
+
+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
+
+* [Point-in-time recovery from physical backups](../usage/pitr-tutorial.md#from-physical-backups) is now automated similar to point-in-time recovery from logical ones. This offloads your DBAs on performing manual oplog replay on top of physical restore, ensures data consistency and unifies the user experience with PBM.  
+* Owners of large data sets can now use PBM to [create external physical backups](../features/snapshots.md) as EBS snapshots or via a technology of their choice and restore from those backups with the data consistency guaranteed by PBM. Thereby they benefit from increased performance and reduced downtime, and are sure that their data remains consistent. This is the technical preview feature.
+* The ability to [restore from physical and incremental backups to a new environment](../usage/restore.md#restoring-into-a-cluster-replica-set-with-a-different-name) with different replica set names extends the set of compatible environments for physical restore. 
+
+## New Features
+
+* [PBM-952](https://jira.percona.com/browse/PBM-952) - Add ability to make external backups
+* [PBM-815](https://jira.percona.com/browse/PBM-815) - Automated point-in-time recovery for physical backups
+
+## Improvements
+
+* [PBM-1055](https://jira.percona.com/browse/PBM-1055) - Add ability to configure replica set remapping for physical and incremental restores
+* [PBM-1118](https://jira.percona.com/browse/PBM-1118) - Support custom shard names for restores with replica set remapping
+* [PBM-1132](https://jira.percona.com/browse/PBM-1132) - Disallow using the `--ns` flag for physical and incremental backups and restores
+* [PBM-1133](https://jira.percona.com/browse/PBM-1133) - Add support for virtual-hosted–style URL for s3 storage buckets
+* [PBM-1062](https://jira.percona.com/browse/PBM-1062) - Add a supported PSMDB version check per backup type
+
+## Bugs Fixed
+
+* [PBM-1090](https://jira.percona.com/browse/PBM-1090) - Fixed the issue with the `E11000 duplicate key` error by applying the indexes building after the oplog replay operation
+* [PBM-1095](https://jira.percona.com/browse/PBM-1095) - Fixed the authentication error during selective backup by changing the authSource to `admin` on config server replica set
+* [PBM-1103](https://jira.percona.com/browse/PBM-1103) - Changed the warning message for incompatible backups in the `pbm status` output. 
+* [PBM-1123](https://jira.percona.com/browse/PBM-1123) - Fixed the issue with the restore by skipping the `config.image_collection` collection
+* [PBM-1135](https://jira.percona.com/browse/PBM-1135) - Fixed the issue with physical backup failure on a sharded cluster
+
+
+

docs/usage/restore.md

@@ -286,10 +286,10 @@ To restore a backup from one environment to another, ensure the following:
 
 ## Restoring into a cluster / replica set with a different name
 
-Starting with version 1.8.0, you can restore **logical backups** into a new environment that has the same or more number of shards and these shards have different replica set names. 
-Starting with version 2.2.0, you can restore environments that have [custom shard names](https://www.mongodb.com/docs/manual/reference/command/addShard/#mongodb-dbcommand-dbcmd.addShard). 
+Starting with version [1.8.0](../release-notes/1.8.0.md), you can restore [logical backups](../features/logical.md) into a new environment that has the same or more number of shards and these shards have different replica set names. 
+Starting with version [2.2.0](../release-notes/2.2.0.md), you can restore environments that have [custom shard names](https://www.mongodb.com/docs/manual/reference/command/addShard/#mongodb-dbcommand-dbcmd.addShard). 
 
-Starting with version 2.2.0, you can restore *physical/incremental* backups into a new environment with a different replica set names. Note that **the number of shards must be the same** as in the environment where the you made the backup.
+Starting with version [2.2.0](../release-notes/2.2.0.md), you can restore [physical](../features/physical.md) and [incremental physical](../features/incremental-backup.md) backups into a new environment with a different replica set names. Note that **the number of shards must be the same** as in the environment where the you made the backup.
 
 To restore data to the environment with different replica set names, configure the name mapping between the source and target environments. You can either set the `PBM_REPLSET_REMAPPING` environment variable for `pbm` CLI or use the `--replset-remapping` flag for PBM commands. The mapping format is `<rsTarget>=<rsSource>`.
 

mkdocs-base.yml

@@ -100,7 +100,7 @@ plugins:
   with-pdf: # https://github.com/orzih/mkdocs-with-pdf
           output_path: '_pdf/PerconaBackupforMongoDB.pdf'
           cover_title: 'Backup for MongoDB Documentation'
-          cover_subtitle: 2.1.0 (April 18, 2023)
+          cover_subtitle: 2.2.0 (July 13, 2023)
           author: 'Percona Technical Documentation Team'
           cover_logo: docs/_images/Percona_Logo_Color.png
           debug_html: false
@@ -126,15 +126,44 @@ extra:
 
 nav:
   - Home: index.md
+  - Release notes:
+      - "Release notes index": "release-notes.md"
+      - release-notes/2.2.0.md
+      - release-notes/2.1.0.md
+      - release-notes/2.0.5.md
+      - release-notes/2.0.4.md
+      - release-notes/2.0.3.md
+      - release-notes/2.0.2.md
+      - release-notes/2.0.1.md
+      - release-notes/2.0.0.md
+      - release-notes/1.8.1.md
+      - release-notes/1.8.0.md
+      - 'Percona Backup for MongoDB 1.7.0 (2022-04-18)': 'release-notes/1.7.0.md'
+      - 'Percona Backup for MongoDB 1.6.1 (2021-11-04)': 'release-notes/1.6.1.md'
+      - 'Percona Backup for MongoDB 1.6.0 (2021-08-16)': 'release-notes/1.6.0.md'
+      - 'Percona Backup for MongoDB 1.5.0 (2021-05-10)': 'release-notes/1.5.0.md'
+      - 'Percona Backup for MongoDB 1.4.1 (2021-01-28)': 'release-notes/1.4.1.md'
+      - 'Percona Backup for MongoDB 1.4.0 (2020-12-24)': 'release-notes/1.4.0.md'
+      - 'Percona Backup for MongoDB 1.3.4 (2020-11-19)': 'release-notes/1.3.4.md'
+      - 'Percona Backup for MongoDB 1.3.3 (2020-11-04)': 'release-notes/1.3.3.md'
+      - 'Percona Backup for MongoDB 1.3.2 (2020-10-14)': 'release-notes/1.3.2.md'
+      - 'Percona Backup for MongoDB 1.3.1 (2020-09-03)': 'release-notes/1.3.1.md'
+      - 'Percona Backup for MongoDB 1.3.0 (2020-08-26)': 'release-notes/1.3.0.md'
+      - 'Percona Backup for MongoDB 1.2.1 (2020-07-27)': 'release-notes/1.2.1.md'
+      - 'Percona Backup for MongoDB 1.2.0 (2020-05-13)': 'release-notes/1.2.0.md'
+      - 'Percona Backup for MongoDB 1.1.3 (2020-04-14)': 'release-notes/1.1.3.md'
+      - 'Percona Backup for MongoDB 1.1.1 (2020-01-31)': 'release-notes/1.1.1.md'
+      - 'Percona Backup for MongoDB 1.1.0 (2020-01-16)': 'release-notes/1.1.0.md'
+      - 'Percona Backup for MongoDB 1.0.0 (2019-09-19)': 'release-notes/1.0.0.md'
+      - 'Percona Backup for MongoDB 0.5.0 (2019-06-17)': 'release-notes/0.5.0.md'
   - Features: 
-      - Backup and restore types: 
-          - Overview: 'features/backup-types.md'
-          - features/logical.md
-          - features/physical.md
-          - features/selective-backup.md
-          - features/incremental-backup.md
-          - features/point-in-time-recovery.md 
-          - features/snapshots.md
+      - Backup and restore types: features/backup-types.md
+      - features/logical.md
+      - features/physical.md
+      - features/selective-backup.md
+      - features/incremental-backup.md
+      - features/point-in-time-recovery.md 
+      - features/snapshots.md
       - Comparison with MongoDB: 'features/comparison.md' 
   - Discover PBM:
       - How PBM works: 'intro.md'
@@ -189,35 +218,6 @@ nav:
           - reference/backup-options.md
           - reference/restore-options.md
       - reference/glossary.md  
-  - Release notes:
-      - "Release notes index": "release-notes.md"
-      - release-notes/2.1.0.md
-      - release-notes/2.0.5.md
-      - release-notes/2.0.4.md
-      - release-notes/2.0.3.md
-      - release-notes/2.0.2.md
-      - release-notes/2.0.1.md
-      - release-notes/2.0.0.md
-      - release-notes/1.8.1.md
-      - release-notes/1.8.0.md
-      - 'Percona Backup for MongoDB 1.7.0 (2022-04-18)': 'release-notes/1.7.0.md'
-      - 'Percona Backup for MongoDB 1.6.1 (2021-11-04)': 'release-notes/1.6.1.md'
-      - 'Percona Backup for MongoDB 1.6.0 (2021-08-16)': 'release-notes/1.6.0.md'
-      - 'Percona Backup for MongoDB 1.5.0 (2021-05-10)': 'release-notes/1.5.0.md'
-      - 'Percona Backup for MongoDB 1.4.1 (2021-01-28)': 'release-notes/1.4.1.md'
-      - 'Percona Backup for MongoDB 1.4.0 (2020-12-24)': 'release-notes/1.4.0.md'
-      - 'Percona Backup for MongoDB 1.3.4 (2020-11-19)': 'release-notes/1.3.4.md'
-      - 'Percona Backup for MongoDB 1.3.3 (2020-11-04)': 'release-notes/1.3.3.md'
-      - 'Percona Backup for MongoDB 1.3.2 (2020-10-14)': 'release-notes/1.3.2.md'
-      - 'Percona Backup for MongoDB 1.3.1 (2020-09-03)': 'release-notes/1.3.1.md'
-      - 'Percona Backup for MongoDB 1.3.0 (2020-08-26)': 'release-notes/1.3.0.md'
-      - 'Percona Backup for MongoDB 1.2.1 (2020-07-27)': 'release-notes/1.2.1.md'
-      - 'Percona Backup for MongoDB 1.2.0 (2020-05-13)': 'release-notes/1.2.0.md'
-      - 'Percona Backup for MongoDB 1.1.3 (2020-04-14)': 'release-notes/1.1.3.md'
-      - 'Percona Backup for MongoDB 1.1.1 (2020-01-31)': 'release-notes/1.1.1.md'
-      - 'Percona Backup for MongoDB 1.1.0 (2020-01-16)': 'release-notes/1.1.0.md'
-      - 'Percona Backup for MongoDB 1.0.0 (2019-09-19)': 'release-notes/1.0.0.md'
-      - 'Percona Backup for MongoDB 0.5.0 (2019-06-17)': 'release-notes/0.5.0.md'
   - reference/contributing.md
   - Copyright and licensing: copyright.md
   - Trademark policy: trademark-policy.md 

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.1.0'
-version: '2.1'
-release_date: 2023-04-18
+release: '2.2.0'
+version: '2.2'
+release_date: 2023-07-13