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

Update backup-storage.md #194

Closed
wants to merge 4 commits into from
Closed

Update backup-storage.md #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d483356
Update backup-storage.md
igroene Aug 7, 2024
f679dc7
Update storage-config-example.md
igroene Aug 7, 2024
2cf8682
Update backup-storage.md
igroene Aug 7, 2024
c1763c8
Update backup-storage.md
igroene Aug 7, 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
2 changes: 1 addition & 1 deletion docs/details/storage-config-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ storage:
storage:
type: s3
s3:
region: us-east1
region: northamerica-northeast1
bucket: pbm-testing
prefix: pbm/test
endpointUrl: https://storage.googleapis.com
Expand Down
30 changes: 21 additions & 9 deletions docs/install/backup-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@

The easiest way to provide remote backup storage configuration is to specify it in a YAML config file and upload this file to Percona Backup for MongoDB using `pbm` CLI.

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.
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.
{.power-number}

1. Create a config file (e.g. `pbm_config.yaml`).

2. Specify the storage information within.

The following is the sample configuration for Amazon AWS:
=== "Amazon AWS"

```yaml
storage:
Expand All @@ -26,7 +24,22 @@ The storage configuration itself is out of scope of the present document. We ass
kmsKeyID: <your-kms-key-here>
```

This is the sample configuration for Microsoft Azure Blob storage:
=== "Google Cloud Storage"

```yaml
storage:
type: s3
s3:
region: northamerica-northeast1
bucket: pbm-testing
prefix: pbm/test
endpointUrl: https://storage.googleapis.com
credentials:
access-key-id: <your-access-key-id-here>
secret-access-key: <your-secret-key-here>
```

=== "Microsoft Azure Blob Storage"

```yaml
storage:
Expand All @@ -39,7 +52,7 @@ The storage configuration itself is out of scope of the present document. We ass
key: <your-access-key>
```

This is the sample configuration for filesystem storage:
=== "Local Filesystem"

```yaml
storage:
Expand All @@ -50,8 +63,7 @@ The storage configuration itself is out of scope of the present document. We ass

See more examples in [Configuration file examples](../details/storage-config-example.md).


3. Insert the config file
2. Apply the config file to PBM

```{.bash data-prompt="$"}
$ pbm config --file pbm_config.yaml
Expand All @@ -61,4 +73,4 @@ To learn more about Percona Backup for MongoDB configuration, see [Percona Backu

## 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}
Loading