Skip to content

Comments

PBM-1490-Documented the ability to set file size limit for large backups#298

Merged
nastena1606 merged 3 commits intomainfrom
PBM-1490-Doc-large-file-upload
Sep 25, 2025
Merged

PBM-1490-Documented the ability to set file size limit for large backups#298
nastena1606 merged 3 commits intomainfrom
PBM-1490-Doc-large-file-upload

Conversation

@nastena1606
Copy link
Collaborator

modified: docs/details/storage-configuration.md
new file: docs/features/split-merge-backup.md
modified: mkdocs-base.yml
modified: docs/reference/configuration-options.md

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR documents the ability to set file size limits for large backups in Percona Backup for MongoDB (PBM). The documentation explains how PBM can split large backup files into smaller pieces when they exceed configured size limits.

  • Adds documentation for the maxObjSizeGB configuration parameter across all supported storage types
  • Creates a new feature documentation page explaining the split-merge backup functionality
  • Updates navigation to include the new documentation page

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
mkdocs-base.yml Adds navigation entry for the new split-merge backup documentation
docs/reference/configuration-options.md Documents the maxObjSizeGB parameter for S3, GCS, filesystem, and Azure storage types
docs/features/split-merge-backup.md New comprehensive documentation explaining how large backup file management works
docs/details/storage-configuration.md Minor grammar fix in existing content

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

numMaxRetries: 3
minRetryDelay: 30ms
maxRetryDelay: 5m
maxObjSizeGB: 5018
Copy link

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The maxObjSizeGB parameter appears under the filesystem storage section but should be at the same indentation level as filesystem to be a sibling of the storage type configuration, not nested within it.

Copilot uses AI. Check for mistakes.
modified:   docs/details/storage-configuration.md
        new file:   docs/features/split-merge-backup.md
        modified:   mkdocs-base.yml
        modified: docs/reference/configuration-options.md
Copy link
Member

@boris-ilijic boris-ilijic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to change type int->float64. The other comments are optional.


!!! admonition "Version added: [2.11.0](../release-notes/2.11.0.md)

As your database grows, so do your backups. Eventually, a backup file may become so large that it exceeds the maximum object size limit of your cloud or local storage. When this happens, Percona Backup for MongoDB (PBM) can't upload the file, which can disrupt your backup strategy.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually, a backup file (typically collection or index) ....

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworded


### storage.s3.maxObjSizeGB

*Type*: int <br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

float64


### storage.gcs.maxObjSizeGB

*Type*: int <br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

float64


### storage.filesystem.maxObjSizeGB

*Type*: int <br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

float64


### storage.azure.maxObjSizeGB

*Type*: int <br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

float64

| **Azure Blob Storage** | 190 TB |
| **Filesystem storage** | 4.9 TB |

To ensure that PBM successfully uploads backups, you can configure the maximum size for backup files for the storage you use. Define the file size in GB for the `maxObjSizeGB` configuration parameter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My recommendation is to add warning something like this:

We don't recommend modifying the maxObjSizeGB param. The default value is sufficient for most use cases, and setting it to a lower value can be dangerous as it may cause a single backup file to be split into a large number of smaller files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But what is the implication, does it affect performance or PBM won't be able to merge all those chunks together?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, mostly performance degradation. Also on the storage it'll be large number of files instead of single file of few of them, so it'll be harder to manage those (e.g. copy or browse), but I wouldn't mention that details.

@nastena1606 nastena1606 force-pushed the PBM-1490-Doc-large-file-upload branch from 2848435 to b55ee7f Compare September 15, 2025 09:31
@it-percona it-percona temporarily deployed to PBM-1490-Doc-large-file-upload - pbm-docs PR #298 September 15, 2025 09:31 — with Render Destroyed
@nastena1606 nastena1606 merged commit 9b1be41 into main Sep 25, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants