Skip to content

Commit c1384fc

Browse files
davidhou17jwilliams-mongo
authored andcommitted
(DOCSP 25128): Document new support for s3RegionOverride (#1051)
* Document new support for s3RegionOverride * tech review feedback * copy review * Update source/reference/k8s-operator-om-specification.txt
1 parent 1732410 commit c1384fc

File tree

3 files changed

+62
-4
lines changed

3 files changed

+62
-4
lines changed

source/includes/steps-deploy-k8s-opsmgr-http.yaml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,18 @@ content: |
236236
- string
237237
- Name of the |s3| or |s3|-compatible bucket that stores the
238238
database Backup snapshots.
239-
- my-bucket
239+
- ``my-bucket``
240+
241+
* - | ``spec``
242+
| ``.backup``
243+
| ``.s3Stores``
244+
| ``.``:opsmgrkube:`~spec.backup.s3Stores.s3RegionOverride`
245+
- string
246+
- Region where your |s3|-compatible bucket resides. Use this
247+
field only if your |s3| store's
248+
:opsmgrkube:`s3BucketEndpoint <spec.backup.s3Stores.s3BucketEndpoint>`
249+
doesn't include a region in its |url|. Don't use this field with |aws| |s3| buckets.
250+
- ``us-east-1``
240251
241252
To configure a blockstore, configure the following settings:
242253

source/includes/steps-deploy-k8s-opsmgr-https.yaml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,18 @@ content: |
323323
- string
324324
- Name of the |s3| or |s3|-compatible bucket that stores the
325325
database Backup snapshots.
326-
- my-bucket
326+
- ``my-bucket``
327+
328+
* - | ``spec``
329+
| ``.backup``
330+
| ``.s3Stores``
331+
| ``.``:opsmgrkube:`~spec.backup.s3Stores.s3RegionOverride`
332+
- string
333+
- Region where your |s3|-compatible bucket resides. Use this
334+
field only if your |s3| store's
335+
:opsmgrkube:`s3BucketEndpoint <spec.backup.s3Stores.s3BucketEndpoint>`
336+
doesn't include a region in its |url|. Don't use this field with |aws| |s3| buckets.
337+
- ``us-east-1``
327338
328339
To configure a blockstore, configure the following settings:
329340

source/reference/k8s-operator-om-specification.txt

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,6 +1282,12 @@ You can use |tls| for both |s3| and your application database, or for
12821282
URL of the |aws| |s3| bucket or |s3|-compatible bucket that hosts the
12831283
oplog store.
12841284

1285+
.. note::
1286+
1287+
If your endpoint doesn't include a region in its |url|,
1288+
specify the :opsmgrkube:`s3RegionOverride <spec.backup.s3OpLogStores.s3RegionOverride>`
1289+
field.
1290+
12851291
.. opsmgrkube:: spec.backup.s3OpLogStores.s3BucketName
12861292

12871293
*Type*: string
@@ -1291,6 +1297,18 @@ You can use |tls| for both |s3| and your application database, or for
12911297
Name of the |aws| |s3| bucket or |s3|-compatible bucket that hosts
12921298
the oplog store.
12931299

1300+
.. opsmgrkube:: spec.backup.s3OpLogStores.s3RegionOverride
1301+
1302+
*Type*: string
1303+
1304+
Region where your |s3|-compatible bucket resides. Use this
1305+
field only if your |s3| oplog store's
1306+
:opsmgrkube:`s3BucketEndpoint <spec.backup.s3OpLogStores.s3BucketEndpoint>`
1307+
doesn't support region scoping. Region scoping is when your endpoint doesn't include a region in its |url|.
1308+
1309+
Don't use this field with |aws| |s3| buckets. For more information, see
1310+
:opsmgr:`S3 Blockstore Configuration </reference/api/admin/backup/snapshot/s3Configs/create-one-s3-blockstore-configuration/>`.
1311+
12941312
.. opsmgrkube:: spec.backup.s3Stores.customCertificate
12951313

12961314
*Type*: boolean
@@ -1422,7 +1440,13 @@ You can use |tls| for both |s3| and your application database, or for
14221440
*Required if you enable Backup using an S3 store.*
14231441

14241442
URL of the |aws| |s3| bucket or |s3|-compatible bucket that hosts the
1425-
snapshot store.
1443+
snapshot store.
1444+
1445+
.. note::
1446+
1447+
If your endpoint doesn't include a region in its |url|,
1448+
specify the :opsmgrkube:`s3RegionOverride <spec.backup.s3Stores.s3RegionOverride>`
1449+
field.
14261450

14271451
.. opsmgrkube:: spec.backup.s3Stores.s3BucketName
14281452

@@ -1431,4 +1455,16 @@ You can use |tls| for both |s3| and your application database, or for
14311455
*Required if you enable Backup using an S3 store.*
14321456

14331457
Name of the |aws| |s3| bucket or |s3|-compatible bucket that hosts
1434-
the snapshot store.
1458+
the snapshot store.
1459+
1460+
.. opsmgrkube:: spec.backup.s3Stores.s3RegionOverride
1461+
1462+
*Type*: string
1463+
1464+
Region where your |s3|-compatible bucket resides. Use this
1465+
field only if your |s3| store's
1466+
:opsmgrkube:`s3BucketEndpoint <spec.backup.s3Stores.s3BucketEndpoint>`
1467+
doesn't support region scoping. Region scoping is when your endpoint doesn't include a region in its |url|.
1468+
1469+
Don't use this field with |aws| |s3| buckets. For more information, see
1470+
:opsmgr:`S3 Blockstore Configuration </reference/api/admin/backup/snapshot/s3Configs/create-one-s3-blockstore-configuration/>`.

0 commit comments

Comments
 (0)