PBM-1433 Release notes 2.8.0 (#234)

* PBM-1433 Release notes 2.8.0 modified: docs/release-notes.md new file: docs/release-notes/2.8.0.md modified: mkdocs-base.yml modified: variables.yml * PBM-1433 Added a known limitation
percona · Dec 12, 2024 · 2658afe · 2658afe
1 parent d36aea0
commit 2658afe
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 5 deletions.
diff --git a/docs/details/versions.md b/docs/details/versions.md
@@ -21,6 +21,7 @@ The Restore compatibility column indicates if you can restore from the backup ma
 
 | PBM version | Logical | Physical |Incremental physical | Restore backward compatibility|
 | ----------- |---------|----------|---------------------|---------------------|
+| **2.8.0**  | [6.0.x], [7.0.x], [8.0.x] | [6.0.x], [7.0.x], [8.0.x] | [6.0.x], [7.0.x], [8.0.x] | Yes |
 | **2.6.0 - 2.7.0** | [5.0.x], [6.0.x], [7.0.x] | [5.0.x], [6.0.x], [7.0.x] | [5.0.14-12], [6.0.3-2] and higher, [7.0.x] | Yes |
 | **2.2.0 - 2.5.0** | [4.4.x] and higher| [4.4.6-8] and higher, 5.0.x, 6.0.x| [4.4.18-18], [5.0.14-12], [6.0.3-2] and higher| Yes |
 | **2.1.0** | 4.4.x and higher | [4.4.6-8], [5.0.x], [6.0.x]| [4.2.24-24], [4.4.18-18], [5.0.14-12], [6.0.3-2] and higher| No. A fresh backup is required|
@@ -36,6 +37,7 @@ The Restore compatibility column indicates if you can restore from the backup ma
 
 | PBM version | Logical backups | Restore backward compatibility|
 | ----------- |-----------------| ----------------------------- |
+| **2.8.0**  | 6.0.x and higher | Yes |
 | **2.6.0 - 2.7.0** | 5.0.x and higher | Yes |
 | **2.2.0 - 2.5.0** | 4.4.x and higher | Yes |
 | **2.1.0** | 4.4.x and higher| No. A fresh backup is required|

diff --git 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.8.0](release-notes/2.8.0.md)
 * [Percona Backup for MongoDB 2.7.0](release-notes/2.7.0.md)
 * [Percona Backup for MongoDB 2.6.0](release-notes/2.6.0.md)
 * [Percona Backup for MongoDB 2.5.0](release-notes/2.5.0.md)

diff --git a/docs/release-notes/2.8.0.md b/docs/release-notes/2.8.0.md
@@ -0,0 +1,95 @@
+# Percona Backup for MongoDB 2.8.0 ({{date.2_8_0}})
+
+[Installation](../installation.md){.md-button}
+
+
+Percona Backup for MongoDB is a distributed, low-impact solution for creating consistent backups of MongoDB sharded clusters and replica sets, and for restoring those backups to a specific point in time.
+
+## Release Highlights
+
+This release provides the following features and improvements:
+
+## Better organization of selective backups
+
+Now you can define multiple namespaces not only for selective restores but also for selective backups. This way you can better organize your backups as you accumulate the required data under a single backup. See how to make a backup of several namespaces in the [tutorial](../usage/start-backup.md#__tabbed_1_3).
+
+## Network routing control in communication of pbm-agents with the backup storage
+
+You can now control how pbm-agents reach the same remote backup storage by defining custom endpoints for them. This way you respect the network settings of the data centers where the servers running  pbm-agents reside and ensure the proper functioning of PBM. Custom endpoints are supported for AWS and Microsoft Azure Blob storages. Learn more about the endpoint definition in the [documentation](../details/storage-configuration.md#support-of-multiple-endpoints-to-the-same-S3-storage)
+
+## Simplified troubleshooting with restoring the same collection under a different name
+
+Now you can restore a single collection under a different name up to a certain point in time alongside the current collection. The restored collection has the same data and indexes as the one you backed up. This makes it easier to compare the data in both collections and identify what caused the issue with the database. As a result, your troubleshooting efforts significantly reduce.
+
+To learn more about this functionality, refer to the [Restore a collection under a different name](../features/selective-backup.md#restore-a-collection-under-a-different-name) section in the documentation
+
+## Reduced troubleshooting time with diagnostics report
+
+Collect all information required to troubleshoot backups and restores in one go. Generate the comprehensive diagnostics report about an operation execution and either dive deep yourself or file a bug report to our experts and attach  the diagnostics archive to it. This way you reduce the iteration time and speed up the issue resolution.
+
+Check the [Diagnostics report](../troubleshoot/pbm-report.md) for more details.
+
+## Improved log rotation with a custom path for log output
+
+You can now output logging information from every `pbm-agent` to a file at a custom path. This way you can introduce log rotation, manage the system log effectively and comply to security regulations for logging and auditing. 
+
+Learn more about how to configure custom log path in the [documentation](../manage/logpath.md)
+
+## Additional flexibility for backups
+
+PBM no longer uses mongodump for making backups but uses its own dump implementation. This makes backup operations flexible as it lifts the mongodumps' limitations and opens space for further improvements. 
+
+## Changes in supported MongoDB versions
+
+Starting from this release, PBM supports Percona Server for MongoDB 8.0 and MongoDB Community 8.0. 
+
+At the same time, PBM no longer supports Percona Server for MongoDB 5.0 and MongoDB Community 5.0 as it entered the end-of-life stage. Existing functionality remains compatible with version 5.0. However, we will no longer test new features and improvements against this version.
+
+## Known limitation
+
+Selective backups and restores fail for setups with config shards. Find more details in [PBM-1465](https://perconadev.atlassian.net/browse/PBM-1465).
+
+## Changelog
+
+### New Features
+
+* [PBM-887](https://perconadev.atlassian.net/browse/PBM-887) - Add the ability to generate diagnostics report
+
+* [PBM-1211](https://perconadev.atlassian.net/browse/PBM-1211) - Ability to set multiple endpoints to the same S3 storage
+
+* [PBM-1226](https://perconadev.atlassian.net/browse/PBM-1226) - Add the ability to define a custom log path for pbm-agent via environment variables or a command line
+
+* [PBM-1421](https://perconadev.atlassian.net/browse/PBM-1421) - Add the ability to clone a collection
+
+* [PBM-1422](https://perconadev.atlassian.net/browse/PBM-1422) - Adjust Oplog and PITR to support a cloned collection
+
+* [PBM-1454](https://perconadev.atlassian.net/browse/PBM-1454) Configuration file for all pbm-agent's options
+
+### Improvements
+
+* [PBM-1358](https://perconadev.atlassian.net/browse/PBM-1358) - Improve the selective restore behavior for deployments having a Config shard
+
+* [PBM-1405](https://perconadev.atlassian.net/browse/PBM-1405) - Implement dump to replace `mongodump` for more flexibility
+
+* [PBM-1414](https://perconadev.atlassian.net/browse/PBM-1414)- Change the default --numInsertionWorkersPerCollection and add ability to define them via command line
+
+* [PBM-1417](https://perconadev.atlassian.net/browse/PBM-1417) - Allow defining multiple namespaces for selective backup
+
+
+### Bugs Fixed
+
+* [PBM-1347](https://perconadev.atlassian.net/browse/PBM-1347) - Report error in `pbm describe-restore` output if point-in-time restore fails because of inappropriate time to restore
+
+* [PBM-1366](https://perconadev.atlassian.net/browse/PBM-1366) - Fixed the issue with `pbm-agent` failing if a collection is dropped during logical backup  
+* [PBM-1390](https://perconadev.atlassian.net/browse/PBM-1390)- Fixed the issue with a possible agent crash by mongodump on backup cancel
+
+* [PBM-1398](https://perconadev.atlassian.net/browse/PBM-1398) - Prevent modifying collections and indexes for excluded namespaces by ensuring all operations from oplog are excluded for them. 
+
+* [PBM-1426](https://perconadev.atlassian.net/browse/PBM-1426) - Fix sporadic failures of PBM during physical restore with point-in-time recovery by adding additional check for internal database restart to complete
+
+* [PBM-1441](https://perconadev.atlassian.net/browse/PBM-1441) - Add a License file to Docker image to pass Red Hat's certification
+
+
+
+
+
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -123,7 +123,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.7.0 (October 9, 2024)
+          cover_subtitle: 2.8.0 (December 12, 2024)
           author: 'Percona Technical Documentation Team'
           cover_logo: docs/_images/Percona_Logo_Color.png
           debug_html: false
@@ -207,6 +207,7 @@ nav:
       - troubleshoot/faq.md
   - Release notes:
       - "Release notes index": "release-notes.md"
+      - release-notes/2.8.0.md
       - release-notes/2.7.0.md
       - release-notes/2.6.0.md
       - release-notes/2.5.0.md

diff --git a/variables.yml b/variables.yml
@@ -1,10 +1,11 @@
 # PBM Variables set for HTML output
 # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path
 
-release: '2.7.0'
-version: '2.7'
+release: '2.8.0'
+version: '2.8'
 year: '2024'
 
 date:
-  2_6_0: 2024-09-02
-  2_7_0: 2024-10-09
+  2_8_0: 2024-12-12
+  2_7_0: 2024-10-09
+  2_6_0: 2024-09-02