(DOCSP-23752) Update mentions of Head Database to reflect their deprecation in favor of Backup Cursors (#4815) (#5225)

lmkerbey-mdb · web-flow · commit c5e756926b96 · 2023-10-04T12:37:26.000-04:00
* (DOCSP-23752) * (DOCSP-23752) First set of glossary changes. * (DOCSP-23752) Typo fix. * (DOCSP-23752) Update information about resync. * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) Rebasing. * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) Tech review * Empty Commit. * (DOCSP-23752) * (DOCSP-23752) Tech review. * (DOCSP-23752) Second round of technical review. * (DOCSP-23752) Tech review. * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) Use include. * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * (DOCSP-23752) * empty commit
diff --git a/source/admin/backup/job-timeline-page.txt b/source/admin/backup/job-timeline-page.txt
@@ -18,6 +18,8 @@ page. The :guilabel:`Job Timeline` page displays critical timestamps
 (:term:`head <head database>`, last snapshot, next snapshot) and
 offers a way to assign a :term:`daemon <Backup Daemon>` to a given job.
 
+.. include:: /includes/head-database-backup-deprecated.rst
+
 Click the :guilabel:`Auto refresh` checkbox to update the list
 automatically every 10 seconds. Click the :guilabel:`Refresh` button
 to refresh data manually.
diff --git a/source/admin/backup/jobs-page.txt b/source/admin/backup/jobs-page.txt
@@ -70,6 +70,8 @@ From the :guilabel:`Jobs` page, you can do the following:
        :term:`head <head database>`, and click the
        :guilabel:`Move Head` button.
 
+       .. include:: /includes/head-database-backup-deprecated.rst
+
    * - Filter the page to display the jobs assigned to a particular
        Daemon or blockstore.
 
diff --git a/source/core/backup-preparations.txt b/source/core/backup-preparations.txt
@@ -391,6 +391,8 @@ Encryption
    |fcv-link| 3.4 and 4.0 with the
    :ref:`WiredTiger <encrypted-storage-engine>` storage engine.
 
+   .. include:: /includes/head-database-backup-deprecated.rst
+
    .. seealso::
 
       :doc:`/tutorial/encrypt-snapshots`.
diff --git a/source/core/deployments.txt b/source/core/deployments.txt
@@ -18,9 +18,13 @@ deployments.
 Considerations
 --------------
 
-For best performance on any of these installs, configure each backup
-host with two disk partitions: one for the snapshot store or File
-System Store and one for the head databases.
+On FCV 4.0 and earlier, for best performance on any of these installs, 
+configure each backup host with two disk partitions: one for the snapshot 
+store or File System Store and one for the head databases.
+
+On |fcv-link| ``4.2`` and later, backups no longer require 
+:term:`head databases <head database>`. For more information, see 
+:ref:`backup-daemon`.
 
 .. _on-prem-minimal-deployment-diagram:
 
@@ -38,11 +42,17 @@ a single host, as described in
    If you would like to test backup services, use the |application| to
    configure them. When
    :doc:`configuring </reference/config/ui-settings>` |onprem|,
-   you can specify the backup settings. The Backup Daemon service
-   creates the :term:`head databases <head database>` dynamically in
-   that directory. The Backup Daemon service then manages these head
+   you can specify the backup settings. 
+   
+   For FCV 4.0 and earlier, the Backup Daemon service creates the 
+   :term:`head databases <head database>` dynamically in that 
+   directory. The Backup Daemon service then manages these head
    databases.
 
+   For |fcv-link| ``4.2`` and later, the :term:`application database` stores 
+   snapshots of deployment state in 
+   :term:`backup cursors <backup cursor>`.
+
 Production Installs
 -------------------
 
diff --git a/source/includes/admonitions/warning-follow-requirements.rst b/source/includes/admonitions/warning-follow-requirements.rst
@@ -10,5 +10,7 @@
      the MongoDB manual. MongoDB instances in |onprem| include:
 
      - The |onprem| Application Database,
-     - Each |onprem| Backup Daemon :term:`head database`, and
      - Each blockstore.
+     - Each |onprem| Backup Daemon :term:`head database`. This only
+       applies to FCV 4.0 and earlier. FCV 4.2 and later do not use
+       :term:`head databases <head database>` for backups.
diff --git a/source/includes/api/list-tables/backup-config/request-body-onprem.rst b/source/includes/api/list-tables/backup-config/request-body-onprem.rst
@@ -25,6 +25,8 @@
        existing backups in a project, enabling encryption requires an
        :term:`initial sync` to recreate the backups’ head databases.
 
+       .. include:: /includes/head-database-deprecated-encrypt.rst
+
    * - excludedNamespaces
      - array of strings
      - Conditional
diff --git a/source/includes/api/list-tables/backup-config/response-body-onprem.rst b/source/includes/api/list-tables/backup-config/response-body-onprem.rst
@@ -26,6 +26,8 @@
        backups in a project, enabling encryption requires an 
        :term:`initial sync` to recreate the backups’ head databases.
 
+       .. include:: /includes/head-database-deprecated-encrypt.rst
+
    * - excludedNamespaces
      - array of strings
      - List of database names and collection names to omit from
diff --git a/source/includes/extracts-fact-encrypted-backup.yaml b/source/includes/extracts-fact-encrypted-backup.yaml
@@ -45,6 +45,8 @@ content: |
       For details on setting up backup encryption, see
       :doc:`/tutorial/encrypt-snapshots`.
 
+      .. include:: /includes/head-database-backup-deprecated.rst
+
 edition: onprem
 ---
 ref: fact-encrypted-backups
diff --git a/source/includes/extracts-faq.yaml b/source/includes/extracts-faq.yaml
@@ -110,10 +110,12 @@ content: |
   - increase the size of the file system that holds the
     :setting:`Head directory`.
 
-  - move the :setting:`Head database` data to a new volume with more
-    space, and create a symlink or configure the file system mount
-    points so that the daemon can access the data using the original
-    path.
+  - On FCV 4.0 and earlier, move the :setting:`Head database` data to a 
+    new volume with more space, and create a symlink or configure the 
+    file system mount points so that the daemon can access the data 
+    using the original path.
+     
+    FCV 4.2 and later do not use :term:`head databases <head database>`.
 ---
 ref: faq-backup-jobs-fail-to-bind
 edition: cloud
@@ -134,10 +136,12 @@ content: |
   - increase the size of the file system that holds the
     :setting:`Head directory`.
 
-  - move the :setting:`Head database` data to a new volume with more
-    space, and create a symlink or configure the file system mount
-    points so that the daemon can access the data using the original
-    path.
+  - For FCV 4.0 and earlier, move the :setting:`Head database` data to 
+    a new volume with more space, and create a symlink or configure the 
+    file system mount points so that the daemon can access the data 
+    using the original path.
+     
+    FCV 4.2 and later do not use :term:`head databases <head database>`.
 ---
 ref: faq-applyops-errors
 edition: cloud
diff --git a/source/includes/glossary-terms.yaml b/source/includes/glossary-terms.yaml
@@ -118,15 +118,29 @@ definition: |
   :ref:`blockstores-page`. The blockstore is one type of
   :term:`Backup Database`.
 
+---
+term: backup cursor
+ref: glossary-backup-cursor
+edition: onprem
+definition: |
+
+  A :manual:`tailable cursor <tailable-cursors>` pointing to a list of
+  backup files. Starting with FCV 4.2, |onprem| uses
+  :term:`backup cursors <backup cursor>` instead of 
+  :term:`head databases <head database>`.
+
 ---
 term: Backup Daemon
 ref: glossary-backup-daemon
 edition: onprem
 definition: |
 
   The |onprem| component that creates and manages backups by
-  maintaining :term:`head databases <head database>` and
-  :term:`snapshots <snapshot>`.
+  maintaining :term:`head databases <head database>` and 
+  :term:`snapshots <snapshot>` for FCV 4.0 and 
+  earlier. Starting with FCV 4.2, |onprem| uses
+  :term:`backup cursors <backup cursor>` instead of 
+  :term:`head databases <head database>`.
 
   .. seealso:: :ref:`backup-daemon`
 
@@ -136,11 +150,19 @@ ref: glossary-backup-job
 edition: onprem
 definition: |
 
-  The :term:`Backup Daemon` runs this process to apply the most recent
-  changes to its backup of a :term:`replica set`. The daemon stores
-  backups locally as :term:`head databases <head database>`. A sharded
-  cluster will have a different head database for each shard. You can
-  re-assign backup jobs among Backup Daemons.
+  The |onprem| process that backs up MongoDB deployments.
+  
+  For FCV 4.0 and earlier, the :term:`backup daemon` stores backups 
+  locally as :term:`head databases <head database>`. A sharded cluster 
+  will have a different head database for each shard. 
+
+  For FCV 4.2 and later, the WiredTiger storage engine takes snapshots
+  of your deployment using :term:`backup cursors <backup cursor>` to 
+  allow point-in-time copying of the WiredTiger files. Applications 
+  can continue read and write operations on the database while 
+  WiredTiger takes the snapshot.
+
+  You can re-assign backup jobs among Backup Daemons.
 
   .. seealso:: :ref:`jobs-page`
 
@@ -316,6 +338,10 @@ definition: |
   :term:`snapshots <snapshot>`. The Daemon stores the head databases
   in the :term:`head directory`.
 
+  Starting with FCV 4.2, |onprem| uses
+  :term:`backup cursors <backup cursor>` instead of 
+  :term:`head databases <head database>`.
+
 ---
 term: head directory
 ref: glossary-head-directory
@@ -464,8 +490,11 @@ definition: |
   oplog slice and sends it to |mms|, which stores it in the
   :term:`Oplog Store Database`.
 
-  The :term:`Backup Daemon` retrieves the slice and applies it to the
-  associated :term:`head database`.
+  For FCV 4.0 and earlier, the :term:`Backup Daemon` retrieves the 
+  slice and applies it to the associated :term:`head database`.
+
+  For FCV 4.2 and later, |onprem| retrieves the slice and stores it
+  in the :term:`Oplog Store Database`.
 
   .. seealso:: :ref:`oplog-stores-page`
 
diff --git a/source/includes/head-database-backup-deprecated.rst b/source/includes/head-database-backup-deprecated.rst
@@ -0,0 +1,6 @@
+.. note::
+
+   FCV |fcv-link| ``4.2`` and later use 
+   :term:`backup cursors <backup cursor>` instead of
+   :term:`head databases <head database>`. For
+   more information, see :ref:`backup-daemon`.
diff --git a/source/includes/head-database-deprecated-encrypt.rst b/source/includes/head-database-deprecated-encrypt.rst
@@ -0,0 +1,9 @@
+.. note:: 
+
+   FCV |fcv-link| ``4.2`` and later use 
+   :term:`backup cursors <backup cursor>` instead of
+   :term:`head databases <head database>`. For
+   more information, see :ref:`backup-daemon`.
+
+   For more information on backup encryption for FCV 4.2 or 
+   later, see :ref:`encrypt-snapshots`.
diff --git a/source/includes/options-opsmgr-shared.yaml b/source/includes/options-opsmgr-shared.yaml
@@ -189,6 +189,10 @@ description: |
   enable or disable journaling for the :term:`head database` of a
   single backup job.
 
+  FCV |fcv-link| ``4.2`` and later use :term:`backup cursors 
+  <backup cursor>` instead of :term:`head databases <head database>` 
+  for backups.
+
   {{corresponds}}
 
 ---
@@ -748,6 +752,8 @@ description: |
      for any other purpose. This partition should *not* overlap with
      the partition used for the Backup Database.
 
+  .. include:: /includes/head-database-backup-deprecated.rst
+
   {{corresponds}}
 
 ---
@@ -1553,6 +1559,8 @@ description: |
      ``numactl`` service installed. If ``numactl`` is not installed
      and this setting is set to ``true``, backup jobs fail.
 
+     .. include:: /includes/head-database-backup-deprecated.rst
+
   {{corresponds}}
 
 ---
diff --git a/source/includes/options-opsmgr-ui-conf.yaml b/source/includes/options-opsmgr-ui-conf.yaml
@@ -1535,6 +1535,8 @@ description: |
      destroyed by the Backup Daemon. This partition should not be used
      for any other purpose. This partition should *not* overlap with
      the partition used for the Backup Database.
+
+     .. include:: /includes/head-database-backup-deprecated.rst
 ---
 program: uiConf
 name: "Number of Workers"
diff --git a/source/includes/steps-configure-backup-prep-onprem-windows.yaml b/source/includes/steps-configure-backup-prep-onprem-windows.yaml
@@ -32,6 +32,8 @@ content: |
 
      - writable by any user with :guilabel:`SYSTEM` access privileges.
 
+     .. include:: /includes/head-database-backup-deprecated.rst
+
   b. Configure the :doc:`Backup Storage </tutorial/nav/backup-storage>` you
      want to use for your snapshots.
 
diff --git a/source/includes/steps-configure-hybrid-mode.yaml b/source/includes/steps-configure-hybrid-mode.yaml
@@ -85,6 +85,8 @@ content: |
             :term:`Backup Daemon` to use for the :term:`head database`.
             Select :guilabel:`Enterprise Required` if you want the
             Backup Daemon to download only MongoDB Enterprise builds.
+
+            .. include:: /includes/head-database-backup-deprecated.rst
 ---
 title: "Review and approve your changes."
 stepnum: 2
diff --git a/source/includes/steps-configure-local-mode.yaml b/source/includes/steps-configure-local-mode.yaml
@@ -81,6 +81,8 @@ content: |
             Select :guilabel:`Enterprise Required` if you want the 
             Backup Daemon to download only MongoDB Enterprise builds.
 
+            .. include:: /includes/head-database-backup-deprecated.rst
+
 ---
 title: "Download the required MongoDB archives."
 stepnum: 2
diff --git a/source/includes/steps-configure-remote-mode.yaml b/source/includes/steps-configure-remote-mode.yaml
@@ -85,6 +85,8 @@ content: |
             :term:`Backup Daemon` to use for the :term:`head database`.
             Select :guilabel:`Enterprise Required` if you want the
             Backup Daemon to download only MongoDB Enterprise builds.
+
+            .. include:: /includes/head-database-backup-deprecated.rst
 ---
 stepnum: 2
 level: 4
diff --git a/source/includes/steps-install-basic-application.yaml b/source/includes/steps-install-basic-application.yaml
@@ -84,8 +84,9 @@ stepnum: 8
 level: 4
 ref: enable-backup-daemon
 content: |
-  a. On **server 2**, create the directory that will store the :term:`head
-     databases <head database>`. The directory must be:
+
+  a. On **server 2**, create the directory that will be used as 
+     the :term: `head directory`. The directory must be:
 
      - a dedicated disk partition that is not be used for any other
        purpose.
diff --git a/source/includes/steps-source-install-onprem.yaml b/source/includes/steps-source-install-onprem.yaml
@@ -139,9 +139,9 @@ level: 4
 ref: configure-backup-database-uri
 content: |
 
-  a. On each |onprem| server that you activate as a Backup Daemon, create
-     the directory in which to store the :term:`head databases <head
-     database>`. The directory must be:
+  a. On each |onprem| server that you activate as a Backup Daemon, 
+     create the directory that will be used as the 
+     :term:`head directory <head directory>`. The directory must be:
 
      - dedicated for this purpose on a local disk partition.
 
diff --git a/source/reference/api/backup/get-all-backup-configs-for-group.txt b/source/reference/api/backup/get-all-backup-configs-for-group.txt
@@ -108,6 +108,8 @@ Response
           requires an :term:`initial sync` to recreate the backups’ 
           head databases.
 
+          .. include:: /includes/head-database-deprecated-encrypt.rst
+
 .. list-table::
    :widths: 20 14 66
    :stub-columns: 1
diff --git a/source/reference/api/backup/get-one-backup-config-by-cluster-id.txt b/source/reference/api/backup/get-one-backup-config-by-cluster-id.txt
@@ -193,6 +193,8 @@ Response
           requires an :term:`initial sync` to recreate the backups’ 
           head databases.
 
+          .. include:: /includes/head-database-deprecated-encrypt.rst
+
       * - excludedNamespaces
         - string array
         - List of database names and collection names to omit from
diff --git a/source/reference/api/kmip-keys/get-master-key.txt b/source/reference/api/kmip-keys/get-master-key.txt
@@ -91,6 +91,8 @@ Response
      - Unique identifier of the |kmip| master key. This key encrypts
        and restores the head databases for an encrypted backup.
 
+       .. include:: /includes/head-database-deprecated-encrypt.rst
+
 Example Request
 ---------------
 
diff --git a/source/reference/api/kmip-keys/rotate-master-key.txt b/source/reference/api/kmip-keys/rotate-master-key.txt
@@ -92,6 +92,8 @@ Response
      - Unique identifier of the |kmip| master key. This key encrypts
        and restores the head databases for an encrypted backup.
 
+       .. include:: /includes/head-database-deprecated-encrypt.rst
+
 Example Request
 ---------------
 
diff --git a/source/tutorial/resync-backup.txt b/source/tutorial/resync-backup.txt
@@ -54,8 +54,15 @@ and |mms| does not produce any new snapshots.
 Considerations
 --------------
 
+.. cond:: onprem
+
+   As of FCV 4.2, deployments are backed up with WiredTiger checkpoints
+   using :term:`backup cursors <backup cursor>`. Applications can 
+   continue read and write operations on the database while WiredTiger
+   takes the snapshot.
+
 To avoid the need for resyncs, ensure the Backup oplog does not fall
-behind the deployment’s oplog. This requires that:
+behind the deployment's oplog. This requires that:
 
 - Adequate machine resources are provisioned for the agent.
 
