DOCSP-11191 doc for onlinearchive pause command (#155)

* DOCSP-11191 doc for onlinearchive pause command

DOCSP-11192 self-review

* DOCSP-11191 content re-organization

* DOCSP-11191 minor fix

Author: kanchana-mongodb

source/reference/atlas.txt

@@ -54,7 +54,6 @@ Atlas ``mongocli`` Commands
       Events </reference/atlas/event-commands>
       Logs </reference/atlas/log-commands>
       Metrics </reference/atlas/metric-commands>
-      Online Archives </reference/atlas/onlinearchive-commands>
       Processes </reference/atlas/process-commands>
       Whitelists </reference/atlas/whitelist-commands>
       Data Lakes </reference/atlas/datalake-commands>

source/reference/atlas/cluster-commands.txt

@@ -17,4 +17,5 @@ Atlas ``cluster`` Commands
    Pause a Cluster </reference/atlas/cluster-pause>
    Resume a Cluster </reference/atlas/cluster-start>
    Watch a Cluster </reference/atlas/cluster-watch>
+   Online Archives </reference/atlas/onlinearchive-commands>
    Create a Rolling Index </reference/atlas/clusters-indexes-create>

source/reference/atlas/onlinearchive-commands.txt

@@ -14,4 +14,5 @@ Atlas Online Archive Commands
 
    Create an Online Archive </reference/atlas/onlinearchive-create>
    Start an Online Archive </reference/atlas/onlinearchive-start>
+   Pause an Active Online Archive </reference/atlas/onlinearchive-pause>
 

source/reference/atlas/onlinearchive-create.txt

@@ -1,8 +1,8 @@
-.. _mcli-atlas-onlinearchive-create-command:
+.. _mcli-atlas-cluster-onlinearchive-create-command:
 
-===================================
-mongocli atlas onlinearchive create
-===================================
+===========================================
+mongocli atlas cluster onlinearchive create
+===========================================
 
 .. default-domain:: mongodb
 
@@ -18,14 +18,14 @@ The ``onlinearchive create`` command creates an :atlas:`online archive
 </online-archive/manage-online-archive/>` for the specified collection in the ``M10`` or higher cluster. You can also create an online archive through the 
 |service| :atlas:`UI </online-archive/configure-online-archive/>` or :atlas:`API </reference/api/online-archive-create-one/>`.
 
-.. _mcli-atlas-online-archive-create-syntax:
+.. _mcli-atlas-cluster-online-archive-create-syntax:
 
 Syntax 
 ------
 
 .. code-block:: text 
 
-   mongocli atlas onlinearchive create 
+   mongocli atlas cluster onlinearchive create 
         --archiveAfter <number-of-days> 
         --clusterName <cluster-name>
         --collection <collection-name>
@@ -35,7 +35,7 @@ Syntax
         [ --profile|-P <profile-name> ]
         [ --projectId <project-ID> ]
 
-.. _mcli-atlas-onlinearchive-create-options: 
+.. _mcli-atlas-cluster-onlinearchive-create-options: 
 
 Options 
 -------
@@ -49,27 +49,27 @@ Options
      - Description
      - Required?
 
-   * - ``archiveAfter``
+   * - ``--archiveAfter``
      - int 
      - Number of days after which to archive cluster data.
      - yes
 
-   * - ``clusterName``
+   * - ``--clusterName``
      - string
      - Name of the cluster. 
      - yes
 
-   * - ``collection``
+   * - ``--collection``
      - string
      - Name of the collection for which to create an online archive.
      - yes
 
-   * - ``dateField``
+   * - ``--dateField``
      - string
      - Name of an already indexed date field from the documents.
      - yes
 
-   * - ``db``
+   * - ``--db``
      - string
      - Name of the database that contains the collection.
      - yes
@@ -100,7 +100,7 @@ Options
        :ref:`environment variable <mcli-env-var>`.
      - no
 
-.. _mcli-atlas-onlinearchive-create-output: 
+.. _mcli-atlas-cluster-onlinearchive-create-output: 
 
 Output 
 ------
@@ -109,7 +109,7 @@ Output
 
 .. include:: /includes/atlas-online-archive-output.rst
 
-.. _mcli-atlas-onlinearchive-create-egs:
+.. _mcli-atlas-cluster-onlinearchive-create-egs:
 
 Examples 
 --------
@@ -129,7 +129,7 @@ The following examples show two ways to create an online archive using the ``mon
 
       The previous command prints the following fields in |json| format to the 
       terminal. To learn more about these fields, see 
-      :ref:`mcli-atlas-onlinearchive-create-output`.
+      :ref:`mcli-atlas-cluster-onlinearchive-create-output`.
 
       .. code-block:: sh
          :copyable: false 
@@ -161,7 +161,7 @@ The following examples show two ways to create an online archive using the ``mon
 
       The previous command prints the following fields in |json| format to the 
       terminal. To learn more about these fields, see 
-      :ref:`mcli-atlas-onlinearchive-create-output`.
+      :ref:`mcli-atlas-cluster-onlinearchive-create-output`.
 
       .. code-block:: sh
          :copyable: false 

source/reference/atlas/onlinearchive-pause.txt

@@ -0,0 +1,132 @@
+.. _mcli-atlas-onlinearchive-pause-command:
+
+==========================================
+mongocli atlas cluster onlinearchive pause
+==========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. include:: /includes/fact-online-archive-beta.rst
+
+The ``onlinearchive pause`` command pauses an active :atlas:`online archive 
+</online-archive/manage-online-archive/>` for the specified cluster. You can 
+also pause an online archive through the |service| :atlas:`UI 
+</online-archive/pause-resume-online-archive/>` or :atlas:`API 
+</reference/api/online-archive-update-one/>`.
+
+.. _mcli-atlas-cluster-online-archive-pause-syntax:
+
+Syntax 
+------
+
+.. code-block:: text 
+
+   mongocli atlas cluster onlinearchive pause <online-archive-id>
+        --clusterName <cluster-name>  
+        [ --profile|-P <profile-name> ]
+        [ --projectId <project-ID> ]
+
+.. _mcli-atlas-cluster-onlinearchive-pause-options: 
+
+Options 
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option
+     - Type
+     - Description
+     - Required?
+
+   * - ``<online-archive-id>``
+     - string 
+     - Unique identifier of the online archive to pause.
+     - yes
+
+   * - ``--clusterName``
+     - string
+     - Name of the cluster. 
+     - yes
+
+   * - ``--profile``, ``-P``
+     - string
+     - Name of the profile where the public and private 
+       keys for the project are saved. If omitted, uses the 
+       {+default-profile+}. To learn more about creating a 
+       profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project that contains the 
+       cluster. If omitted, uses the project ID in the profile or 
+       :ref:`environment variable <mcli-env-var>`.
+     - no
+
+.. _mcli-atlas-cluster-onlinearchive-pause-output: 
+
+Output 
+------
+
+.. include:: /includes/command-output-intro.rst
+
+.. include:: /includes/atlas-online-archive-output.rst
+
+.. _mcli-atlas-cluster-onlinearchive-pause-egs:
+
+Examples 
+--------
+
+The following example uses the ``mongocli atlas cluster onlinearchive pause`` 
+command to pause the specified online archive in the cluster named 
+``myTestCluster``. It uses the {+default-profile+} to access the project.
+
+.. code-block:: sh
+
+   mongocli atlas cluster onlinearchive pause 5f189832e26ec075e10c32d3 --clusterName myTestCluster
+
+The previous command prints the following fields in |json| format to 
+the terminal. To learn more about these fields, see 
+:ref:`mcli-atlas-cluster-onlinearchive-pause-output`.
+
+.. code-block:: json 
+   :copyable: false 
+
+   {
+	 "_id": "5f189832e26ec075e10c32d3",
+	 "clusterName": "myTestCluster",
+	 "collName": "movies",
+	 "criteria": {
+		"dateField": "released",
+		"expireAfterDays": 2
+	 },
+	 "dbName": "sample_mflix",
+	 "groupId": "5e2211c17a3e5a48f5497de3",
+	 "partitionFields": [
+		{
+			"fieldName": "title",
+			"fieldType": "string",
+			"order": 0
+		},
+		{
+			"fieldName": "year",
+			"fieldType": "int",
+			"order": 1
+		},
+		{
+			"fieldName": "released",
+			"fieldType": "date",
+			"order": 2
+		}
+	 ],
+	 "paused": true,
+	 "state": "PAUSED"
+   }

source/reference/atlas/onlinearchive-start.txt

@@ -1,8 +1,8 @@
-.. _mcli-atlas-onlinearchive-start-command:
+.. _mcli-atlas-cluster-onlinearchive-start-command:
 
-==================================
-mongocli atlas onlinearchive start
-==================================
+==========================================
+mongocli atlas cluster onlinearchive start
+==========================================
 
 .. default-domain:: mongodb
 
@@ -18,19 +18,19 @@ The ``onlinearchive start`` command starts the archiving process for the
 specified :atlas:`online archive </online-archive/manage-online-archive/>` 
 in the specified cluster. 
 
-.. _mcli-atlas-online-archive-start-syntax:
+.. _mcli-atlas-cluster-online-archive-start-syntax:
 
 Syntax 
 ------
 
 .. code-block:: text 
 
-   mongocli atlas onlinearchive start <online-archive-id>
+   mongocli atlas cluster onlinearchive start <online-archive-id>
         --clusterName <cluster-name>  
         [ --profile|-P <profile-name> ]
         [ --projectId <project-ID> ]
 
-.. _mcli-atlas-onlinearchive-start-options: 
+.. _mcli-atlas-cluster-onlinearchive-start-options: 
 
 Options 
 -------
@@ -50,7 +50,7 @@ Options
        </online-archive/manage-online-archive/>` to start.
      - yes
 
-   * - ``clusterName``
+   * - ``--clusterName``
      - string
      - Name of the cluster. 
      - yes
@@ -70,7 +70,7 @@ Options
        :ref:`environment variable <mcli-env-var>`.
      - no
 
-.. _mcli-atlas-onlinearchive-start-output: 
+.. _mcli-atlas-cluster-onlinearchive-start-output: 
 
 Output 
 ------
@@ -79,7 +79,7 @@ Output
 
 .. include:: /includes/atlas-online-archive-output.rst
 
-.. _mcli-atlas-onlinearchive-start-egs:
+.. _mcli-atlas-cluster-onlinearchive-start-egs:
 
 Example 
 -------
@@ -95,7 +95,7 @@ project.
 
 The previous command prints the following fields in |json| format to the 
 terminal. To learn more about these fields, see 
-:ref:`mcli-atlas-onlinearchive-start-output`. 
+:ref:`mcli-atlas-cluster-onlinearchive-start-output`. 
 
 .. code-block:: json 
    :copyable: false