Skip to content

Commit 608f50f

Browse files
DOCSP-9785 Doc for storageGenerateConfig per ticket DOCSP-9785 (#7)
DOCSP-9785 toc fix
1 parent cb38daa commit 608f50f

File tree

1 file changed

+47
-6
lines changed

1 file changed

+47
-6
lines changed

source/config/config-data-lake.txt

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _config-datalake:
22

3-
===============================
4-
Configuring {+data-lake-short+}
5-
===============================
3+
=============================
4+
Configure {+data-lake-short+}
5+
=============================
66

77
.. default-domain:: mongodb
88

@@ -40,9 +40,8 @@ connecting a :binary:`~bin.mongo` shell to the {+data-lake-short+}:
4040

4141
.. note::
4242

43-
Any MongoDB user in the |service| project with the :atlas:`atlasAdmin
44-
<security-add-mongodb-users/#atlasAdmin>` role can retrieve and update
45-
the {+data-lake-short+} configuration.
43+
Any MongoDB user in the |service| project with the :authrole:`atlasAdmin`
44+
role can retrieve and update the {+data-lake-short+} configuration.
4645

4746
.. _datalake-getstorageconfig:
4847

@@ -78,6 +77,48 @@ Replace ``<config>`` with the {+data-lake-short+} configuration
7877
file. For complete documentation on the configuration fields and file
7978
format, see :ref:`datalake-configuration-format`.
8079

80+
.. _datalake-storagegenconfig:
81+
82+
Generate {+data-lake-short+} Configuration
83+
------------------------------------------
84+
85+
You can run the ``storageGenerateConfig`` command to regenerate a
86+
{+data-lake-short+} :ref:`configuration <datalake-configuration-file>`.
87+
The command returns an automatically generated :ref:`configuration
88+
<datalake-configuration-format>`, which you can then modify and
89+
:ref:`upload <datalake-setstorageconfig>`. In the automatically
90+
generated configuration, {+data-lake-short+} regenerates a
91+
:ref:`database <datalake-databases-reference>` for each :ref:`store
92+
<datalake-stores-reference>`:
93+
94+
- The :datalakeconf:`databases.[n].name` will be the same as the
95+
:datalakeconf:`stores.[n].name` that it maps to.
96+
- Each database will contain up to 3 collections and a wildcard (``*``)
97+
collection.
98+
99+
As a result, the :ref:`databases <datalake-databases-reference>`
100+
array in the generated configuration might be different from the
101+
:ref:`databases <datalake-databases-reference>` array in your existing
102+
configuration.
103+
104+
.. note::
105+
106+
You must have the ``storageSetConfig`` privilege to run the
107+
``storageGenerateConfig`` command. The :atlas:`atlasAdmin
108+
<security-add-mongodb-users/#atlasAdmin>` role has the
109+
``storageSetConfig`` privilege by default.
110+
111+
To generate a {+data-lake-short+} configuration, connect to the {+data-lake-short+}
112+
and run the following database commands:
113+
114+
.. code-block:: javascript
115+
116+
use admin
117+
db.runCommand( { "storageGenerateConfig" : 1 } )
118+
119+
For complete documentation on the configuration fields and file format, see :ref:`datalake-configuration-format`.
120+
121+
81122
.. class:: hidden
82123

83124
.. toctree::

0 commit comments

Comments
 (0)