Skip to content

Commit ab65ec3

Browse files
DOCSP-15039 Support public S3 data stores with public config flag (#165)
* DOCSP-15039 Support public S3 data stores with public config flag DOCSP-15039 Support public S3 data stores with public config flag * DOCSP-15039 updates for review feedback * Apply suggestions from code review Co-authored-by: Melissa Mahoney <[email protected]> Co-authored-by: Melissa Mahoney <[email protected]>
1 parent bcfd658 commit ab65ec3

File tree

4 files changed

+29
-3
lines changed

4 files changed

+29
-3
lines changed

source/includes/s3-config-format.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
"additionalStorageClasses" : ["<string>"],
99
"prefix" : "<string>",
1010
"includeTags": <boolean>,
11-
"delimiter": "<string>"
11+
"delimiter": "<string>",
12+
"public": <boolean>
1213
}
1314
],
1415
"databases" : [

source/includes/s3-stores-config-format.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"additionalStorageClasses" : ["<string>"],
88
"prefix" : "<string>",
99
"delimiter" : "<string>",
10-
"includeTags": <boolean>
10+
"includeTags": <boolean>,
11+
"public": <boolean>
1112
}
1213
]

source/reference/cli/stores/create-store.txt

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Syntax
5353

5454
.. code-block:: sh
5555

56-
db.runCommand({ createStore: <store-name>, provider: <storage-provider>, region: <region-name>, bucket: <bucket-name>, additionalStorageClasses: [ <storage-classes> ], delimiter: <delimiter>, prefix: <prefix> })
56+
db.runCommand({ createStore: <store-name>, provider: <storage-provider>, region: <region-name>, bucket: <bucket-name>, additionalStorageClasses: [ <storage-classes> ], delimiter: <delimiter>, prefix: <prefix>, public: true|false })
5757

5858
.. tab:: Atlas Configuration
5959
:tabid: atlas
@@ -152,6 +152,19 @@ Parameters
152152
{+data-lake-store+}. If ommitted, defaults to ``"/"``.
153153
- no
154154

155+
* - ``public``
156+
- boolean
157+
- Flag that indicates whether or not the bucket is public.
158+
Valid values are:
159+
160+
- ``true`` to not use the |aws| |iam| role to access the
161+
bucket
162+
- ``false`` to require the |aws| |iam| role to access the
163+
bucket
164+
165+
If ommitted, defaults to ``false``.
166+
- no
167+
155168
* - ``prefix``
156169
- string
157170
- Value prepended to the ``path``. If ommitted, defaults to

source/reference/format/data-lake-configuration.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -539,6 +539,17 @@ The {+data-lake-short+} configuration has the following format:
539539
to |s3| to get the tags. This behavior might impact
540540
performance.
541541

542+
.. datalakeconf:: stores.[n].public
543+
544+
*Optional.* Specifies whether the bucket is public.
545+
546+
If set to ``true``, {+adl+} doesn't use the configured |aws|
547+
|iam| role to access the |s3| bucket. If set to ``false``,
548+
the configured |aws| |iam| must include permissions to access
549+
the |s3| bucket, even if that bucket is public.
550+
551+
If omitted, defaults to ``false``.
552+
542553
.. tab:: Atlas Cluster
543554
:tabid: atlas
544555

0 commit comments

Comments
 (0)