DOCS-11323: skipShardingConfigurationChecks

kay-kim · kay-kim · commit 64beac22c240 · 2018-06-26T09:02:17.000-04:00
diff --git a/source/includes/options-mongod.yaml b/source/includes/options-mongod.yaml
@@ -1137,6 +1137,17 @@ description: |
 
   Do not use the {{role}} option with :option:`--shardsvr`. Config
   servers cannot be a shard server.
+
+  Do not use the {{role}} with the
+  :parameter:`skipShardingConfigurationChecks` parameter. That is, if
+  you are temporarily starting the :binary:`~bin.mongod` as a
+  standalone for maintenance operations, include the parameter
+  :parameter:`skipShardingConfigurationChecks` and exclude {{role}}.
+  Once maintenance has completed, remove the
+  :parameter:`skipShardingConfigurationChecks` parameter and restart
+  with {{role}}.
+
+
 optional: false
 ---
 program: mongod
@@ -1152,11 +1163,17 @@ description: |
 
   .. important::
 
-     .. versionchanged:: 3.6
-
-     You must deploy shards as replica sets. See the :option:`--replSet`
+     Starting in MongoDB 3.6, you must deploy shards as replica sets. See the :option:`--replSet`
      option to deploy {{program}} as part of a replica set.
 
+  Do not use the {{role}} with the
+  :parameter:`skipShardingConfigurationChecks` parameter. That is, if
+  you are temporarily starting the :binary:`~bin.mongod` as a
+  standalone for maintenance operations, include the parameter
+  :parameter:`skipShardingConfigurationChecks` and exclude {{role}}.
+  Once maintenance has completed, remove the
+  :parameter:`skipShardingConfigurationChecks` parameter and restart
+  with {{role}}.
 
 optional: false
 ---
diff --git a/source/includes/steps-perform-maintenance-task-on-replica-set-members.yaml b/source/includes/steps-perform-maintenance-task-on-replica-set-members.yaml
@@ -10,30 +10,94 @@ action:
 title: Restart the secondary as a standalone on a different port.
 stepnum: 2
 ref: restart-diff-port
-pre: |
-  At the operating system shell prompt restart :binary:`~bin.mongod`
-  as a standalone instance, making
-  the following modifications to the configuration file.
-
-  - Comment out the :setting:`replication.replSetName` option.
-  - For :term:`shard` or :term:`config server` replica sets, comment out
-    the :setting:`sharding.clusterRole` option.
-  - Change the :setting:`net.port` to a different port. Make a note
-    of the original port setting as a comment.
-
-  If using command line options, modify :option:`--port <mongod --port>` 
-  and remove the :option:`--replSetName <mongod --replSet>`, 
-  :option:`--shardsvr <mongod --shardsvr>`, and
-  :option:`--configsvr <mongod --configsvr>` options.
-     
-  .. include:: /includes/warning-bind-ip-security-considerations.rst
+content: |
 
-action:
-  language: sh
-  code: mongod --port 37017 --dbpath /srv/mongodb --bind_ip localhost,<ip address of the mongod host>
-post: |
-  Always start :binary:`~bin.mongod` with the same user, even when
-  restarting a replica set member as a standalone instance.
+   At the operating system shell prompt restart :binary:`~bin.mongod`
+   as a standalone instance.
+
+   .. tabs::
+
+      tabs:
+         - id: config-file
+           name: Configuration File
+           content: |
+
+              If you are using a configuration file, make the following
+              configuration updates:
+
+              - Comment out the :setting:`replication.replSetName` option.
+
+              - Change the :setting:`net.port` to a different port.
+                Make a note of the original port setting as a comment.
+
+              - If the :binary:`~bin.mongod` is a :term:`shard` or
+                :term:`config server` member, you must also:
+
+                - Comment out the :setting:`sharding.clusterRole` option.
+
+                - Set parameter :parameter:`skipShardingConfigurationChecks`
+                  (available for MongoDB 4.0+, 3.6.3+, 3.4.11+, 3.2.19+) to
+                  ``true`` in the :setting:`setParameter` section.
+
+              For example, if performing maintenance on a shard/config
+              server replica set member for maintenance, the updated
+              configuration file will include content like the
+              following example:
+
+              .. code-block:: yaml
+
+                 net:
+                    bindIp: localhost,<ip address of the mongod host>
+                    port: 27218
+                 #   port: 27018
+                 #replication:
+                 #   replSetName: shardA
+                 #sharding:
+                 #   clusterRole: shardsvr
+                 setParameter:
+                    skipShardingConfigurationChecks: true
+
+         - id: command-line
+           name: Command-line Options
+           content: |
+
+              If using command-line options, make the following
+              configuration updates to restart:
+
+              - Remove :option:`--replSetName <mongod --replSet>`.
+
+              - Modify :option:`--port <mongod --port>` to a different port.
+
+              - If the :binary:`~bin.mongod` is a :term:`shard` or
+                :term:`config server` member, you must also:
+
+                - Remove :option:`--shardsvr <mongod --shardsvr>` if a
+                  shard member and :option:`--configsvr <mongod
+                  --configsvr>` if a config server member.
+  
+                - Set parameter
+                  :parameter:`skipShardingConfigurationChecks`
+                  (available for MongoDB 4.0+, 3.6.3+, 3.4.11+,
+                  3.2.19+) to ``true`` in the :setting:`setParameter`
+                  section.
+
+  
+              For example, to restart a replica set member that is not part of a sharded cluster:
+
+              .. code-block:: sh
+
+                 mongod --port 37017 --dbpath /srv/mongodb --bind_ip localhost,<ip address of the mongod host>
+
+              For example, to restart a shard/config server replica set member for maintenance:
+
+              .. code-block:: sh
+
+                 mongod --port 37017 --dbpath /srv/mongodb --bind_ip localhost,<ip address of the mongod host> --setParameter skipShardingConfigurationChecks=true
+
+   .. include:: /includes/warning-bind-ip-security-considerations.rst
+
+   Always start :binary:`~bin.mongod` with the same user, even when
+   restarting a replica set member as a standalone instance.
 ---
 title: Perform maintenance operations on the secondary.
 stepnum: 3
@@ -61,9 +125,13 @@ action:
        use admin
        db.shutdownServer()
   - pre: |
-      Restart the :binary:`~bin.mongod` instance as a member of
-      the replica set using its normal configuration file or 
-      command-line arguments.
+ 
+      Restart the :binary:`~bin.mongod` instance as a replica set
+      member with its original configuration; that is, undo the
+      configuration changes made when starting as a standalone.
+
+      For shard or config server members, be sure to remove the
+      :parameter:`skipShardingConfigurationChecks` parameter.
 
       When it has started, connect the :binary:`~bin.mongo` shell to the
       restarted instance.
@@ -90,25 +158,99 @@ action:
   language: javascript
   code: rs.stepDown(300)
 post: |
-  After the primary steps down, the replica set will elect a new
-  primary. See :ref:`replica-set-elections` for more
-  information about replica set elections.
-
-  Restart :binary:`~bin.mongod` as a standalone instance, making
-  the following modifications to the configuration file.
-
-  - Comment out the :setting:`replication.replSetName` option.
-  - For :term:`shard` or :term:`config server` replica sets, comment out
-    the :setting:`sharding.clusterRole`.
-
-  If using command line options, modify :option:`--port <mongod --port>` 
-  and remove the :option:`--replSetName <mongod --replSet>`, 
-  :option:`--shardsvr <mongod --shardsvr>`, and
-  :option:`--configsvr <mongod --configsvr>` options.
-     
-  .. include:: /includes/warning-bind-ip-security-considerations.rst
-
-  After performing all maintenance tasks, restart the
-  :binary:`~bin.mongod` instance as a member of the replica set
-  using its normal command-line arguments or configuration file. 
+   After the primary steps down, the replica set will :ref:`elect a new
+   primary <replica-set-elections>`.
+
+   Restart :binary:`~bin.mongod` as a standalone instance, making the
+   following configuration updates.
+
+   .. tabs::
+
+      tabs:
+         - id: config-file
+           name: Configuration File
+           content: |
+
+              If you are using a configuration file, make the following
+              configuration updates:
+
+              - Comment out the :setting:`replication.replSetName` option.
+
+              - Change the :setting:`net.port` to a different port.
+                Make a note of the original port setting as a comment.
+
+              - If the :binary:`~bin.mongod` is a :term:`shard` or
+                :term:`config server` member, you must also:
+
+                - Comment out the :setting:`sharding.clusterRole` option.
+
+                - Set parameter :parameter:`skipShardingConfigurationChecks`
+                  (available for MongoDB 4.0+, 3.6.3+, 3.4.11+, 3.2.19+) to
+                  ``true`` in the :setting:`setParameter` section.
+
+              For example, if performing maintenance on a shard/config
+              server replica set member for maintenance, the updated
+              configuration file will include content like the
+              following example:
+
+              .. code-block:: yaml
+
+                 net:
+                    bindIp: localhost,<ip address of the mongod host>
+                    port: 27218
+                 #   port: 27018
+                 #replication:
+                 #   replSetName: shardA
+                 #sharding:
+                 #   clusterRole: shardsvr
+                 setParameter:
+                    skipShardingConfigurationChecks: true
+
+         - id: command-line
+           name: Command-line Options
+           content: |
+
+              If using command-line options, make the following
+              configuration updates:
+
+              - Remove :option:`--replSetName <mongod --replSet>`.
+
+              - Modify :option:`--port <mongod --port>` to a different port.
+
+              - If the :binary:`~bin.mongod` is a :term:`shard` or
+                :term:`config server` member, you must also:
+
+                - Remove :option:`--shardsvr <mongod --shardsvr>` if a
+                  shard member and :option:`--configsvr <mongod
+                  --configsvr>` if a config server member.
+  
+                - Set parameter
+                  :parameter:`skipShardingConfigurationChecks`
+                  (available for MongoDB 4.0+, 3.6.3+, 3.4.11+,
+                  3.2.19+) to ``true`` in the :setting:`setParameter`
+                  section.
+
+  
+              For example, to restart a replica set member that is not part of a sharded cluster:
+
+              .. code-block:: sh
+
+                 mongod --port 37017 --dbpath /srv/mongodb --bind_ip localhost,<ip address of the mongod host>
+
+              For example, to restart a shard/config server replica set member for maintenance:
+
+              .. code-block:: sh
+
+                 mongod --port 37017 --dbpath /srv/mongodb --bind_ip localhost,<ip address of the mongod host> --setParameter skipShardingConfigurationChecks=true
+
+   .. include:: /includes/warning-bind-ip-security-considerations.rst
+
+   After performing all maintenance tasks, restart the
+   :binary:`~bin.mongod` instance as a replica set member with its
+   original configuration; that is, undo the configuration changes made
+   when starting as a standalone.
+
+   For shard or config server members, be sure to remove the
+   :parameter:`skipShardingConfigurationChecks` parameter.
+ 
 ...
diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt
@@ -1597,6 +1597,40 @@ Sharding Parameters
 
       db.adminCommand( { setParameter: 1, orphanCleanupDelaySecs: 1200 } )
 
+.. parameter:: skipShardingConfigurationChecks
+
+   .. versionadded:: 3.6.3
+
+   |mongod-only|
+
+   Type: boolean
+
+   Default: false
+
+   When ``true``, allows for starting a shard member or config server
+   member as a standalone for maintenance operations. This parameter is
+   mutually exclusive with the :option:`--configsvr <mongod
+   --configsvr>` or :option:`--shardsvr <mongod --shardsvr>` options.
+
+   You can only set this parameter during start-up and cannot change
+   this setting using the :dbcommand:`setParameter` database command.
+
+   .. code-block:: sh
+
+      mongod --setParameter skipShardingConfigurationChecks=true
+
+   .. important::
+   
+      Once maintenance has completed, remove the
+      :parameter:`skipShardingConfigurationChecks` parameter when
+      restarting the :binary:`~bin.mongod`.
+
+   The parameter is also available for MongoDB versions:
+
+   - MongoDB 3.2.19+
+
+   - MongoDB 3.4.11+
+
 Storage Parameters
 ~~~~~~~~~~~~~~~~~~
 
diff --git a/source/tutorial/build-indexes-on-replica-sets.txt b/source/tutorial/build-indexes-on-replica-sets.txt
