(DOCS-15601): Remove maxSize field from addShard command (#2072)

* Remove maxSize and add note

* Additional updates

* tech review feedback

* small updates

* copy review feedback

Author: davidhou17

source/includes/fact-remove-maxSize-addShard.rst

@@ -0,0 +1,10 @@
+Starting in version 6.2, MongoDB removes the ``maxSize`` field 
+from the :dbcommand:`addShard` command. As a result:
+
+- Running :dbcommand:`addShard` with the ``maxSize`` field returns 
+  an ``InvalidOptions`` error.
+
+- New documents in the :data:`~config.shards` collection no longer 
+  include the ``maxSize`` field.
+
+- Any pre-existing ``maxSize`` field entries are ignored.

source/reference/audit-message.txt

@@ -801,7 +801,6 @@ associated ``param`` details and the ``result`` values, if any.
           {
             shard: <shard name>,
             connectionString: <hostname>:<port>,
-            maxSize: <maxSize>
           }
 
        When a shard is a replica set, the ``connectionString`` includes the

source/reference/command/addShard.txt

@@ -30,16 +30,18 @@ The command has the following syntax:
    db.adminCommand(
       { 
         addShard: "<replica_set>/<hostname><:port>", 
-        maxSize: <size>, 
         name: "<shard_name>" 
       } 
    )
 
 Command Fields
 ~~~~~~~~~~~~~~
 
-The command contains the following fields:
+.. note:: 
+
+   .. include:: /includes/fact-remove-maxSize-addShard.rst
 
+The command contains the following fields:
 
 .. list-table::
    :header-rows: 1
@@ -62,38 +64,18 @@ The command contains the following fields:
        .. code-block:: bash
 
           <replica_set>/<hostname><:port>,<hostname><:port>, ...
-       
-       
- 
-   * - ``maxSize``
- 
-     - integer
- 
-     - Optional. The maximum size in megabytes of the shard. If you set ``maxSize``
-       to ``0``, MongoDB does not limit the size of the shard.
-       
-       
- 
+
    * - ``name``
 
      - string
 
      - Optional. A name for the shard. If this is not specified, MongoDB
        automatically provides a unique name.
 
-           
 The :dbcommand:`addShard` command stores shard configuration
 information in the :term:`config database`. Always run
 :dbcommand:`addShard` when using the ``admin`` database.
 
-Specify a ``maxSize`` when you have machines with different disk
-capacities, or if you want to limit the amount of data on some
-shards. The ``maxSize`` constraint prevents the :term:`balancer`
-from migrating chunks to the shard when the ``totalSize`` returned
-from running :dbcommand:`listDatabases` on the shard exceeds the
-value of ``maxSize``.
-
-
 Considerations
 --------------
 

source/reference/command/listShards.txt

@@ -64,7 +64,6 @@ The following document is an example of the output from a
       {
         "_id": "shard03",
         "host": "shard03/host7:27018,host8:27018,host9:27018",
-        "maxSize": NumberLong("1024"),
         "state": 1
       }
     ],
@@ -110,13 +109,6 @@ Output
      * - ``tags``
        - A list of :term:`zones <zone>` to which the shard belongs.
 
-     * - ``maxSize``
-       - The :ref:`configured <sharded-cluster-config-max-shard-size>`
-         maximum storage size of the shard in megabytes. This includes
-         all data files on the shard including the ``local`` and
-         ``admin`` databases. If exceeded, this shard will not receive
-         any more chunks.
-
      * - ``state``
        - An internal field used during the 
          :doc:`/reference/command/addShard` sequence to ensure that all

source/release-notes/6.2-compatibility.txt

@@ -16,3 +16,8 @@ Compatibility Changes in MongoDB 6.2 (Release Candidate)
 
 This page describes changes introduced in MongoDB 6.2 that can affect
 compatibility with older versions of MongoDB.
+
+Removed Options
+---------------
+
+.. include:: /includes/fact-remove-maxSize-addShard.rst

source/release-notes/6.2.txt

@@ -69,6 +69,11 @@ Collection Validation Improvements
 
 .. include:: /includes/validate-improvements-introduction.rst
 
+Changes to Sharding
+~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/fact-remove-maxSize-addShard.rst
+
 Server Parameters
 -----------------
 

source/tutorial/manage-sharded-cluster-balancer.txt

@@ -463,46 +463,14 @@ collection may block for a long period of time during the migration.
 Change the Maximum Storage Size for a Given Shard
 -------------------------------------------------
 
-By default shards have no constraints in storage size. However, you can set a
-maximum storage size for a given shard in the sharded cluster. When 
-selecting potential destination shards, the balancer ignores shards 
-where a migration would exceed the configured maximum storage size.
+Changing a shard's maximum storage size is deprecated. Starting in
+version 4.2, MongoDB uses the :ref:`storage-wiredtiger` to manage 
+how data is stored. WiredTiger compresses data to minimize storage 
+use. To learn more, see :ref:`storage-wiredtiger-compression`.
 
-The :data:`~config.shards` collection in the :ref:`config
-database<config-database>` stores configuration data related to shards. 
+For MongoDB versions 6.1 and earlier, you can still set a
+maximum storage size for a given shard in the sharded cluster by
+using the ``maxSize`` field. You can find configuration 
+data related to shards in the :data:`config.shards` collection.
 
-.. code-block:: javascript
-
-   { "_id" : "shard0000", "host" : "shard1.example.com:27100" }
-   { "_id" : "shard0001", "host" : "shard2.example.com:27200" }
-   
-To limit the storage size for a given shard, use the
-:method:`db.collection.updateOne()` method with the :update:`$set` operator to
-create the ``maxSize`` field and assign it an ``integer`` value. The
-``maxSize`` field represents the maximum storage size for the shard in
-``megabytes``.
-
-The following operation sets a maximum size on a shard of ``1024 megabytes``:
-
-.. code-block:: javascript
-
-   config = db.getSiblingDB("config")
-   config.shards.updateOne( { "_id" : "<shard>"}, { $set : { "maxSize" : 1024 } } )
-
-This value includes the mapped size of *all* data files on the
-shard, including the ``local`` and ``admin`` databases.
-
-By default, ``maxSize`` is not specified, allowing shards to consume the
-total amount of available space on their machines if necessary.
-
-You can also set ``maxSize`` when adding a shard.
-
-To set ``maxSize`` when adding a shard, set the :dbcommand:`addShard`
-command's ``maxSize`` parameter to the maximum size in ``megabytes``. The
-following command run in the :binary:`~bin.mongosh` shell adds a shard 
-with a maximum size of 125 megabytes:
-
-.. code-block:: javascript
-
-   config = db.getSiblingDB("config")
-   config.runCommand( { addshard : "example.net:34008", maxSize : 125 } )
+.. include:: /includes/fact-remove-maxSize-addShard.rst