PBM-1655 Release notes 2.12.0 (#311)

nastena1606 · web-flow · commit f41c19fbed2b · 2025-11-04T12:33:00.000+01:00
*
 PBM-1655 Release notes 2.12.0

new file:   docs/release-notes/2.12.0.md
        modified:   mkdocs-base.yml
        modified:   variables.yml
diff --git a/docs/_templates/pdf_cover_page.tpl b/docs/_templates/pdf_cover_page.tpl
@@ -3,8 +3,8 @@
 <p>
 <img src="_images/Percona_Logo_Color.png" />
 </p>
-<h1>Backup for MongoDB 2.11.0</h1>
+<h1>Backup for MongoDB 2.12.0</h1>
 {% if config.site_description %}
 <h1>{{ config.site_description }}</h1>
 {% endif %} 
-<h2>2.11.0 (September 25, 2025)</h2>
+<h2>2.12.0 (November 4, 2025)</h2>
diff --git a/docs/details/gcs.md b/docs/details/gcs.md
@@ -9,11 +9,9 @@ You can use Google Cloud Storage (GCS) as a remote backup storage for Percona Ba
 
 PBM supports communication with GCS via the JSON API and XML API. The preferred approach is to use the JSON API with a service account. HMAC keys are mainly useful for compatibility with S3-style APIs.
 
-!!! warning "Known limitation"
- 
-    When you run backups to GCS via HMAC keys, incomplete backups may be incorrectly marked as successful if network interruptions occur during the backup process. This results in corrupted or partially uploaded archives being stored and treated as valid backups, which can later fail during restore operations. This issue is addressed in [PBM-1605](https://perconadev.atlassian.net/browse/PBM-1605). 
+!!! warning "HMAC keys support deprecation"
 
-    Until the issue is resolved, we recommend using a native GCS connection type with JSON keys rather than HMAC keys to ensure backup integrity.
+    Starting with version 2.12.0, HMAC keys support is deprecated. We encourage you to use GCS connection type with native JSON keys.
 
 To use GCS, you need the following:
 
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,5 +1,6 @@
 # {{pbm.full_name}} release notes
 
+* [{{pbm.full_name}} 2.12.0](release-notes/2.12.0.md)
 * [{{pbm.full_name}} 2.11.0](release-notes/2.11.0.md)
 * [{{pbm.full_name}} 2.10.0](release-notes/2.10.0.md)
 * [{{pbm.full_name}} 2.9.1](release-notes/2.9.1.md)
diff --git a/docs/release-notes/2.12.0.md b/docs/release-notes/2.12.0.md
@@ -0,0 +1,96 @@
+# Percona Backup for MongoDB 2.12.0 ({{date.2_12_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 focuses on improvements to backup storages. It includes new storage types, enhances Azure and GCS implementations and fixes issues with S3-compatible storage services. 
+
+Details below:
+
+### Support of Alibaba Cloud as the backup storage
+
+With **Percona Backup for MongoDB (PBM)** now supporting **Alibaba Cloud OSS** as a remote backup destination, you can seamlessly integrate your backup workflows into the Alibaba Cloud ecosystem. This means you can store any type of backups directly in OSS without extra tools or manual steps, taking full advantage of Alibaba's scalable infrastructure and strong regional performance. 
+
+You can authenticate directly using your OSS Access Key ID and Secret, or take advantage of full support for Alibaba Cloud's Security Token Service (STS) AssumeRole, which includes automatic security token refresh. The latter authentication flow is ideal for organizations that require temporary credentials for enhanced security. 
+
+This integration empowers teams already invested in Alibaba Cloud to adopt PBM better. Whether you're operating in Asia-Pacific or building cloud-native infrastructure, this gives you a secure, scalable, and compliant way to protect your data.
+
+### Ensure data upload to Azure Blob storage even during unstable network
+
+You can now control the number of upload retries to Azure in PBM configuration. This enhancement ensures your data reaches its destination—even when the network is unstable or intermittent. By customizing retry behavior, you gain greater resilience and reliability in backup and sync workflows. It’s a simple way to reduce failed uploads and improve peace of mind.
+
+### Native MinIO Support in PBM
+
+PBM now includes a native support for the MinIO storage by adding the **MinIo Go client library**. This integration makes it easier to use custom S3-compatible storage services for backup and restore. 
+
+Not all S3-compatible storage services support Signature Version 4 (SigV4) used in AWS SDK v2, which may result in compatibility and connectivity issues.
+
+To solve this, PBM now uses the MinIo Go client and supports a new `minio` storage type in its configuration. 
+
+```yaml
+storage:
+  type: minio
+  minio:
+    endpoint: minio.example.com:9000
+    bucket: pbm-test-bucket
+    prefix: data/pbm/backup
+    credentials:
+      access-key-id: <your-access-key-id-here>
+      secret-access-key: <your-secret-key-here>
+```
+
+If your custom S3-compatible storage is not compatible with AWS SDK v2, consider re-configuring PBM to use the `minio` storage type after the upgrade. However, be aware of the current [known limitation](#known-limitation-for-using-the-minio-storage-type) for using the MinIO storage type.
+
+#### Known limitation for using the MinIO storage type
+
+While MinIo SDK supports concurrency, its implementation interferes with PBM's backup logic and affects PBM functionality.  Therefore, currently PBM uploads backups using a single thread which results in slower backup performance compared to S3. We're actively investigating safe ways to improve throughput without compromising reliability.
+
+### Deprecation of HMAC keys support for Google Cloud Storage
+
+Accessing Google Cloud Storage with HMAC keys relies on AWS Signature Version 2 (SigV2), an outdated authentication method that has been officially deprecated. Google Cloud Storage doesn't support a new Signature Version 4 (SigV4) and only supports SigV2 for HMAC authentication.
+
+Continuing to use SigV2 can lead to serious issues: Percona Backup for MongoDB may incorrectly mark incomplete backups as successful and upload corrupted data to storage. This puts your restore process at risk and undermines backup reliability.
+
+Using the outdated Signature Version 2 (SigV2) authentication for Google Cloud Storage is not recommended because it lacks important security enhancements, is no longer maintained, and can introduce critical reliability issues.
+
+To prevent this, support for HMAC keys is now deprecated. We strongly recommend migrating to a native GCS connection type [with JSON keys :octicons-link-external-16:](https://cloud.google.com/iam/docs/keys-create-delete#creating). Refer to the [documentation](../details/gcs.md#adjust-pbm-configuration-to-use-gcs) for guidance on adjusting PBM configuration to use JSON keys.
+
+We will end-of-life HMAC support and remove it in the PBM release after April 30, 2026.
+
+
+## Changelog
+
+### New features
+
+- [PBM-1588](https://perconadev.atlassian.net/browse/PBM-1588) - Percona Backup for MongoDB now supports Alibaba Cloud Object storage Service (OSS) as the remote backup storage (Thank you Imre Nagi for reporting and contributing to this feature).
+
+- [PBM-1631](https://perconadev.atlassian.net/browse/PBM-1631) - Use MinIO client for S3-compatible storage to improve compatibility.
+
+
+### Improvements
+
+- [PBM-1321](https://perconadev.atlassian.net/browse/PBM-1321) - Improved PBM logs for logical backups by providing clearer status messages during the backup process.
+
+- [PBM-1593](https://perconadev.atlassian.net/browse/PBM-1593) - Interrupted downloads from Azure Blob storage now automatically resume, preventing restore failures due to temporary network issues (Thank you Daniel Oliver for reporting and contributing to this issue).
+
+- [PBM-1628](https://perconadev.atlassian.net/browse/PBM-1628) - Backups to Google Cloud Storage (GCS) are now more resilient to temporary network interruptions.
+
+## Fixed bugs
+
+- [PBM-1093](https://perconadev.atlassian.net/browse/PBM-1093) - Added the ability to retry data upload to Azure Blob storage in case of connection issues, ensuring reliable backups.
+
+- [PBM-1594](https://perconadev.atlassian.net/browse/PBM-1594) -  Fixed the issue with backups failing to be uploaded due to data chunks exceeding the limit when HTTPS connection is used with MinIO. The issue is fixed by adding a MinIO client library (Thank you Rama Mekala for reporting this issue).
+
+- [PBM-1605](https://perconadev.atlassian.net/browse/PBM-1605) - Fixed the issue with PBM marking incomplete backups as successful without logging errors during network disruptions and when HMAC keys are used for accessing Google Cloud Storage. PBM now calculates Cyclic Redundancy Check (CRC) and compares it with GCS generated one, reporting the error in case of mismatch. 
+
+- [PBM-1607](https://perconadev.atlassian.net/browse/PBM-1607) - Fixed the issue with already uploaded files remaining on the storage if the backup failed by correctly reporting the actual error in logs
+
+- [PBM-1610](https://perconadev.atlassian.net/browse/PBM-1610) - Fixed the issue with data upload to a custom S3-compatible storage that was caused by a new upload algorithm introduced in AWS SDK v2 by adding a MinIO Go client library that resolves compatibility issues for custom S3-compatible storage services.
+
+- [PBM-1619](https://perconadev.atlassian.net/browse/PBM-1619) - Fixed the issue with PBM failing with segmentation fault (segfault) on invalid configuration by introducing basic checks and returning the meaningful error message on failed check. (Thank you Neha Oudin for reporting and contributing to this issue)
+
+- [PBM-1627](https://perconadev.atlassian.net/browse/PBM-1627) - GCS storage retry configurations now correctly interpret time units (e.g., '60s') and include a new `ChunkRetryDeadline` setting to manage upload timeouts.
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -276,7 +276,8 @@ nav:
   - Release notes:
       - release-notes.md
       - PBM 2.x:
-        - "{{pbm.full_name}} 2.11.0 ({{date.2_11_0}})": release-notes/2.11.0.md
+        - "{{pbm.full_name}} 2.12.0 ({{date.2_12_0}})": release-notes/2.12.0.md
+        - release-notes/2.11.0.md
         - release-notes/2.10.0.md
         - release-notes/2.9.1.md
         - release-notes/2.9.0.md
diff --git a/variables.yml b/variables.yml
@@ -1,13 +1,14 @@
 # PBM Variables set for HTML output
 # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path
 
-release: '2.11.0'
-version: '2.11'
+release: '2.12.0'
+version: '2.12'
 year: '2025'
 
 pbm:
   full_name: 'Percona Backup for MongoDB'
 date:
+  2_12_0: 2025-11-04
   2_11_0: 2025-09-25
   2_10_0: 2025-06-26
   2_9_1: 2025-03-27
