diff --git a/docs/details/oss.md b/docs/details/oss.md new file mode 100644 index 00000000..ec55951f --- /dev/null +++ b/docs/details/oss.md @@ -0,0 +1,44 @@ +--- +title: Alicloud OSS storage +--- + +Percona Backup for MongoDB supports using [Alicloud OSS](https://www.alibabacloud.com/product/object-storage-service) for storing backups. + +To use Alicloud OSS, specify the following in the PBM configuration file: + +```yaml +storage: + type: oss + oss: + region: + endpointUrl: + bucket: + prefix: + credentials: + accessKeyId: + accessKeySecret: +``` + +## Configuration options + +| Name | Description | Default | +| :--- | :--- | :--- | +| `region` | The region where your bucket is located. | `ap-southeast-5` | +| `endpointUrl` | The endpoint URL for Alicloud OSS. | | +| `bucket` | The name of your bucket. | | +| `prefix` | The prefix for your backups. | | +| `credentials.accessKeyId` | The access key ID for your Alicloud account. | | +| `credentials.accessKeySecret` | The access key secret for your Alicloud account. | | +| `credentials.securityToken` | The security token for your Alicloud account. | | +| `credentials.roleArn` | The ARN of the RAM role to assume. | | +| `credentials.sessionName` | The session name for the assumed role. | | +| `uploadPartSize` | The size of each part for multipart uploads. | `10485760` (10MB) | +| `maxUploadParts` | The maximum number of parts for multipart uploads. | `10000` | +| `retryer.maxAttempts` | The maximum number of retry attempts for failed requests. | `5` | +| `retryer.maxBackoff` | The maximum backoff time for retries. | `300s` | +| `retryer.baseDelay` | The base delay for retries. | `30ms` | +| `connectTimeout` | The connection timeout for requests. | `5s` | + +You can get the `accessKeyId` and `accessKeySecret` from the Alicloud console. + +For more information on how to configure storage, see [PBM remote storage configuration](storage-configuration.md). diff --git a/docs/details/storage-configuration.md b/docs/details/storage-configuration.md index 3227d307..32e26059 100644 --- a/docs/details/storage-configuration.md +++ b/docs/details/storage-configuration.md @@ -27,6 +27,7 @@ Percona Backup for MongoDB supports the following storage types: * [S3-compatible storage](s3-storage.md) * [Filesystem server storage](filesystem-storage.md) * [Microsoft Azure Blob storage](azure.md) +* [Alicloud OSS storage](oss.md) ## Permissions setup diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 4dbfca46..fce43c90 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -232,6 +232,7 @@ nav: - details/gcs.md - details/filesystem-storage.md - details/azure.md + - Alicloud OSS storage: details/oss.md - features/multi-storage.md - PBM commands: reference/pbm-commands.md - Configuration file: