Skip to content

Commit

Permalink
Update storage-configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
igroene authored Nov 26, 2024
1 parent 1b78222 commit f0b881f
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion docs/details/storage-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,59 @@ Percona Backup for MongoDB should work with other S3-compatible storages, but wa

* [MinIO :octicons-link-external-16:](https://min.io/)

#### Storage bucket creation

Here are some examples of the steps required to create a bucket.

=== "Amazon S3"

1. Install and configure [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)

2. Create an S3 bucket
```
aws s3api create-bucket --bucket my-s3-bucket --region us-east-1
```
3. Verify bucket creation
```
aws s3 ls
```

=== "Google Cloud Storage"

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

View workflow job for this annotation

GitHub Actions / vale

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

[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": 55, "column": 13}}}, "severity": "WARNING"}

1. Install and configure the [gcloud CLI](https://cloud.google.com/sdk/docs/install)

2. Create a bucket
```
gcloud storage buckets create my-gcs-bucket --location=US
```
3. Verify bucket creation
```
gcloud storage buckets list
```
=== "Minio"

Check failure on line 69 in docs/details/storage-configuration.md

View workflow job for this annotation

GitHub Actions / vale

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

[Vale.Spelling] Did you really mean 'Minio'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Minio'?", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 69, "column": 6}}}, "severity": "ERROR"}

1. Install [MinIO client](https://min.io/docs/minio/linux/reference/minio-mc.html#install-mc)

2. Configure mc with a MinIO Server
```
mc alias set myminio http://127.0.0.1:9000 MINIO_ACCESS_KEY MINIO_SECRET_KEY
```

3. Create a bucket
```
mc mb myminio/my-minio-bucket
```
4. Verify bucket creation
```
mc ls myminio
```

After the bucket is created, apply the proper [permissions for PBM to use the bucket](https://docs.percona.com/percona-backup-mongodb/details/storage-configuration.html#permissions-setup).

Check notice on line 88 in docs/details/storage-configuration.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Passive] In general, use active voice instead of passive voice ('is created').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is created').", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 88, "column": 18}}}, "severity": "INFO"}

#### Server-side encryption

Percona Backup for MongoDB supports [server-side encryption](../reference/glossary.md#server-side-encryption) for [S3 buckets](../reference/glossary.md#bucket) with the following encryption types:
Expand Down Expand Up @@ -216,4 +269,4 @@ Please refer to the documentation of your selected storage for the data access m
* Microsoft Azure documentation: [Assign an Azure role for access to blob data :octicons-link-external-16:](https://docs.microsoft.com/en-us/azure/storage/blobs/assign-azure-role-data-access?tabs=portal)
* MinIO documentation: [Policy Management :octicons-link-external-16:](https://docs.min.io/minio/baremetal/security/minio-identity-management/policy-based-access-control.html)

*[AWS KMS]: Amazon Web Services Key Management Service
*[AWS KMS]: Amazon Web Services Key Management Service

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Colons] ': A' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': A' should be in lowercase.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 272, "column": 11}}}, "severity": "WARNING"}

0 comments on commit f0b881f

Please sign in to comment.