DOCSP-42211-atlas-compatibility-mongosh-repl-methods (#10409)

mongodb · Nov 25, 2024 · a3b9d30 · a3b9d30
1 parent 70342f4
commit a3b9d30
Show file tree

Hide file tree

Showing 14 changed files with 107 additions and 12 deletions.
diff --git a/source/reference/method/rs.add.txt b/source/reference/method/rs.add.txt
@@ -18,8 +18,6 @@ Definition
    Adds a member to a :term:`replica set`. To run the method, you must
    connect to the :term:`primary` of the replica set.
 
-
-
    .. list-table::
       :header-rows: 1
       :widths: 20 20 80
@@ -70,9 +68,6 @@ Definition
 
         - Optional. Applies only if the ``<host>`` value is a string. If ``true``, the
           added host is an arbiter.
-
-
-
 
 
    :method:`rs.add()` provides a wrapper around some of the
@@ -82,6 +77,13 @@ Definition
    :doc:`/reference/replica-configuration` document for full
    documentation of all replica set configuration options.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 IP Binding
 ----------
 

diff --git a/source/reference/method/rs.addArb.txt b/source/reference/method/rs.addArb.txt
@@ -42,6 +42,12 @@ Description
         - Specifies the hostname and optionally the port number of the arbiter
           member to add to replica set.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
 IP Binding
 ----------

diff --git a/source/reference/method/rs.conf.txt b/source/reference/method/rs.conf.txt
@@ -26,6 +26,15 @@ Definition
 .. |moreinfo| replace:: The option is only available with the :dbcommand:`replSetGetConfig`
    command.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-atlas-only.rst
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Output Example
 --------------
 

diff --git a/source/reference/method/rs.freeze.txt b/source/reference/method/rs.freeze.txt
@@ -40,3 +40,9 @@ Description
 
         - The duration the member is ineligible to become primary.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/rs.help.txt b/source/reference/method/rs.help.txt
@@ -8,7 +8,17 @@ rs.help()
    :depth: 1
    :class: singlecol
 
+Description
+-----------
+
 .. method:: rs.help()
 
    Returns help text for :ref:`replication <replication>` related shell
    functions.
+
+Compatibility
+-------------
+
+.. include:: /includes/fact-environments-atlas-only.rst
+.. include:: /includes/fact-environments-atlas-support-all.rst
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/rs.initiate.txt b/source/reference/method/rs.initiate.txt
@@ -41,6 +41,13 @@ Description
           configuration is not specified, MongoDB uses a default 
           replica set configuration.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 IP Binding
 ----------
 

diff --git a/source/reference/method/rs.printReplicationInfo.txt b/source/reference/method/rs.printReplicationInfo.txt
@@ -28,3 +28,12 @@ Definition
 
 .. include:: /includes/output-printReplicationInfo.rst
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-atlas-only.rst
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+.. include:: /includes/fact-environments-onprem-only.rst
+
diff --git a/source/reference/method/rs.printSecondaryReplicationInfo.txt b/source/reference/method/rs.printSecondaryReplicationInfo.txt
@@ -19,6 +19,15 @@ Definition
    perspective of the :term:`secondary` member of the set. The output is
    identical to :method:`db.printSecondaryReplicationInfo()`.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-atlas-only.rst
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Output
 ------
 

diff --git a/source/reference/method/rs.reconfig.txt b/source/reference/method/rs.reconfig.txt
@@ -90,6 +90,13 @@ Definition
    The ``force`` parameter allows a reconfiguration command to be issued
    to a non-primary node.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 

diff --git a/source/reference/method/rs.reconfigForPSASet.txt b/source/reference/method/rs.reconfigForPSASet.txt
@@ -10,6 +10,8 @@ rs.reconfigForPSASet()
    :depth: 1
    :class: singlecol
 
+Definition
+----------
 
 .. method:: rs.reconfigForPSASet( memberIndex, config, { options } )
 
@@ -39,6 +41,13 @@ rs.reconfigForPSASet()
    For details about the behavior of this method, see
    :ref:`reconfigForPSASet-behavior`.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 

diff --git a/source/reference/method/rs.remove.txt b/source/reference/method/rs.remove.txt
@@ -40,17 +40,20 @@ Definition
         - string
 
         - The hostname of a system in the replica set.
-
-
-
-
 
    .. note::
 
       Before running the :method:`rs.remove()` operation, it is good
       practice to *shut down* the replica set member that you are
       removing.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 

diff --git a/source/reference/method/rs.status.txt b/source/reference/method/rs.status.txt
@@ -25,6 +25,13 @@ Definition
    data derived from the heartbeat packets sent by the other members
    of the replica set.
 
+Compatibility
+-------------
+
+.. include:: /includes/fact-environments-atlas-only.rst
+.. include:: /includes/fact-environments-atlas-support-all.rst
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Output
 ------
 

diff --git a/source/reference/method/rs.stepDown.txt b/source/reference/method/rs.stepDown.txt
@@ -60,11 +60,13 @@ Description
 
           When specified, ``secondaryCatchUpPeriodSecs`` 
           overrides the default wait time of ``10`` seconds.
-
-
-
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
 
+.. include:: /includes/fact-environments-onprem-only.rst
 
 .. _rs.stepDown-behavior:
 

diff --git a/source/reference/method/rs.syncFrom.txt b/source/reference/method/rs.syncFrom.txt
@@ -10,6 +10,9 @@ rs.syncFrom()
    :depth: 1
    :class: singlecol
 
+Definition
+----------
+
 .. method:: rs.syncFrom()
 
    Temporarily overrides the default sync target for the current member. 
@@ -20,6 +23,12 @@ rs.syncFrom()
    Specify the name of the member you
    want to replicate from in the form of ``[hostname]:[port]``.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Behavior
 --------