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

Jump to bottom

PBM-1194 Added SSE-KMS configuration to SSE doc #140

Merged
merged 1 commit into from
Oct 6, 2023
Merged

PBM-1194 Added SSE-KMS configuration to SSE doc #140

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
19 changes: 14 additions & 5 deletions docs/details/storage-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,17 @@

Percona Backup for MongoDB supports [server-side encryption](../reference/glossary.md#server-side-encryption) for [S3 buckets](../reference/glossary.md#bucket) with customer-provided keys stored in AWS KMS (SSE-KMS).

Starting with version 2.0.1, Percona Backup for MongoDB also supports server-side encryption with customer-provided keys that stored on the client side (SSE-C). Percona Backup for MongoDB provides the encryption keys as part of the requests to the S3 storage. The S3 storage uses them to encrypt/decrypt the data using the AES-256 encryption algorithm. In such a way you save on subscribing to AWS KMS services and can use the server-side encryption with the S3-compatible storage of your choice.
To use the SSE-KMS encryption, specify the following parameters in the Percona Backup for MongoDB configuration file:

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 43, "column": 12}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 43, "column": 16}}}, "severity": "INFO"}

```yaml
serverSideEncryption:
kmsKeyID: <kms_key_ID>
sseAlgorithm: aws:kms
```

!!! admonition "Version added: [2.0.1](../release-notes/2.0.1.md)"

Percona Backup for MongoDB also supports server-side encryption with customer-provided keys that are stored on the client side (SSE-C). Percona Backup for MongoDB provides the encryption keys as part of the requests to the S3 storage. The S3 storage uses them to encrypt/decrypt the data using the `AES-256` encryption algorithm. In such a way you save on subscribing to AWS KMS services and can use the server-side encryption with the S3-compatible storage of your choice.

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

View workflow job for this annotation

GitHub Actions / vale

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

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

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 53, "column": 128}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 53, "column": 129}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 53, "column": 372}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 53, "column": 376}}}, "severity": "INFO"}

!!! admonition ""

Expand All @@ -51,15 +61,14 @@
1. Enable/disable the server-side encryption only for the empty bucket. Otherwise, Percona Backup for MongoDB fails to save/retrieve objects to/from the storage properly.
2. S3 storage doesn't manage or store the encryption key. It is your responsibility to track what key was used to encrypt what object in the bucket. If you lose the key, any request for an object without the encryption key fails and you lose the object.

To use the SSE-C encryption, specify the following parameters in the Percona Backup for MongoDB configuration file:
To use the SSE-C encryption, specify the following parameters in the Percona Backup for MongoDB configuration file:

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.", "location": {"path": "docs/details/storage-configuration.md", "range": {"start": {"line": 64, "column": 12}}}, "severity": "INFO"}

```yaml
serverSideEncryption:
sseCustomerAlgorithm: AES256
sseCustomerKey: <your_encryption_key>
```


!!! admonition "See also"

AWS Documentation:
Expand Down Expand Up @@ -113,8 +122,8 @@

Percona Backup for MongoDB supports data upload to S3-like storage that supports self-issued TLS certificates. To make this happen, disable the TLS verification of the S3 storage in Percona Backup for MongoDB configuration:

```sh
pbm config --set storage.s3.insecureSkipTLSVerify=True
```{.bash data-prompt="$"}
$ pbm config --set storage.s3.insecureSkipTLSVerify=True
```

!!! warning
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Find the config file examples for the remote backup storage (required) in the [E

Use the following command to upload the config file. For example, config file name is `pbm_config.yaml`:

```sh
pbm config --file pbm_config.yaml
```{.bash data-prompt="$"}
$ pbm config --file pbm_config.yaml
```

Execute the command while connecting to config server replica set if it is a
Expand Down