|
1 | 1 | .. _config-datalake:
|
2 | 2 |
|
3 |
| -=============================== |
4 |
| -Configuring {+data-lake-short+} |
5 |
| -=============================== |
| 3 | +============================= |
| 4 | +Configure {+data-lake-short+} |
| 5 | +============================= |
6 | 6 |
|
7 | 7 | .. default-domain:: mongodb
|
8 | 8 |
|
@@ -40,9 +40,8 @@ connecting a :binary:`~bin.mongo` shell to the {+data-lake-short+}:
|
40 | 40 |
|
41 | 41 | .. note::
|
42 | 42 |
|
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. |
46 | 45 |
|
47 | 46 | .. _datalake-getstorageconfig:
|
48 | 47 |
|
@@ -78,6 +77,48 @@ Replace ``<config>`` with the {+data-lake-short+} configuration
|
78 | 77 | file. For complete documentation on the configuration fields and file
|
79 | 78 | format, see :ref:`datalake-configuration-format`.
|
80 | 79 |
|
| 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 | + |
81 | 122 | .. class:: hidden
|
82 | 123 |
|
83 | 124 | .. toctree::
|
|
0 commit comments