Skip to content
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

Igroene patch 5 #232

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

Igroene patch 5 #232

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
1b78222
Update backup-storage.md
igroene Nov 26, 2024
f0b881f
Update storage-configuration.md
igroene Nov 26, 2024
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
55 changes: 54 additions & 1 deletion docs/details/storage-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,59 @@

* [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 @@
* 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"}
9 changes: 6 additions & 3 deletions docs/install/backup-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

The storage configuration itself is out of scope of the present document. We assume that you have configured one of the supported remote backup storages and provisioned access keys with the proper permissions for PBM. See [Remote Backup Storage](../details/storage-configuration.md) for more details.

<i info>:material-information: Info:</i> Percona Backup for MongoDB needs its own dedicated S3 bucket exclusively for backup-related files. Ensure that this bucket is created and managed solely by PBM.
!!! Info

Percona Backup for MongoDB needs its own dedicated S3 bucket exclusively for backup-related files. Ensure that this bucket is created and managed solely by PBM.

{.power-number}

1. Create a config file (e.g. `pbm_config.yaml`).
Expand Down Expand Up @@ -51,7 +54,7 @@
key: <your-access-key>
```

=== ":material-file-tree: Local Filesystem"
=== ":material-file-tree: Shared Local Filesystem"

Check warning on line 57 in docs/install/backup-storage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/backup-storage.md#L57 

[Google.Colons] ': S' should be in lowercase.
Raw output 
{"message": "[Google.Colons] ': S' should be in lowercase.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 57, "column": 29}}}, "severity": "WARNING"}

```yaml
storage:
Expand All @@ -72,4 +75,4 @@

## Next steps

[Start `pbm-agent` :material-arrow-right:](start-pbm-agent.md){.md-button}
[Start `pbm-agent` :material-arrow-right:](start-pbm-agent.md){.md-button}