Merge pull request #142 from ianf-mongodb/DOCSP-39099

DOCSP-39099 CDC Recoverability Content

Author: sarah-olson-mongodb

source/includes/fact-cdc-recoverable.rst

@@ -0,0 +1,2 @@
+You can recover a continuous sync job within 24 hours of failure. 
+For details, see :ref:`rm-sync-jobs-recoverability`.

source/jobs/creating-jobs.txt

@@ -24,6 +24,8 @@ About this Task
 
 .. include:: /includes/fact-kafka-additional-time.rst
 
+- .. include:: /includes/fact-cdc-recoverable.rst
+
 Before you Begin
 ----------------
 

source/jobs/recover-jobs.txt

@@ -0,0 +1,82 @@
+.. _rm-sync-jobs-recoverability:
+
+==================
+Recover a Sync Job
+==================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Relational Migrator can attempt to recover continuous (CDC) sync jobs 
+that have failed within the preceding 24-hour period. 
+The procedure for recovering a CDC sync job differs, 
+depending on whether you're using the embedded or Kafka deployment 
+mode. For details on each job type, see :ref:`rm-sync-jobs`.
+
+About this Task
+---------------
+
+- CDC sync job recovery depends on the type of deployment 
+  mode your using. The following table summarizes the modes.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Mode
+       - Description
+
+     * - Embedded Mode
+       - Sync jobs that are running on a :ref:`local machine <local-machine-install>` or 
+         a :ref:`unattended server <unattended-server>`.
+
+     * - Kafka Mode
+       - Sync jobs that are running with :ref:`Kafka support <kafka-intro>`.
+
+- Examples of embedded mode recoverable scenarios include:
+  
+  - Unexpected application failure
+  - Operating system restarts
+
+- Examples of Kafka CDC sync job recoverable scenarios include:
+  
+  - Loss of individual `brokers <https://developer.confluent.io/courses/apache-kafka/brokers/>`__ in Kafka cluster
+  - Application-level issues resulting in failed health checks
+
+Task
+----
+
+Click the tab to display the recovery procedure 
+for each deployment mode.
+
+.. tabs::
+
+   .. tab:: Embedded Mode
+      :tabid: embedded-mode
+
+      For embedded mode recovery, the process to restart
+      a sync job is manually triggered. This process requires 
+      restarting the Relational Migrator application.
+
+      .. procedure::
+
+         .. step:: Navigate to the :guilabel:`Data Migration` tab
+
+         .. step:: Click :guilabel:`Resume` on the failed sync job 
+
+   .. tab:: Kafka Mode
+      :tabid: kafka-mode
+
+      For the Kafka deployment mode recovery, the process to recover
+      a sync job is automatic. Kafka health checks automatically 
+      attempt to resume CDC sync jobs after a failure of 
+      individual `Kafka brokers <https://developer.confluent.io/courses/apache-kafka/brokers/>`__
+      for up to 24 hours.
+
+Learn More
+----------
+
+- :ref:`rm-create-jobs`
+- :ref:`rm-monitor-jobs`

source/jobs/sync-jobs.txt

@@ -35,6 +35,11 @@ data remain in sync.
    For more details about the Kafka deployment model, see 
    :ref:`kafka-intro`.
 
+Recoverability
+--------------
+
+.. include:: /includes/fact-cdc-recoverable.rst
+
 Get Started
 -----------
 
@@ -60,5 +65,6 @@ You can perform the following tasks from the **Data Migration** tab.
    /jobs/creating-jobs
    /jobs/monitoring-jobs
    /jobs/stopping-jobs
+   /jobs/recover-jobs
    /jobs/pause-resume-kafka-jobs
    /jobs/data-verification/data-verification