Skip to content

Commit 2658afe

Browse files
authored
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
1 parent d36aea0 commit 2658afe

5 files changed

Lines changed: 105 additions & 5 deletions

File tree

docs/details/versions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The Restore compatibility column indicates if you can restore from the backup ma
2121

2222
| PBM version | Logical | Physical |Incremental physical | Restore backward compatibility|
2323
| ----------- |---------|----------|---------------------|---------------------|
24+
| **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 |
2425
| **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 |
2526
| **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 |
2627
| **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
3637

3738
| PBM version | Logical backups | Restore backward compatibility|
3839
| ----------- |-----------------| ----------------------------- |
40+
| **2.8.0** | 6.0.x and higher | Yes |
3941
| **2.6.0 - 2.7.0** | 5.0.x and higher | Yes |
4042
| **2.2.0 - 2.5.0** | 4.4.x and higher | Yes |
4143
| **2.1.0** | 4.4.x and higher| No. A fresh backup is required|

docs/release-notes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Percona Backup for MongoDB release notes
22

3+
* [Percona Backup for MongoDB 2.8.0](release-notes/2.8.0.md)
34
* [Percona Backup for MongoDB 2.7.0](release-notes/2.7.0.md)
45
* [Percona Backup for MongoDB 2.6.0](release-notes/2.6.0.md)
56
* [Percona Backup for MongoDB 2.5.0](release-notes/2.5.0.md)

docs/release-notes/2.8.0.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Percona Backup for MongoDB 2.8.0 ({{date.2_8_0}})
2+
3+
[Installation](../installation.md){.md-button}
4+
5+
6+
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.
7+
8+
## Release Highlights
9+
10+
This release provides the following features and improvements:
11+
12+
## Better organization of selective backups
13+
14+
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).
15+
16+
## Network routing control in communication of pbm-agents with the backup storage
17+
18+
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)
19+
20+
## Simplified troubleshooting with restoring the same collection under a different name
21+
22+
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.
23+
24+
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
25+
26+
## Reduced troubleshooting time with diagnostics report
27+
28+
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.
29+
30+
Check the [Diagnostics report](../troubleshoot/pbm-report.md) for more details.
31+
32+
## Improved log rotation with a custom path for log output
33+
34+
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.
35+
36+
Learn more about how to configure custom log path in the [documentation](../manage/logpath.md)
37+
38+
## Additional flexibility for backups
39+
40+
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.
41+
42+
## Changes in supported MongoDB versions
43+
44+
Starting from this release, PBM supports Percona Server for MongoDB 8.0 and MongoDB Community 8.0.
45+
46+
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.
47+
48+
## Known limitation
49+
50+
Selective backups and restores fail for setups with config shards. Find more details in [PBM-1465](https://perconadev.atlassian.net/browse/PBM-1465).
51+
52+
## Changelog
53+
54+
### New Features
55+
56+
* [PBM-887](https://perconadev.atlassian.net/browse/PBM-887) - Add the ability to generate diagnostics report
57+
58+
* [PBM-1211](https://perconadev.atlassian.net/browse/PBM-1211) - Ability to set multiple endpoints to the same S3 storage
59+
60+
* [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
61+
62+
* [PBM-1421](https://perconadev.atlassian.net/browse/PBM-1421) - Add the ability to clone a collection
63+
64+
* [PBM-1422](https://perconadev.atlassian.net/browse/PBM-1422) - Adjust Oplog and PITR to support a cloned collection
65+
66+
* [PBM-1454](https://perconadev.atlassian.net/browse/PBM-1454) Configuration file for all pbm-agent's options
67+
68+
### Improvements
69+
70+
* [PBM-1358](https://perconadev.atlassian.net/browse/PBM-1358) - Improve the selective restore behavior for deployments having a Config shard
71+
72+
* [PBM-1405](https://perconadev.atlassian.net/browse/PBM-1405) - Implement dump to replace `mongodump` for more flexibility
73+
74+
* [PBM-1414](https://perconadev.atlassian.net/browse/PBM-1414)- Change the default --numInsertionWorkersPerCollection and add ability to define them via command line
75+
76+
* [PBM-1417](https://perconadev.atlassian.net/browse/PBM-1417) - Allow defining multiple namespaces for selective backup
77+
78+
79+
### Bugs Fixed
80+
81+
* [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
82+
83+
* [PBM-1366](https://perconadev.atlassian.net/browse/PBM-1366) - Fixed the issue with `pbm-agent` failing if a collection is dropped during logical backup
84+
* [PBM-1390](https://perconadev.atlassian.net/browse/PBM-1390)- Fixed the issue with a possible agent crash by mongodump on backup cancel
85+
86+
* [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.
87+
88+
* [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
89+
90+
* [PBM-1441](https://perconadev.atlassian.net/browse/PBM-1441) - Add a License file to Docker image to pass Red Hat's certification
91+
92+
93+
94+
95+

mkdocs-base.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ plugins:
123123
with-pdf: # https://github.com/orzih/mkdocs-with-pdf
124124
output_path: '_pdf/PerconaBackupforMongoDB.pdf'
125125
cover_title: 'Backup for MongoDB Documentation'
126-
cover_subtitle: 2.7.0 (October 9, 2024)
126+
cover_subtitle: 2.8.0 (December 12, 2024)
127127
author: 'Percona Technical Documentation Team'
128128
cover_logo: docs/_images/Percona_Logo_Color.png
129129
debug_html: false
@@ -207,6 +207,7 @@ nav:
207207
- troubleshoot/faq.md
208208
- Release notes:
209209
- "Release notes index": "release-notes.md"
210+
- release-notes/2.8.0.md
210211
- release-notes/2.7.0.md
211212
- release-notes/2.6.0.md
212213
- release-notes/2.5.0.md

variables.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# PBM Variables set for HTML output
22
# See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path
33

4-
release: '2.7.0'
5-
version: '2.7'
4+
release: '2.8.0'
5+
version: '2.8'
66
year: '2024'
77

88
date:
9-
2_6_0: 2024-09-02
10-
2_7_0: 2024-10-09
9+
2_8_0: 2024-12-12
10+
2_7_0: 2024-10-09
11+
2_6_0: 2024-09-02

0 commit comments

Comments
 (0)