(DOCSP-31036) Adds example data federation config file.

Author: erabil-mdb

snooty.toml

@@ -25,6 +25,7 @@ toc_landing_pages = [
 
 [constants]
 aagent = "Automation Agent"
+adf = "Atlas Data Federation"
 atlas-cli = "Atlas CLI"
 atlas-cli-full = "MongoDB Atlas CLI"
 atlas-cli-version = "1.9.1"
@@ -42,6 +43,9 @@ data-lake-store = "data store"
 database-deployment = "database deployment"
 database-deployments = "database deployments"
 default-profile = ":ref:`default profile <mcli-profiles>`"
+df = "Data Federation"
+FDI = "Federated Database Instance"
+fdi = "federated database instance"
 mcli = "MongoDB CLI"
 mcli-long = "MongoDB Command Line Interface (``mongocli``)"
 mcli-version = "1.23.1"

source/includes/data-federation-instance-config-file.json

@@ -0,0 +1,71 @@
+{
+    "cloudProviderConfig": {
+      "aws": {
+        "externalId": "string",
+        "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
+        "iamUserARN": "string",
+        "roleId": "string"
+      }
+    },
+    "dataProcessRegion": {
+      "cloudProvider": "AWS",
+      "region": "SYDNEY_AUS"
+    },
+    "groupId": "32b6e34b3d91647abb20e7b8",
+    "hostnames": [
+      "string"
+    ],
+    "name": "string",
+    "state": "UNVERIFIED",
+    "storage": {
+      "databases": [
+        {
+          "collections": [
+            {
+              "dataSources": [
+                {
+                  "allowInsecure": false,
+                  "collection": "string",
+                  "collectionRegex": "string",
+                  "database": "string",
+                  "databaseRegex": "string",
+                  "defaultFormat": ".avro",
+                  "path": "string",
+                  "provenanceFieldName": "string",
+                  "storeName": "string",
+                  "urls": [
+                    "string"
+                  ]
+                }
+              ],
+              "name": "string"
+            }
+          ],
+          "maxWildcardCollections": 100,
+          "name": "string",
+          "views": [
+            {
+              "name": "string",
+              "pipeline": "string",
+              "source": "string"
+            }
+          ]
+        }
+      ],
+      "stores": [
+        {
+          "name": "string",
+          "provider": "string",
+          "additionalStorageClasses": [
+            "STANDARD"
+          ],
+          "bucket": "string",
+          "delimiter": "string",
+          "includeTags": false,
+          "prefix": "string",
+          "public": false,
+          "region": "US_GOV_WEST_1"
+        }
+      ]
+    }
+  }

source/reference/json/data-federation-config-file.txt

@@ -0,0 +1,81 @@
+.. _atlas-cli-data-federation-config-file:
+
+========================================
+{+adf+} Configuration File
+========================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can use an {+adf+} configuration file to specify the required 
+settings for :ref:`creating a federated database
+<atlas-data-federation>` using the {+atlas-cli+}. The 
+{+atlas-cli+} accepts ``.json`` {+df+} configuration files.
+
+Use the following resources to:
+
+- Learn the :ref:`required settings <required-dfi-settings>` you
+  can specify in the {+cluster+} configuration file.
+- View and copy :ref:`sample configuration files
+  <example-dfi-config-file>`.
+
+.. _required-dfi-settings:
+
+Required {+adf+} Settings
+---------------------------------------
+
+|service| requires the following settings to create a {+dfi+} with
+the {+atlas-cli+}. You must specify these {+dfi+} settings either in the configuration file or as flags in the command: 
+
+.. list-table:: 
+   :header-rows: 1 
+   :widths: 20 10 70 
+
+   * - Field 
+     - Type 
+     - Description 
+
+   * - ``cloudProviderConfig.aws``
+     - object
+     - Cloud provider linked to this {+dfi+}.
+
+   * - ``cloudProviderConfig.roleId``
+     - string
+     - Unique identifier of the role that the {+dfi+} can use to access the data stores.       
+       Required if specifying ``cloudProviderConfig``.
+
+   * - ``cloudProviderConfig.testS3Bucket``
+     - string
+     - Name of the |s3| data bucket that the provided role ID is authorized to access. Required if specifying ``cloudProviderConfig``.
+
+   * - ``dataProcessRegion.cloudProvider``
+     - string
+     - Name of the cloud service that hosts the {+dfi+}\'s data stores. For example, ``AWS``, ``GCP``, ``AZURE``, ``TENANT``, ``SERVERLESS``.
+
+   * - ``dataProcessRegion.region``
+     - string
+     - Name of the region to which the {+dfi+} routes client connections. For the full
+       list of available regions, see :ref:`Cloud Providers and Regions <create-cluster-cloud-provider-region>`.
+
+   * - ``name``
+     - string
+     - Human-readable label that identifies the {+dfi+}.
+
+   * - ``storage.stores.name``
+     - string
+     - Human-readable label that identifies the data store. 
+       The ``databases.[n].collections.[n].dataSources.[n].storeName`` field references 
+       this value as part of the mapping configuration. To use |service| as a data store, 
+       the {+dfi+} requires a serverless instance or an ``M10`` or higher {+cluster+}.
+
+   * - ``storage.stores.provider``
+     - string
+     - The :ref:`type of data store <config-adf>`. For example, ``atlas``, ``  
+
+
+For a full list of available settings, see
+the request body schema in the API specification:
+:oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>`.