DOCSP-50260: 1.14 Release notes (#12237)

* DOCSP-50260: 1.14 Release notes

initial commit

empty commit

toc

versionadded

feedback

link

link

* Copy old current to v1.13

* backport

* banner

* stdin

* Revert "stdin"

This reverts commit 1269226f688fce14554c1de9a2ab45c353085941.

---------

Co-authored-by: Chris Bush <[email protected]>

Author: mayaraman19

content/cluster-to-cluster-sync/.backportrc.json

@@ -4,6 +4,7 @@
     "sourceBranch": "main",
     "sourceDirectoryChoices": [
         "content/cluster-to-cluster-sync/current",
+        "content/cluster-to-cluster-sync/v1.13",
         "content/cluster-to-cluster-sync/v1.12",
         "content/cluster-to-cluster-sync/v1.11",
         "content/cluster-to-cluster-sync/v1.10"
@@ -19,6 +20,7 @@
         "content/cluster-to-cluster-sync/v1.10",
         "content/cluster-to-cluster-sync/v1.11",
         "content/cluster-to-cluster-sync/v1.12",
+        "content/cluster-to-cluster-sync/v1.13",
         "content/cluster-to-cluster-sync/current"
     ],
     "backportTargetMode": "directory",

content/cluster-to-cluster-sync/current/source/includes/api/tables/progress-response.rst

@@ -127,6 +127,19 @@
      - Destination cluster. Returned in the form
        ``<cluster name>: <host>:<port>``.
 
+   * - ``estimatedSecondsToCEACatchup``
+     - integer
+     - Estimated time in seconds remaining in the :ref:`Change Event Application 
+       <c2c-cea>` (CEA) phase, based on how much ``lagTimeSeconds`` has 
+       decreased over a recent interval.
+
+       ``/progress`` does not report ``estimatedSecondsToCEACatchup`` 
+       if ``mongosync`` is not in CEA, or if ``lagTimeSeconds`` has increased 
+       or stayed the same over the most recent interval. In this case, 
+       wait 30 minutes and then try again.
+
+       .. versionadded:: 1.14
+
    * - ``mongosyncID``
      - string
      - Identifier string for the ``mongosync`` instance.

content/cluster-to-cluster-sync/current/source/reference/api/start.txt

@@ -90,8 +90,12 @@ Request Body Parameters
        Supported Options:
 
        - ``beforeDataCopy`` (the default) causes ``mongosync`` to build indexes
-         on the destination cluster. These include both existing indexes and
-         any indexes created during migration on the source cluster.
+         on the destination cluster. These include existing indexes, hashed
+         indexes, and any indexes created during migration on the source cluster.
+
+       - ``excludeHashed`` causes ``mongosync`` to skip building hashed indexes
+         during sync. This can `improve performance <https://www.mongodb.com/docs/manual/tutorial/drop-a-hashed-shard-key-index/>`__
+         for large collections.
 
        - ``never`` causes ``mongosync`` to skip building unnecessary indexes
          during sync. This can improve migration performance, especially with
@@ -263,6 +267,12 @@ The ``sharding`` option has the following parameters:
      - Optional. Sets whether sync creates a supporting index
        for the shard key, if none exists. The default is ``false``.
 
+       If you set this parameter to ``true`` and set ``buildIndexes`` 
+       to ``"excludeHashed"``, then ``mongosync`` does not create
+       supporting hashed indexes for hashed shard keys on the destination
+       cluster. ``mongosync`` still builds non-hashed supporting
+       indexes for non-hashed shard keys.
+
        For more information and limitations, see 
        :ref:`c2c-supporting-index-behavior`.
 

content/cluster-to-cluster-sync/current/source/reference/limitations.txt

@@ -164,6 +164,10 @@ Sharded Clusters
   <limit-number-of-indexes-per-collection>` of 64.
 - ``mongosync`` only supports syncing sharded collections that have
   default :ref:`collation <collation>` settings.
+- ``mongosync`` errors on indexes that are
+  inconsistent or missing on some data-bearing shards.
+
+  .. versionadded: 1.14.0
 
 Reversing
 ---------

content/cluster-to-cluster-sync/current/source/reference/live-upgrade.txt

@@ -17,6 +17,10 @@ Live Upgrades
    :depth: 2
    :class: singlecol
 
+.. important::
+
+   ``mongosync`` does not support live upgrades to version 1.14.
+
 Starting in ``mongosync`` 1.7.0, you can live upgrade ``mongosync`` without
 restarting data synchronization operations from the beginning.
 

content/cluster-to-cluster-sync/current/source/reference/supported-server-version.txt

@@ -55,7 +55,7 @@ clusters:
      - 6.0
 
    * - 7.0
-     - 7.0.14
+     - 7.0.13
      - 6.0
 
    * - 8.0

content/cluster-to-cluster-sync/current/source/release-notes.txt

@@ -2,6 +2,9 @@
 Release Notes
 =============
 
+.. meta::
+   :description: Explore the release notes for Cluster-to-Cluster Sync, including the latest stable version and previous releases.
+
 Always install the latest, stable version of {+c2c-product-name+}. For
 more information on types of MongoDB releases, see
 :ref:`c2c-release-version-numbers`.
@@ -12,11 +15,12 @@ release notes.
 Current Stable Release
 ~~~~~~~~~~~~~~~~~~~~~~
 
-- :ref:`c2c-release-notes-1.13`
+- :ref:`c2c-release-notes-1.14`
 
 Previous Releases
 ~~~~~~~~~~~~~~~~~
 
+- :ref:`c2c-release-notes-1.13`
 - :ref:`c2c-release-notes-1.12`
 - :ref:`c2c-release-notes-1.11`
 - :ref:`c2c-release-notes-1.10`
@@ -37,6 +41,7 @@ Previous Releases
 .. toctree::
    :titlesonly: 
 
+   1.14 </release-notes/1.14>
    1.13 </release-notes/1.13> 
    1.12 </release-notes/1.12>
    1.11 </release-notes/1.11>

content/cluster-to-cluster-sync/current/source/release-notes/1.14.txt

@@ -0,0 +1,74 @@
+.. _c2c-release-notes-1.14:
+
+================================
+Release Notes for mongosync 1.14
+================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+This page describes changes and new features introduced in  
+{+c2c-full-product-name+} 1.14.
+
+
+.. _1.14.0-c2c-release-notes:
+
+1.14.0 Release
+--------------
+
+**June 5, 2025**
+
+API Changes
+~~~~~~~~~~~
+
+- Adds the ``estimatedSecondsToCEACatchup`` field to the :ref:`c2c-api-progress`
+  endpoint response.
+
+- ``mongosync`` errors on indexes that are inconsistent or missing on 
+  some data-bearing shards, instead of ignoring them.
+
+- Adds the ``"excludeHashed"`` option to the ``buildIndexes`` parameter in
+  the :ref:`c2c-api-start` endpoint.
+
+Live Upgrades
+~~~~~~~~~~~~~
+
+:ref:`Live upgrades <c2c-live-upgrade>` to 1.14 are not
+supported.
+
+Fixed Issues
+~~~~~~~~~~~~
+
+- Fixes a bug where ``mongosync`` exited during :ref:`collection copy 
+  <c2c-collection-copy>` upon seeing a transient error. Now, ``mongosync``
+  will retry on retryable errors.
+
+- Fixes a bug where the embedded verifier could have caused
+  long downtime during :ref:`c2c-api-commit` if the source 
+  cluster has a lot of unique or hidden indexes.
+
+Other Notes 
+~~~~~~~~~~~
+
+- Fixes a case where ``mongosync`` exited unexpectedly without printing
+  a fatal log error. Now, if ``mongosync`` exits unexpectedly, it prints
+  a log error.
+
+- Fixes a bug introduced in ``mongosync`` version 1.10 where the 
+  :ref:`c2c-api-progress` endpoint overcounted the verifier's 
+  ``estimatedDocumentCount``.
+
+- If the verifier finds checksum mismatches, it might re-fetch some
+  documents from the source or destination cluster to check if the mismatch
+  is due to differences in `field order <https://www.mongodb.com/docs/manual/core/document/#document-field-order>`__.
+  This might lead to cutover taking slightly longer.
+
+Minimum Supported Version
+-------------------------
+
+.. include:: /includes/fact-version-compatibility.rst
+
+.. include:: /includes/migration-upgrade-recommendation.rst

content/cluster-to-cluster-sync/v1.13/.backportrc.json

@@ -0,0 +1,14 @@
+{
+    "repoOwner": "mongodb",
+    "repoName": "docs-cluster-to-cluster-sync",
+  
+    "targetBranchChoices": ["master", "v1.11", "v1.10", "v1.9", "v1.8"],
+  
+    "editor": "code",
+  
+    "maxNumber": 15,
+  
+    "backportBranchName": "{{sourcePullRequest.title}}-{{targetBranch}}-backport",
+  
+    "prTitle": "{{sourcePullRequest.title}}-{{targetBranch}}-backport ({{sourcePullRequest.number}})"
+}

content/cluster-to-cluster-sync/v1.13/.github/workflows/backport.yml

@@ -0,0 +1,26 @@
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    name: Backport
+    runs-on: ubuntu-latest
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    steps:
+      - uses: tibdex/backport@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

content/cluster-to-cluster-sync/v1.13/.gitignore

@@ -0,0 +1,87 @@
+*.swp
+.#*
+\#*#
+*__pycache__*
+*.pyc
+*.pyo
+*.bak
+.DS_Store
+source/includes/hash.rst
+source/includes/install-*-release-*.rst
+
+source/includes/toc-*.rst
+source/includes/dfn*.rst
+source/includes/manpage-options-auth-mongo.rst
+source/includes/manpage-options-ssl-settings.rst
+source/includes/manpage-options-audit-settings.rst
+TAGS
+mongodb-domain.yaml
+composite-pages.yaml
+!bin/*/mongodb-domain.yaml
+meta.yaml
+source/driver-examples/
+*~
+source/reference/*/*.rst
+source/reference/*/*/*.rst
+source/reference/*.rst
+source/compass/images/*
+source/images/compass/
+giza.log
+pdfs.yaml
+intersphinx.yaml
+!bin/*/pdfs.yaml
+source/includes/hash.rst
+docs_meta.yaml
+!bin/docs_meta.yaml
+fabfile
+source/includes/toc/
+source/includes/table/
+source/includes/steps/
+source/includes/generated/includes-overview.rst
+source/includes/option/
+source/includes/changelogs/*.rst
+!source/includes/changelogs/releases/*.rst
+primer/source/includes/toc/
+primer/source/includes/table/
+primer/source/includes/steps/
+primer/source/includes/generated/includes-overview.rst
+primer/source/includes/generated/
+primer/source/includes/option/
+primer/source/includes/hash.rst
+primer/source/.static
+primer/source/*.rst
+primer/source/core/*.rst
+primer/source/includes/example*.txt
+primer/source/includes/example-*.rst
+primer/source/includes/driver-table.rst
+primer/source/includes/fact-installation-bind-ip-default-in-config.rst
+primer/source/includes/fact-installation-directories.rst
+primer/source/includes/fact-selinux-redhat-options.rst
+primer/source/includes/list-mongodb-org-packages.rst
+primer/source/includes/note-package-change.rst
+primer/source/includes/note-suse-ulimit.rst
+primer/source/tutorial/*.rst
+primer/source/includes/toc-*yaml
+primer/source/includes/steps-*yaml
+!primer/source/includes/steps-client-*.yaml
+!primer/source/includes/steps-getting-started-prereq.yaml
+primer/source/includes/release-*yaml
+primer/source/tutorial/install-mongodb-on-*.txt
+!primer/config/intersphinx.yaml
+!primer/config/published_branches.yaml
+!primer/source/includes/toc-primer-*yaml
+!primer/source/includes/steps-primer*yaml
+!primer/source/includes/client-*rst
+!primer/source/includes/prereq-*.rst
+primer/source/images/*.png
+primer/source/images/*.rst
+primer/source/images/*.svg
+primer/source/includes/*.cpp
+primer/source/includes/*.java
+primer/source/includes/*.cs
+*.mo
+.stub
+primer/source/includes/table-linux-kernel-version-production.yaml
+venv
+.vscode
+changelogs/.mongodb-jira.yaml

content/cluster-to-cluster-sync/v1.13/README.md

@@ -0,0 +1,21 @@
+# docs-cluster-to-cluster-sync
+
+Documentation for the cluster to cluster synchronization tool,
+mongosync.
+
+Report Issues
+-------------
+
+To file issues or requests regarding the documentation, go to the
+[Documentation Jira Project](https://jira.mongodb.org/browse/DOCS).
+
+License
+-------
+
+All documentation is available under the terms of a [Creative Commons
+License](https://creativecommons.org/licenses/by-nc-sa/3.0/).
+
+If you have any questions, please contact [[email protected]]
+(mailto:[email protected]>).
+
+-- The MongoDB Documentation Team

content/cluster-to-cluster-sync/v1.13/build.sh

@@ -0,0 +1,8 @@
+# ensures that we always use the latest version of the script
+if [ -f build-site.sh ]; then
+  rm build-site.sh
+fi 
+
+
+curl https://raw.githubusercontent.com/mongodb/docs-worker-pool/netlify-poc/scripts/build-site.sh -o build-site.sh 
+sh build-site.sh