Skip to content

PBM-1659 Added a section explaining what storage type to pick and under what conditions #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nastena1606 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

PBM-1659 Added a section explaining what storage type to pick and under what conditions #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6320c23
PBM-1659 Added a section explaining what storage type to pick and und…
nastena1606 Dec 24, 2025
aeb1d54
Update docs/details/storage-configuration.md
nastena1606 Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/details/minio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ This document provides an overview of MinIO as the closest S3-compatible storage

[Configuration example :material-arrow-down:](#configuration-example){.md-button}

## When to use the minio storage type

Use the `minio` storage type in the following scenarios:

* **S3-compatible storage with compatibility issues**: If you're using S3-compatible storage (such as MinIO, Ceph, or other S3 gateways) and encounter upload or download errors when using the `s3` storage type, switch to the `minio` storage type. Check the PBM logs for error messages indicating upload or download failures.

* **S3-compatible storage requiring specific configuration**: Some S3-compatible storage services may require endpoint configuration or other settings that work better with the `minio` storage type.

!!! tip

For S3-compatible storage, try the `s3` storage type first. Only switch to `minio` if you encounter compatibility issues or errors in the PBM logs.

## Bucket creation

1. Install a [MinIO client :octicons-link-external-16:](https://min.io/docs/minio/linux/reference/minio-mc.html#install-mc). After the installation, the `mc` is available for you.
Expand Down
1 change: 0 additions & 1 deletion docs/details/s3-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This document provides overview for the native AWS S3 services. To use MinIO and

[Configuration example :material-arrow-down:](#configuration-example){.md-button}


## Storage bucket creation

To create a bucket, do the following.
Expand Down
8 changes: 8 additions & 0 deletions docs/details/storage-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@
* [Microsoft Azure Blob storage](azure.md)
* [Alibaba Cloud OSS storage](oss.md)

### Considerations for choosing a backup storage type for s3-compatible storages

Check warning on line 22 in docs/details/storage-configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/details/storage-configuration.md#L22 

[Vale.Spelling] Did you really mean 'storages'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'storages'?", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 22, "column": 73}}}, "severity": "WARNING"}
Copy link

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

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

The heading uses lowercase 's3-compatible' which is inconsistent with the capitalized 'S3-compatible' used in the body text. Consider changing to 'S3-Compatible Storages' for consistency and better readability.

Suggested change
### Considerations for choosing a backup storage type for s3-compatible storages
### Considerations for choosing a backup storage type for S3-Compatible Storages

Copilot uses AI. Check for mistakes.

When configuring Percona Backup for MongoDB, choose the storage type based on your storage service:

* **AWS S3**: Use the `s3` storage type for native Amazon S3 storage.
* **S3-compatible storage**: For S3-compatible storage services that support Signature Version 4 (SigV4) used in AWS SDK v2, use the `s3` storage type. If you encounter upload or download errors in the PBM logs, switch to the `minio` storage type.
* **Google Cloud Storage**: Always use the dedicated `gcs` storage type. See [Google Cloud Storage](gcs.md) for configuration details.

Check warning on line 28 in docs/details/storage-configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/details/storage-configuration.md#L28 

[Google.WordList] Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.
Raw output 
{"message": "[Google.WordList] Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 28, "column": 12}}}, "severity": "WARNING"}

Check warning on line 28 in docs/details/storage-configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/details/storage-configuration.md#L28 

[Google.WordList] Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.
Raw output 
{"message": "[Google.WordList] Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 28, "column": 86}}}, "severity": "WARNING"}

## How PBM organizes backups on the storage

Percona Backup for MongoDB (PBM) saves backup data to a designated directory on the backup storage. It can be a specific directory you define for the storage or the root folder.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs-base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ nav:
- Backup management via PMM: pmm.md
- Storage:
- Remote backup storage overview: details/storage-configuration.md
- AWS storage: details/s3-storage.md
- AWS S3 storage: details/s3-storage.md
- details/minio.md
- details/gcs.md
- details/azure.md
Expand Down