DOCSP-42765 Backport DOCSP-39441 Regional Backup - API endpoints & Queryable Backup (#323) (#328)

<!-- Add a description of your PR here (optional) -->

- [DOCSP-42765](https://jira.mongodb.org/browse/DOCSP-42765)
- STAGING: -

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/admin/backup/deployment-regions-page/
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/core/backup-overview
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/assign-deployment-region
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/create-one-deployment-region-by-id
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/create-one-deployment-region
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/delete-one-deployment-region-by-id/
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/get-all-deployment-regions
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/get-one-backup-config-by-cluster-id
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/reference/api/backup/get-one-deployment-region-by-id
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/tutorial/convert-replica-set-to-sharded-cluster
-

https://preview-mongodbkanchanamongodb.gatsbyjs.io/ops-manager/DOCSP-42765/tutorial/query-backup
-
[Build](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=66bfcc6f8e811ae672902444)

### Self-Review Checklist

- [ ]
[Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions)
taxonomy
[values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top
of page.
- [ ] Add genre facets (tutorial or reference), as in this [example
PR](10gen/cloud-docs#5042).
- [ ] Add programmingLanguage (if necessary).
- [ ] Add meta keywords (if necessary).
- [ ] Resolve any new warnings or errors in the build.
- [ ] Proofread for spelling and grammatical errors.
- [ ] Check staging for rendering issues.
- [ ] Confirm links are working.

Co-authored-by: lmkerbey-mdb <[email protected]>

Author: kanchana-mongodb

source/admin/backup/deployment-regions-page.txt

@@ -20,6 +20,11 @@ regions. You then bind backup resources such as :ref:`snapshot stores
 </reference/glossary/#std-term-Backup-Daemon>` to these deployment
 regions.
 
+.. note:: 
+
+   You can't delete deployment regions that are currently bound to
+   backup resources. 
+
 The deployment region page lists all available deployment regions, and
 allows you to define new deployment regions.
 
@@ -45,6 +50,10 @@ allows you to define new deployment regions.
    restore, consider configuring network restrictions for your data
    centers.
 
+.. _deployment-regions-add:
+
+Add New Deployment Regions 
+--------------------------
 
 To define a new deployment region:
 
@@ -58,31 +67,82 @@ To define a new deployment region:
       In the :guilabel:`Set up a Deployment Region`
       window, provide values for the following fields:
 
-      .. list-table::
-         :widths: 40 60
-	 :header-rows: 1
+      .. include:: /includes/list-tables/deployment-regions/deployment-regions-with-id-ui.rst
+
+   .. step:: Click :guilabel:`Confirm`.
+
+.. _deployment-regions-edit:
+
+Edit a Deployment Region 
+------------------------
+
+To make changes to a deployment region, perform the following steps: 
 
-         * - Field
-	   - Value
+.. procedure::
+   :style: normal
+   
+   .. step:: Open the modal to edit a deployment region.
+
+      For the deployment region that you want to modify: 
 
-         * - Deployment ID
-	   - Unique identifier that references this deployment region
-	     in configurations.
+      a. Click the :icon:`ellipsis-h` in the :guilabel:`Actions` column.
+      #. Select :guilabel:`Edit` from the dropdown.
 
-         * - Ingestion Endpoint
-	   - |onprem| instance to which the
-	     :opsmgr:`Backup Agent </reference/glossary/#std-term-backup-agent>`
-	     writes snapshot or oplog data.
+         The :guilabel:`Set up a Deployment Region` modal displays.
 
-         * - Restore Endpoint
-	   - |onprem| instance that serves restore requests.
+   .. step:: Modify the deployment region.
 
-         * - Queryable Proxy Server Endpoint
-	   - |onprem| instance that serves
-	     :opsmgr:`Queryable Backup </reference/glossary/#std-term-queryable-backup>`
-	     requests.
+      In the :guilabel:`Set up a Deployment Region`
+      modal, make changes to any of the following fields:
 
-         * - Deployment Description
-	   - String that describes the purpose of the deployment region.
+      .. include:: /includes/list-tables/deployment-regions/deployment-regions-ui.rst
 
    .. step:: Click :guilabel:`Confirm`.
+
+.. _deployment-regions-assign:
+
+Assign a Deployment Region for a Shard 
+--------------------------------------
+
+To assign a deployment region to a new shard, perform the following
+steps:
+
+.. procedure::
+   :style: normal
+   
+   .. step:: Click the :guilabel:`Assign` button.
+
+      You can find the :guilabel:`Assign` button in the
+      :guilabel:`Continuous Backup` dashboard the following ways: 
+
+      - Hover over the cluster status :guilabel:`Misconfigured`.
+      - Click the :icon:`ellipsis-h` in the :guilabel:`Options` column. 
+
+      The :guilabel:`Start Backup` modal displays.
+
+   .. step:: Configure the deployment region.
+
+      Select a deployment region from the :guilabel:`Select region`
+      dropdown. You can't modify deployment regions configured for
+      existing members. 
+
+      .. note:: 
+
+         To change the deployment region for a member, you must first
+         stop and terminate the current backup job, and then start a new
+         backup job in the new region.
+
+      Ensure that the deployment region that you select has snapshot,
+      oplog, and sync stores configured for that region. |mms| displays
+      an error if there are no daemons bound to any of the selected
+      deployment regions. 
+
+   .. step:: Click :guilabel:`Start`.
+
+      When you assign a deployment region to a shard, |mms| does the
+      following: 
+      
+      - Assigns snapshot, oplog, and sync stores and daemons to the
+        backup jobs.
+      - Resumes oplog tailing and takes snapshots
+      - Resolves project alarms.

source/core/backup-overview.txt

@@ -166,3 +166,12 @@ region. Regional backup is available for replica sets and sharded
 clusters. To enable regional backup for a sharded cluster, you must
 assign deployment regions and initiate backup jobs for each shard
 separately.
+
+To determine whether regional backup is enabled in your deployment, you
+can check for the following in the :guilabel:`Continuous Backup`
+dashboard. 
+
+- :guilabel:`Backup Region` on the top right corner displays the group's
+  deployment region by default and if the project is enabled for
+  regional backup, it displays the legend :guilabel:`Multi-Region`. 
+- :guilabel:`Regional Backup` column displays in the dashboard.

source/includes/api/list-tables/deployment-regions/request-body.rst

@@ -0,0 +1,47 @@
+.. list-table::
+   :widths: 20 15 15 50
+   :header-rows: 1
+   :stub-columns: 1
+
+   * - Name
+     - Type
+     - Necessity
+     - Description
+
+   * - ``assignmentEnabled``
+     - boolean
+     - Optional
+     - Flag indicating whether you can assign :ref:`Deployment Regions
+       <deployment-regions-interface>` to backup resources.
+
+   * - ``bqProxyEndpoint``
+     - string
+     - Required
+     - |onprem| instance that serves :opsmgr:`Queryable Backup
+       </reference/glossary/#std-term-queryable-backup>` requests. Value
+       is in the following format: ``domain:port``. For example,
+       ``localhost:8080``.  
+
+   * - ``deploymentDescription``
+     - string
+     - Required
+     - String that describes the purpose of the deployment region. 
+
+   * - ``id``
+     - string
+     - Reguired
+     - Unique identifier that references this deployment region in
+       configurations.
+
+   * - ``ingestionEndpoint``
+     - string
+     - Reguired
+     - |onprem| instance to which the :opsmgr:`Backup Agent
+       </reference/glossary/#std-term-backup-agent>` writes snapshot or
+       oplog data. Value is a valid |url| such as
+       ``http://www.mongodb.com``. Supports both |http| and |https|. 
+
+   * - ``restoreEndpoint``
+     - string
+     - Required
+     - |onprem| instance that serves restore requests.

source/includes/api/list-tables/deployment-regions/response-body.rst

@@ -0,0 +1,44 @@
+.. list-table::
+   :widths: 20 14 66
+   :header-rows: 1
+   :stub-columns: 1
+
+   * - Name
+     - Type
+     - Description
+
+   * - ``assignmentEnabled``
+     - boolean
+     - Flag indicating whether you can assign :ref:`Deployment Regions
+       <deployment-regions-interface>` to backup resources.
+
+   * - ``bqProxyEndpoint``
+     - string
+     - |onprem| instance that serves :opsmgr:`Queryable Backup
+       </reference/glossary/#std-term-queryable-backup>` requests. Value
+       is in the following format: ``domain:port``. For example,
+       ``localhost:8080``.  
+
+   * - ``deploymentDescription``
+     - string
+     - String that describes the purpose of the deployment region.
+
+   * - ``id``
+     - string
+     - Unique identifier that references this deployment region in
+       configurations.  
+
+   * - ``ingestionEndpoint``
+     - string
+     - |onprem| instance to which the :opsmgr:`Backup Agent
+       </reference/glossary/#std-term-backup-agent>` writes snapshot or
+       oplog data. Value is a valid |url| such as
+       ``http://www.mongodb.com``. Supports both |http| and |https|.
+
+   * - ``links``
+     - object array
+     - .. include:: /includes/api/links-explanation.rst
+
+   * - ``restoreEndpoint``
+     - string
+     - |onprem| instance that serves restore requests.

source/includes/list-tables/deployment-regions/deployment-regions-ui.rst

@@ -0,0 +1,30 @@
+.. list-table::
+   :widths: 30 70
+   :header-rows: 1
+
+   * - Field 
+     - Value 
+
+   * - Ingestion Endpoint 
+     - |onprem| instance to which the :opsmgr:`Backup Agent
+       </reference/glossary/#std-term-backup-agent>` writes snapshot or
+       oplog data. Value must be a valid |url| such as
+       ``http://www.mongodb.com``. Supports both HTTP and HTTPS
+       protocols. 
+
+   * - Restore Endpoint 
+     - |onprem| instance that serves restore requests.
+
+   * - Queryable Proxy Server Endpoint 
+     - |onprem| instance that serves :opsmgr:`Queryable Backup
+       </reference/glossary/#std-term-queryable-backup>` requests. Value
+       must be in the following format: ``domain:port``. For example,
+       ``localhost:8080``.  
+
+   * - Deployment Description
+     - String that describes the purpose of the deployment region.
+
+   * - Assignment Enabled
+     - Flag that specifies whether you can assign the region to new
+       resources. If you disable this field, you can't assign the region
+       to any new resource. 

source/includes/list-tables/deployment-regions/deployment-regions-with-id-ui.rst

@@ -0,0 +1,38 @@
+.. list-table::
+   :widths: 30 70
+   :header-rows: 1
+
+   * - Field 
+     - Value
+
+   * - Deployment ID 
+     - Unique identifier that references this deployment region in
+       configurations. The ID can contain up to 64 alphanumeric
+       characters and the dash (``-``), underscore (``_``), and dot
+       (``.``) characters. 
+
+       You can't modify the deployment ID of a region once it's created.  
+
+   * - Ingestion Endpoint 
+     - |onprem| instance to which the :opsmgr:`Backup Agent
+       </reference/glossary/#std-term-backup-agent>` writes snapshot or
+       oplog data. Value must be a valid |url| such as
+       ``http://www.mongodb.com``. Supports both HTTP and HTTPS
+       protocols. 
+
+   * - Restore Endpoint 
+     - |onprem| instance that serves restore requests.
+
+   * - Queryable Proxy Server Endpoint 
+     - |onprem| instance that serves :opsmgr:`Queryable Backup
+       </reference/glossary/#std-term-queryable-backup>` requests. Value
+       must be in the following format: ``domain:port``. For example,
+       ``localhost:8080``.  
+
+   * - Deployment Description
+     - String that describes the purpose of the deployment region.
+
+   * - Assignment Enabled
+     - Flag that specifies whether you an assign the region to new
+       resources. If you disable this field, you can't assign the region
+       to any new resource. 

source/includes/steps-add-shard-to-mongodb-cluster.yaml

@@ -67,5 +67,13 @@ title: "Click :guilabel:`Save` to add the new shard to the cluster."
 stepnum: 5
 level: 4
 ref: save-new-shard-config
+content: | 
+  If you enable multi-region backups, this sharded cluster initializes in a 
+  :guilabel:`Misconfigured` state, indicated in the :guilabel:`Continuous Backup` 
+  dashboard. While the cluster is in the :guilabel:`Misconfigured` state,
+  |mms| won't take any new snapshots, although oplog tailing continues
+  uninterrupted for cluster members with assigned regions. You
+  must :ref:`select a deployment region <deployment-regions-assign>` for 
+  each of the newly created shards.  
 
 ...

source/includes/steps-create-backup-wt.yaml

@@ -34,7 +34,18 @@ content: |
   If you want to enable :ref:`regional-backup` for your replica set
   or sharded cluster, assign :ref:`deployment regions
   <deployment-regions-interface>`. For a sharded cluster, you must assign
-  a deployment region to each shard.
+  a deployment region for every sharded cluster member, including every
+  shard and config server.   
+  
+  To start a single or multi-region backup: 
+
+  a. Select :guilabel:`Turn on Multi-Region Backups` checkbox.
+  #. Select the deployment region from the dropdown. 
+
+     If you want to set the same deployment region for every member
+     of the sharded cluster, click :guilabel:`Set`. Alternatively,
+     select a different region from the dropdown for each sharded
+     cluster member. 
 ---
 title: "Click :guilabel:`Start`."
 stepnum: 5