Skip to content

Commit 3cb73a1

Browse files
steverensteveren
authored
Merge pull request #141 from steveren/DOCSP-11128 
2 parents 92927a0 + 4cbc969 commit 3cb73a1

File tree

5 files changed

+294
-0
lines changed

5 files changed

+294
-0
lines changed

‎conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@
6767
'aagent': 'Automation Agent',
6868
'magent': 'Monitoring Agent',
6969
'bagent': 'Backup Agent',
70+
'data-lake': 'Atlas Data Lake',
71+
'data-lake-short': 'Data Lake',
72+
'data-lake-stores': 'data stores',
73+
'data-lake-store': 'data store'
7074
}
7175

7276
rst_epilog = '\n'.join([

‎source/includes/atlas-datalake-output-fields.rst

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 10 10 80
4+
5+
* - Name
6+
- Type
7+
- Description
8+
9+
* - ``cloudProviderConfig``
10+
- object
11+
- Configuration information related to the cloud service where
12+
{+data-lake+} source data is stored.
13+
14+
* - ``cloudProviderConfig.<provider>``
15+
- object
16+
- Name of the provider of the cloud service where {+data-lake-short+}
17+
can access the S3 Bucket data stores.
18+
19+
{+data-lake-short+} only supports ``AWS``.
20+
21+
* - ``cloudProviderConfig.aws.
22+
iamAssumedRoleARN``
23+
- string
24+
- Amazon Resource Name (ARN) of the IAM Role that
25+
{+data-lake-short+} assumes when accessing S3 Bucket
26+
{+data-lake-stores+}.
27+
28+
The IAM Role must support the following actions against each
29+
S3 bucket:
30+
31+
- ``s3:GetObject``
32+
- ``s3:ListBucket``
33+
- ``s3:GetObjectVersion``
34+
35+
For more information on S3 actions, see
36+
`Actions, Resources, and Condition Keys for Amazon S3
37+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html>`_.
38+
39+
* - ``dataProcessRegion``
40+
- Optional
41+
- The cloud provider region to which {+data-lake+} routes
42+
client connections for data processing.
43+
44+
If ``null``, the {+data-lake+} routes client connections to the
45+
region nearest to the client based on DNS resolution.
46+
47+
* - ``dataProcessRegion.cloudProvider``
48+
- Required
49+
- Name of the cloud service provider.
50+
51+
{+data-lake+} only supports ``AWS``.
52+
53+
* - ``dataProcessRegion.region``
54+
- Required
55+
- Name of the region to which {+data-lake+} routes client
56+
connections for data processing.
57+
58+
{+data-lake+} only supports the following regions:
59+
60+
- ``SYDNEY_AUS`` (ap-southeast-2)
61+
- ``FRANKFURT_DEU`` (eu-central-1)
62+
- ``DUBLIN_IRL`` (eu-west-1)
63+
- ``LONDON_GBR`` (eu-west-2)
64+
- ``VIRGINIA_USA`` (us-east-1)
65+
- ``OREGON_USA`` (us-west-2)
66+
67+
* - ``groupId``
68+
- string
69+
- The unique identifier for the project.
70+
71+
* - ``hostnames``
72+
- array
73+
- The list of hostnames assigned to the {+data-lake+}. Each string
74+
in the array is a hostname assigned to the {+data-lake+}.
75+
76+
* - ``name``
77+
- string
78+
- Name of the {+data-lake+}.
79+
80+
* - ``state``
81+
- string
82+
- Current state of the {+data-lake+}:
83+
84+
- ``ACTIVE`` - The {+data-lake-short+} is active and
85+
verified. You can query the
86+
{+data-lake-stores+} associated to the {+data-lake+}.
87+
88+
- ``UNVERIFIED`` - The {+data-lake+} has an incomplete
89+
configuration *or* the provided credentials do not grant
90+
the access to the {+data-lake-stores+}.
91+
92+
For |aws| specifically, the
93+
provided ``cloudProviderConfig.aws.iamAssumedRoleARN``
94+
must grant access to the |aws| S3 buckets associated with any
95+
{+data-lake-stores+}.
96+
97+
* - ``storage``
98+
- object
99+
- Configuration details for each {+data-lake-store+} and its
100+
mapping to MongoDB database(s) and collection(s).
101+
102+
* - ``storage.databases``
103+
- object
104+
- Configuration details for mapping each {+data-lake-store+}
105+
to queryable databases and collections.
106+
107+
An empty object indicates that the {+data-lake-short+}
108+
has no mapping configuration for any {+data-lake-store+}.
109+
110+
* - ``storage.stores``
111+
- array
112+
- Each object in the array represents a {+data-lake-store+}.
113+
{+data-lake-short+} uses the ``storage.databases``
114+
configuration details to map data in each {+data-lake-store+}
115+
to queryable databases and collections.
116+
117+
An empty object indicates that the {+data-lake-short+} has
118+
no configured {+data-lake-stores+}.

‎source/reference/atlas.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ Atlas ``mongocli`` Commands
3434
:ref:`whitelist <mcli-reference-atlas-whitelist>`
3535
Manage :atlas:`whitelist </security-whitelist/>` entries.
3636

37+
:ref:`datalake <mcli-reference-atlas-datalake>`
38+
Retrieve information about `Data Lakes
39+
<https://docs.mongodb.com/datalake/>`__ associated with an |service|
40+
project.
41+
3742
.. class:: hidden
3843

3944
.. toctree::
@@ -48,3 +53,4 @@ Atlas ``mongocli`` Commands
4853
Metrics </reference/atlas/metric-commands>
4954
Processes </reference/atlas/process-commands>
5055
Whitelists </reference/atlas/whitelist-commands>
56+
Data Lakes </reference/atlas/datalake-commands>

‎source/reference/atlas/datalake-commands.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _mcli-reference-atlas-datalake:
2+
3+
============================
4+
Atlas ``datalake`` Commands
5+
============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
List Data Lakes </reference/atlas/datalake-list>

‎source/reference/atlas/datalake-list.txt

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
.. _mcli-atlas-datalake-list-command:
2+
3+
============================
4+
mongocli atlas datalake list
5+
============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``datalake list`` command retrieves all the
16+
`Data Lakes <https://docs.mongodb.com/datalake/>`__ associated with the
17+
specified |service| project. You can also retrieve all the Data Lakes through
18+
the `Data Lake API
19+
<https://docs.mongodb.com/datalake/reference/api/dataLakes-get-all-tenants>`__.
20+
21+
.. _datalake-list-syntax:
22+
23+
Syntax
24+
------
25+
26+
.. code-block:: text
27+
:copyable: false
28+
29+
mongocli atlas datalake list|ls
30+
[ --profile|-P <profile-name> ]
31+
[ --projectId <id-of-project> ]
32+
33+
.. include:: /includes/fact-command-line-help.rst
34+
35+
.. _datalake-list-options:
36+
37+
Options
38+
-------
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:widths: 20 10 60 10
43+
44+
* - Option
45+
- Type
46+
- Description
47+
- Required?
48+
49+
* - ``--profile``, ``-P``
50+
- string
51+
- Name of the profile where the public and private
52+
keys for the project are saved. If omitted, uses the
53+
{+default-profile+}. To learn more about creating a
54+
profile, see :ref:`mcli-configure`.
55+
- no
56+
57+
* - ``--projectId``
58+
- string
59+
- Unique identifier of the project that contains the
60+
cluster to update. If omitted, uses the project ID in
61+
the profile or :ref:`environment variable <mcli-env-var>`.
62+
- no
63+
64+
.. _datalake-list-output:
65+
66+
Output
67+
------
68+
69+
The command prints the following fields in |json| format to the
70+
terminal if the command succeeds. If the command returns
71+
errors, see :ref:`Troubleshooting <mcli-troubleshooting>` for
72+
recommended solutions.
73+
74+
The response |json| document contains an array of objects. Each object
75+
in the array describes one {+data-lake-short+} associated with the
76+
project:
77+
78+
.. include:: /includes/atlas-datalake-output-fields.rst
79+
80+
.. _datalake-list-examples:
81+
82+
Examples
83+
--------
84+
85+
The following example uses the ``mongocli atlas datalake list`` command
86+
to retrieve the list of Data Lakes in the specified project. It
87+
uses the {+default-profile+} to access the project.
88+
89+
.. code-block:: text
90+
:copyable: false
91+
92+
mongocli atlas cluster list --projectId 5e2211c17a3e5a48f5497de3
93+
94+
The previous command prints the following fields in |json| format to
95+
the terminal. To learn more about these fields, see
96+
:ref:`cluster-list-output`.
97+
98+
.. code-block:: json
99+
:copyable: false
100+
101+
[
102+
{
103+
"cloudProviderConfig": {
104+
"aws": {
105+
"iamAssumedRoleARN": "arn:aws:iam::772401394250:role/my-dl-role"
106+
}
107+
},
108+
"dataProcessRegion": {},
109+
"groupId": "5e2211c17a3e5a48f5497de3",
110+
"hostnames": [
111+
"my-data-lake-r4xmn.c.query.mongodb.net"
112+
],
113+
"name": "MyDataLake",
114+
"state": "ACTIVE",
115+
"storage": {
116+
"databases": [
117+
{
118+
"name": "data-lake-test",
119+
"collections": [
120+
{
121+
"name": "data",
122+
"dataSources": [
123+
{
124+
"storeName": "data-lake-test",
125+
"path": "data.json"
126+
}
127+
]
128+
},
129+
{
130+
"name": "*",
131+
"dataSources": [
132+
{
133+
"storeName": "data-lake-test",
134+
"path": "{collectionName()}"
135+
}
136+
]
137+
}
138+
]
139+
}
140+
],
141+
"stores": [
142+
{
143+
"name": "data-lake-test",
144+
"provider": "s3",
145+
"region": "US_WEST_2",
146+
"bucket": "data-lake-test",
147+
"delimiter": "/",
148+
"includeTags": false
149+
}
150+
]
151+
}
152+
}
153+
]
154+

0 commit comments

Comments
 (0)