diff --git a/docs/details/minio.md b/docs/details/minio.md index 1c6b0cfe..4af2f9ea 100644 --- a/docs/details/minio.md +++ b/docs/details/minio.md @@ -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. diff --git a/docs/details/s3-storage.md b/docs/details/s3-storage.md index 6f1d5228..5ab60e0c 100644 --- a/docs/details/s3-storage.md +++ b/docs/details/s3-storage.md @@ -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. diff --git a/docs/details/storage-configuration.md b/docs/details/storage-configuration.md index fa6cc37e..5f49941f 100644 --- a/docs/details/storage-configuration.md +++ b/docs/details/storage-configuration.md @@ -19,6 +19,14 @@ Percona Backup for MongoDB supports the following storage types: * [Microsoft Azure Blob storage](azure.md) * [Alibaba Cloud OSS storage](oss.md) +### Considerations for choosing a backup storage type for s3-compatible storages + +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. + ## 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. diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 2edd43dc..3c86a2c9 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -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