Skip to content

Add documentation for Alicloud OSS storage configuration #295

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for Alicloud OSS storage configuration #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 44 additions & 0 deletions docs/details/oss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: <region>
endpointUrl: <endpointUrl>
bucket: <bucket_name>
prefix: <prefix>
credentials:
accessKeyId: <access_key_id>
accessKeySecret: <access_key_secret>
```

## 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).
1 change: 1 addition & 0 deletions docs/details/storage-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions mkdocs-base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down