Merge pull request #249 from jvincent-mongodb/DOCSP-34286

DOCSP-34286 -- Add Online Archive Create and Update JSON config options page

Author: jvincent-mongodb

source/includes/online-archive-create.json

@@ -0,0 +1,28 @@
+{
+    "name":"myCluster",
+    "groupId": "32y6e74b3g91947azb20e3b8",
+    "collName": "myCollection",
+    "collectionType": "TIMESERIES",
+    "criteria": {
+      "type": "DATE"
+    },
+    "dataExpirationRule": {
+      "expireAfterDays": 7
+    },
+    "dataProcessRegion": {
+      "cloudProvider": "AWS",
+      "region": "US_EAST_1"
+    },
+    "dbName": "myDB",
+    "partitionFields": [
+      {
+        "fieldName": "exampleField",
+        "order": 0
+      }
+    ],
+    
+    "paused": true,
+    "schedule": {
+      "type": "DEFAULT"
+    }
+  }

source/includes/online-archive-update.json

@@ -0,0 +1,15 @@
+{
+    "name":"myCluster",
+    "groupId": "32y6e74b3g91947azb20e3b8",
+    "archiveId":"32y6e74b3g32y6e74b3gyb45",
+    "criteria": {
+      "type": "DATE"
+    },
+    "dataExpirationRule": {
+      "expireAfterDays": 7
+    },
+    "paused": true,
+    "schedule": {
+      "type": "DEFAULT"
+    }
+  }

source/reference/json.txt

@@ -142,4 +142,5 @@ see :ref:`example-alert-config-file`.
    Cloud Backup Schedule </reference/json/cloud-backup-schedule-config-file>
    Atlas Data Federation </reference/json/data-federation-config-file>
    Atlas Search Index </reference/json/search-index-config-file>
+   Online Archive </reference/json/file-options-online-archive>
    Alert </reference/json/alert-config-file>

source/reference/json/file-options-online-archive.txt

@@ -0,0 +1,114 @@
+.. _atlas-cli-file-options-online-archive-file:
+
+========================================
+Online Archive Configuration File
+========================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can use a configuration file to specify the required  
+settings for creating and updating an online archive using the 
+{+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` online archive 
+configuration files.
+
+Use the following resources to:
+
+- Learn the :ref:`required settings <required-oa-settings>` you 
+  can specify in the online archive 
+
+- View and copy :ref:`sample configuration files <example-oa-config-file>`.
+
+.. _required-oa-settings:
+
+Online Archive Settings
+-----------------------
+
+You can specify the following settings to create or 
+update an online archive either in the configuration 
+file or as flags in the command:
+
+.. list-table:: 
+   :header-rows: 1 
+   :widths: 20 10 70 
+
+   * - Field 
+     - Type 
+     - Description 
+
+   * - ``groupId``
+     - string
+     - Unique identifier for your project. Your ``groupId`` is the same 
+       as your ``projectId``. For existing groups, your 
+       ``groupId`` and ``projectId`` remains the same. 
+       The resource and corresponding endpoints use the term groups.
+
+   * - ``archiveID``
+     - string
+     - Unique 24-hexadecimal digit string that identifies 
+       the online archive to update.
+  
+   * - ``clusterName``
+     - string
+     - Human-readable label that identifies the cluster that contains 
+       the collection for which you want to create or update one online archive.
+
+   * - ``collName``
+     - string
+     - The name of your collection.
+
+   * - ``criteria``
+     - object
+     - Rules by which MongoDB MongoDB Cloud archives data.
+
+   * - ``dbName``
+     - string
+     - Human-readable label of the database that 
+       contains the collection that contains the online archive.
+
+For detailed descriptions and a full list of available settings,
+see the request body schema in the API specification:
+
+- :oas-atlas-op:`Create One Online Archive </createOnlineArchive>`
+- :oas-atlas-op:`Update One Online Archive </updateOnlineArchive>`
+
+.. _example-oa-config-file:
+
+Example Online Archive Create Configuration File
+------------------------------------------------
+
+.. literalinclude:: /includes/online-archive-create.json
+
+
+Example Online Archive Update Configuration File
+------------------------------------------------
+
+.. literalinclude:: /includes/online-archive-update.json
+
+Example Online Archive Create Command
+-------------------------------------
+To create an online archive configuration, specify the ``--file`` option 
+and the path to the file. The following example creates an 
+online archive by using a configuration file named 
+``online-archive-create-config.json``:
+
+.. code-block::
+
+    atlas clusters onlineArchive create --file online-archive-create-config.json --output json
+
+Example Online Archive Update Command
+-------------------------------------
+To update an online archive configuration, specify the ``--file`` option 
+and the path to the file. The following example updates an 
+online archive by using a configuration file named 
+``online-archive-update-config.json``:
+
+.. code-block::
+
+    atlas clusters onlineArchive update --file online-archive-update-config.json --output json
+
+
+