DOCSP-6345: [Guides] Update migration guides with new Live Migrate UI elements (#132)

Author: steveren

source/includes/live-migrate-cutover.rst

@@ -0,0 +1,33 @@
+  When Atlas detects that the source and destination clusters are nearly
+  in sync, it starts an extendable 72 hour timer to begin the cutover
+  procedure. If the 72 hour period passes, Atlas stops synchronizing with
+  the source cluster. You can extend the time remaining by 24 hours by
+  clicking the :guilabel:`Extend time` hyperlink below the :guilabel:`<time>
+  left to cut over` timer.
+
+  a. Once you are prepared to cut your applications over to the
+     destination Atlas cluster, click :guilabel:`Prepare to Cutover`.
+
+  #. Atlas displays a walk-through screen with instructions
+     on how to proceed with the cutover. These steps are also outlined
+     below:
+
+     1. Stop your application. This ensures that no additional writes
+        are generated to the source cluster.
+
+     #. Wait for the optime gap to reach zero. When the counter reaches
+        zero, the source and destination clusters are in sync.
+
+     #. Restart your application using the new connection string
+        provided in step 3 of the Live Migrate cutover UI.
+
+  #. Once you have completed the cutover procedure and confirmed
+     your applications are working normally with the Atlas cluster,
+     click :guilabel:`Cut Over` to complete the migration procedure.
+     This allows Atlas to:
+
+     - Mark the migration plan as complete.
+     - Remove the Application Server subnets from the destination
+       cluster whitelist.
+     - Remove the MongoDB user that Live Migrate used to import data
+       to the destination cluster.

source/includes/steps-migrate-compose.yaml

@@ -1,7 +1,5 @@
 title: Create an Atlas deployment
 ref: atlas-deployment
-level: 4
-stepnum: 1
 content: |
   If you don't already have an Atlas deployment, :doc:`create one
   </cloud/atlas>` now. You'll need
@@ -11,8 +9,6 @@ content: |
 ---
 title: Log in to your Compose account
 ref: login-compose
-level: 4
-stepnum: 2
 content: |
   Log in to your `Compose account <https://app.compose.io/session/new>`_
   and navigate to the deployment you want to migrate to Atlas.
@@ -25,8 +21,6 @@ content: |
 ---
 title: Create an oplog user
 ref: create-oplog-reader
-level: 4
-stepnum: 3
 content: |
   To perform the migration process, you need a database user with
   permission to read the oplog on your ``admin`` database. Click the
@@ -43,8 +37,6 @@ content: |
 ---
 title: Begin the Atlas Live Migration process
 ref: begin-live-migration
-level: 4
-stepnum: 4
 content: |
   Navigate to your Atlas cluster. Click the ellipsis (:guilabel:`...`)
   button and select :guilabel:`Migrate Data to this Cluster`.
@@ -54,17 +46,13 @@ content: |
 ---
 title: Review migration steps
 ref: review-steps
-level: 4
-stepnum: 5
 content: |
   Read through the overview of migration steps in the Live Migration
   dialog window, then click the green :guilabel:`I'm ready to migrate`
   button.
 ---
 title: Add IP address ranges to your Compose deployment whitelist
 ref: add-ip-ranges
-level: 4
-stepnum: 6
 content: |
   For this step you'll need to have browser tabs open
   with both the Atlas Live Migration process dialog from the previous
@@ -87,8 +75,6 @@ content: |
 title: Add the hostname and port of your Compose deployment to the
        Atlas Live Migration dialog
 ref: add-hostname-port
-level: 4
-stepnum: 7
 content: |
   On the :guilabel:`Oplog Access` add-on page, you'll find a connection
   string with a hostname and port for oplog access. Copy them to the Atlas
@@ -98,17 +84,13 @@ content: |
      :figwidth: 650px
 ---
 title: Enter the oplog user's credentials in the Live Migration dialog
-ref: 
-level: 4
-stepnum: 8
+ref: enter-oplog-creds
 content: |
   Enter the username and password for :guilabel:`oploguser` in the
   Atlas Live Migration dialog window.
 ---
 title: Enter your Compose SSL Certificate data 
 ref: enter-cafile
-level: 4
-stepnum: 9
 content: |
   If you don't have SSL enabled on your Compose deployment, skip this
   step.
@@ -127,38 +109,25 @@ content: |
 ---
 title: Validate your Live Migration form
 ref: validate-form
-level: 4
-stepnum: 10
 content: |
   Click the :guilabel:`Validate` button to check that all your form
   fields are valid and your clusters are ready for migration. When your
-  form is validated, click the :guilabel:`Start Migration` button.
+  form is validated, you're ready to begin the migration.
 ---
-title: Start migration
+title: Click :guilabel:`Start Migration`.
 ref: start-migration
-level: 4
-stepnum: 11
 content: |
-  When the migration process begins, the Live Migration dialog window
-  closes and you are returned to the Atlas cluster overview page. A
-  progress bar shows the progess of your migration.
 
-  .. figure:: /images/migration-complete.png
-     :figwidth: 700px
+   A countdown timer in a progress bar indicates how much time remains
+   before your target cluster is ready to migrate data from your source
+   cluster. Wait until the countdown timer and the :guilabel:`Prepare to Cutover`
+   button are green before proceeding to the next step.
 ---
-title: Prepare to Start your cutover
+title: Click :guilabel:`Prepare to Cutover`.
 ref: start-cutover
-level: 4
-stepnum: 12
+---
+title: Perform the cutover.
+ref: perform-the-cutover
 content: |
-  Your Compose deployment and your Atlas cluster are now in sync.
-  Atlas will maintain this synchronized state for 72 hours. If you
-  need more time, syncing can be extended for another 24 hours.
-
-  Click the green :guilabel:`Prepare to Cutover` button and follow the
-  instructions listed in the dialog window.
-
-  Once the cutover is complete, you can update your
-  client applications to use the new Atlas connection string.
-
+  .. include:: /includes/live-migrate-cutover.rst
 ...

source/includes/steps-migrate-to-atlas.yaml

@@ -108,8 +108,10 @@ ref: start-cutover
 stepnum: 7
 content: |
 
-  Your AWS cluster and your Atlas cluster are now in sync. Atlas will maintain
-  this synchronized state for 72 hours. If you need more time, syncing can be
-  extended for another 24 hours.
-
+---
+title: Perform the cutover.
+ref: perform-the-cutover
+stepnum: 8
+content: |
+  .. include:: /includes/live-migrate-cutover.rst
 ...