Skip to content

Commit 6788b4f

Browse files
nastena1606Copilot
andcommitted
Update docs/reference/configuration-options.md
Co-authored-by: Copilot <[email protected]>
1 parent 66fd87b commit 6788b4f

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

docs/details/minio.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,19 @@ After the bucket is created, apply the proper [permissions for PBM to use the bu
3636

3737
Percona Backup for MongoDB (PBM) needs its own dedicated S3 bucket exclusively for backup-related files. Ensure that this [bucket is created](#storage-bucket-creation) and managed solely by PBM.
3838

39-
This is the examples for the basic configuration of MinIO and other S3-compatible storages in Percona Backup for MongoDB. You can find [the configuration file template :octicons-link-external-16:](https://github.com/percona/percona-backup-mongodb/blob/v{{release}}/packaging/conf/pbm-conf-reference.yml) and uncomment the required fields.
39+
This is the example for the basic configuration of MinIO and other S3-compatible storages in Percona Backup for MongoDB. You can find [the configuration file template :octicons-link-external-16:](https://github.com/percona/percona-backup-mongodb/blob/v{{release}}/packaging/conf/pbm-conf-reference.yml) and uncomment the required fields.
4040

4141
```yaml
4242
storage:
4343
type: minio
4444
minio:
45-
endpoint: localhost:9100
46-
bucket: pbm-example
47-
prefix: data/pbm/test
48-
credentials:
49-
access-key-id: <your-access-key-id-here>
50-
secret-access-key: <your-secret-key-here>
45+
endpoint: localhost:9100
46+
region: us-east-1
47+
bucket: pbm-example
48+
prefix: data/pbm/test
49+
credentials:
50+
access-key-id: <your-access-key-id-here>
51+
secret-access-key: <your-secret-key-here>
5152
```
5253

5354
For the description of configuration options, see [Configuration file options](../reference/configuration-options.md).

docs/reference/configuration-options.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@
77
*Type*: string <br>
88
*Required*: YES
99

10-
Remote backup storage type. Supported values: `s3`, `minio`, `gcs`, `filesystem`, `azure`.
1110
Remote backup storage type. Supported values: `s3`, `minio`, `gcs`, `filesystem`, `azure`.
1211

13-
## AWS S3 storage options
1412
## AWS S3 storage options
1513

1614
```yaml
@@ -67,7 +65,6 @@ The name of the storage bucket. See the [AWS Bucket naming rules](https://docs.a
6765
6866
The location of the storage bucket.
6967
Use the [AWS region list](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) to define the bucket region
70-
Use the [AWS region list](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) to define the bucket region
7168
7269
### storage.s3.prefix
7370
@@ -88,7 +85,6 @@ The URL to access the bucket.
8885
*Type*: array of strings <br>
8986
*Required*: NO
9087
91-
The list of custom paths for `pbm-agents` on different servers to the same storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same S3 storage](../details/endpoint-map.md) section. Supported for Amazon S3 and Microsoft Azure Blob storages. Available with version 2.8.0.
9288
The list of custom paths for `pbm-agents` on different servers to the same storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same S3 storage](../details/endpoint-map.md) section. Supported for Amazon S3 and Microsoft Azure Blob storages. Available with version 2.8.0.
9389

9490
### storage.s3.forcePathStyle
@@ -294,7 +290,7 @@ storage:
294290
*Type*: string <br>
295291
*Required*: YES
296292

297-
The location of the storage bucket. Use the [AWS region list](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) to define the bucket region. If undefined, the default `us-east-1` region is used.
293+
The location of the storage bucket. Use the [AWS region list](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) to define the bucket region. If not specified, the default `us-east-1` region is used.
298294

299295
### storage.minio.bucket
300296

@@ -324,7 +320,7 @@ The network address (URL or IP) where your MinIO server is accessible.
324320
*Type*: array of strings
325321
*Required*: NO
326322

327-
The list of custom paths for `pbm-agents` on different servers to the same storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same S3 storage](../details/endpoint-map.md) section. Supported for Amazon S3 and Microsoft Azure Blob storages. Available with version 2.8.0.
323+
A mapping of custom endpoints for `pbm-agents` on different servers to the same MinIO storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same S3 storage](../details/endpoint-map.md) section. Supported for Amazon S3, MinIO, and Microsoft Azure Blob storages. Available with version 2.8.0.
328324

329325
### storage.minio.secure
330326

@@ -340,7 +336,7 @@ Defines whether to use HTTP or HTTPS protocol for communication between PBM and
340336
*Required*: NO
341337
*Default*: false
342338

343-
Disables the TLS verification of the S3 storage. This allows Percona Backup for MongoDB to upload data to S3-like storages that use self-issued TLS certificates. Use it with caution as it might leave a hole for man-in-the-middle attacks.
339+
Disables the TLS verification of the MinIO / S3-compatible storage. This allows Percona Backup for MongoDB to upload data to MinIO / S3-compatible storages that use self-issued TLS certificates. Use it with caution as it might leave a hole for man-in-the-middle attacks.
344340

345341
### storage.minio.forcePathStyle
346342

@@ -377,7 +373,9 @@ The MinIO session token used to validate the temporary security credentials for
377373
*Required*: NO
378374
*Default*: V4
379375

380-
Allows using the deprecated AWS Signature version 2. May be used for backward compatibility with the storages that don't support Signature version 4. Default: `V4`.
376+
Specifies the AWS Signature version to use for authentication. Accepted values: `V2`, `V4`.
377+
378+
Allows using the deprecated AWS Signature version 2 for backward compatibility with storages that don't support Signature version 4. Default: `V4`.
381379

382380
### storage.minio.partSize
383381

@@ -390,9 +388,9 @@ The size of data chunks in bytes to be uploaded to the storage bucket. Default:
390388

391389
*Type*: int
392390
*Required*: NO
393-
*Deafult*: 10
391+
*Default*: 10
394392

395-
The maximum number of retries to upload data to S3 storage. A zero value means no retries will be performed.
393+
The maximum number of retries to upload data to MinIO / S3-compatible storage. A zero value means no retries will be performed.
396394

397395
### storage.minio.maxObjSizeGB
398396

@@ -567,10 +565,10 @@ The URL to access the data in Microsoft Azure Blob Storage. The default value is
567565

568566
### storage.azure.endpointUrlMap
569567

570-
*Type*: array of strings <br>
568+
*Type*: object (host:port -> endpoint URL) <br>
571569
*Required*: NO
572570

573-
The list of custom paths for `pbm-agents` on different servers to the same storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same S3 storage](../details/endpoint-map.md) section. Available with version 2.8.0.
571+
A mapping of custom endpoint URLs for `pbm-agents` on different servers to the same remote storage. Use this option if `pbm-agents` reside on servers hidden behind different network configurations. Read more in the [Support for multiple endpoints to the same remote storage](../details/endpoint-map.md) section. Available with version 2.8.0.
574572

575573

576574
### storage.azure.prefix

0 commit comments

Comments
 (0)