Skip to content

Commit ab68e0b

Browse files
DOCSP-11137 doc for datalake create command (#144)
1 parent 784f213 commit ab68e0b

File tree

3 files changed

+169
-6
lines changed

3 files changed

+169
-6
lines changed

source/reference/atlas.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ Atlas ``mongocli`` Commands
1515
:ref:`cluster <mcli-reference-atlas-cluster>`
1616
Manage your |service| cluster configurations.
1717

18+
:ref:`datalake <mcli-reference-atlas-datalake>`
19+
Manage `Data Lakes <https://docs.mongodb.com/datalake/>`__ associated
20+
with an |service| project.
21+
1822
:ref:`dbuser <mcli-reference-atlas-dbuser>`
1923
Manage MongoDB database users.
2024

@@ -34,11 +38,6 @@ Atlas ``mongocli`` Commands
3438
:ref:`whitelist <mcli-reference-atlas-whitelist>`
3539
Manage :atlas:`whitelist </security-whitelist/>` entries.
3640

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-
4241
.. class:: hidden
4342

4443
.. toctree::

source/reference/atlas/datalake-commands.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Atlas ``datalake`` Commands
1010
:titlesonly:
1111

1212
List Data Lakes </reference/atlas/datalake-list>
13-
Describe a Data Lake </reference/atlas/datalake-describe>
13+
Describe a Data Lake </reference/atlas/datalake-describe>
14+
Create a Data Lake </reference/atlas/datalake-create>
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
.. _mcli-atlas-datalake-create-command:
2+
3+
==============================
4+
mongocli atlas datalake create
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 create`` command creates a MongoDB {+data-lake+}. You can also
16+
create a {+data-lake-short+} through the |service|
17+
`UI <https://docs.mongodb.com/datalake/tutorial/getting-started>`_ or `API
18+
<https://docs.mongodb.com/datalake/reference/api/dataLakes-create-one-tenant>`_.
19+
20+
.. _mcli-atlas-datalake-create-syntax:
21+
22+
Syntax
23+
------
24+
25+
.. code-block:: text
26+
27+
mongocli atlas datalake create <datalake-name>
28+
[ --profile|-P <profile-name> ]
29+
[ --projectId <project-ID> ]
30+
31+
.. _mcli-atlas-datalake-create-options:
32+
33+
Options
34+
-------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 60 10
39+
40+
* - Option
41+
- Type
42+
- Description
43+
- Required?
44+
45+
* - ``<datalake-name>``
46+
- string
47+
- Name of the {+data-lake-short+}.
48+
- yes
49+
50+
* - ``--profile``, ``-P``
51+
- string
52+
- Name of the profile where the public and private
53+
keys for the project are set. If omitted, uses the
54+
{+default-profile+}. To learn more about creating a
55+
profile, see :ref:`mcli-configure`.
56+
- no
57+
58+
* - ``--projectId``
59+
- string
60+
- Unique identifier of the project where you want to
61+
create the cluster. If omitted, uses the project ID in
62+
the profile or :ref:`environment variable <mcli-env-var>`.
63+
- no
64+
65+
.. _mcli-atlas-datalake-create-output:
66+
67+
Output
68+
------
69+
70+
.. include:: /includes/command-output-intro.rst
71+
72+
.. list-table::
73+
:header-rows: 1
74+
:widths: 10 10 80
75+
76+
* - Name
77+
- Type
78+
- Description
79+
80+
* - ``cloudProviderConfig``
81+
- object
82+
- Configuration information related to the cloud service where
83+
{+data-lake-short+} source data is stored.
84+
85+
* - ``cloudProviderConfig.aws``
86+
- object
87+
- Name of the provider of the cloud service where {+data-lake-short+}
88+
can access the S3 Bucket data stores.
89+
90+
* - ``dataProcessRegion``
91+
- object
92+
- Cloud provider region to which Atlas Data Lake routes client connections
93+
for data processing. If ``null``, {+data-lake-short+} routes client
94+
connections to the region nearest to the client based on DNS resolution.
95+
96+
* - ``groupId``
97+
- string
98+
- Unique identifier for the project.
99+
100+
* - ``hostnames``
101+
- array
102+
- The list of hostnames assigned to the {+data-lake-short+}. Each string in
103+
the array is a hostname assigned to the {+data-lake-short+}.
104+
105+
* - ``name``
106+
- string
107+
- Name of the {+data-lake-short+}.
108+
109+
* - ``state``
110+
- string
111+
- Current state of the {+data-lake-short+}:
112+
113+
- ``ACTIVE`` - The {+data-lake-short+} is active and verified. You can
114+
query the {+data-lake-stores+} associated to the {+data-lake-short+}.
115+
116+
- ``UNVERIFIED`` - The {+data-lake-short+} has an incomplete
117+
configuration *or* the provided credentials do not grant the access
118+
to the {+data-lake-stores+}.
119+
120+
121+
For |aws| specifically, the provided
122+
``cloudProviderConfig.aws.iamAssumedRoleARN`` must grant access to
123+
the |aws| S3 buckets associated with any {+data-lake-stores+}.
124+
125+
* - ``storage``
126+
- object
127+
- Configuration details for each {+data-lake-store+} and its
128+
mapping to MongoDB database(s) and collection(s). An empty object indicates that the Data Lake has no mapping configuration for any data store.
129+
130+
.. _mcli-atlas-datalake-create-egs:
131+
132+
Examples
133+
--------
134+
135+
The following example uses the ``mongocli atlas datalake create`` command to
136+
create a {+data-lake-short+} named ``myDL`` in the specified project. It uses
137+
the {+default-profile+} to access the project.
138+
139+
.. code-block:: sh
140+
:copyable: false
141+
142+
mongocli atlas datalake create myDL
143+
144+
The previous command prints the following fields in |json| format to the
145+
terminal. To learn more about these fields, see
146+
:ref:`mcli-atlas-datalake-create-output`.
147+
148+
.. code-block:: json
149+
:copyable: false
150+
151+
{
152+
"cloudProviderConfig": {
153+
"aws": {}
154+
},
155+
"dataProcessRegion": {},
156+
"groupId": "5e2211c17a3e5a48f5497de3",
157+
"hostnames": [
158+
"mydl-7hgjn.a.query.mongodb-dev.net"
159+
],
160+
"name": "myDL",
161+
"state": "UNVERIFIED",
162+
"storage": {}
163+
}

0 commit comments

Comments
 (0)