DOCSP-26508 Add --forceConnectionOptions (#465)

* DOCSP-26508 Add --forceConnectionOptions

* edit task page + fix table proportions

* edit toc

* fix reflink

* update include description

* another reflink fix

* cleanup include description

* add reasoning in task page desc

* DC edits

* typo

* DC feedback

* AH feedback

* build errors

* clean up intro text

* clean up sentence pt 2

Author: ajhuh-mdb

source/command-line-options.txt

@@ -73,12 +73,12 @@ cannot be set in the :guilabel:`Settings` panel.
 
    Show |compass| version.
 
-Command Line or Settings Panel
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+General Settings
+~~~~~~~~~~~~~~~~
 
-These options can be set on the command line **or** in the 
-:guilabel:`Settings` panel. Setting an option on the command line 
-overrides the value in the :guilabel:`Settings` panel.        
+These options can be set on the command line, in a configuration file, or in the 
+:guilabel:`Settings` panel. Setting an option on the command line overrides the 
+value in the :guilabel:`Settings` panel.        
 
 .. option:: --autoUpdates
 
@@ -95,6 +95,10 @@ overrides the value in the :guilabel:`Settings` panel.
    Allow |compass| to make requests to a 3rd party mapping service. Use
    ``--no-enableMaps`` to disable mapping requests.
 
+.. option:: --forceConnectionOptions
+
+   .. include:: /includes/fact-force-connection-options.rst
+
 .. option:: --networkTraffic
 
    Configure |compass| to only allow outgoing :ref:`network operations 

source/config-file.txt

@@ -57,11 +57,17 @@ When you configure settings with a configuration file:
 Tasks
 -----
 
-To see how to configure specific settings, see :ref:`Compass Configuration File Options 
-<config-file-options>`.
+- :ref:`compass-configure-network-traffic`
+
+- :ref:`specify-read-preference-tags`
+
+.. seealso::
+   
+   :ref:`<config-file-options>`
 
 .. toctree::
    :titlesonly:
 
-   /config-file/restrict-outgoing-connections
    /config-file/config-file-options
+   /config-file/restrict-outgoing-connections
+   /config-file/specify-read-preference-tags

source/config-file/config-file-options.txt

@@ -50,11 +50,14 @@ You can configure the following settings in a configuration file:
 
 .. list-table::
    :header-rows: 1
-   :widths: 15 60
+   :widths: 30 70
 
    * - Setting 
      - Definition
 
+   * - :ref:`forceConnectionOptions <compass-force-connection-options>`
+     - .. include:: /includes/fact-force-connection-options.rst
+
    * - :ref:`networkTraffic <compass-configure-network-traffic>`
      - Configure |compass| to not perform outgoing network operations other 
        than those to the database.

source/config-file/specify-read-preference-tags.txt

@@ -0,0 +1,83 @@
+.. _compass-force-connection-options:
+.. _specify-read-preference-tags:
+
+================================
+Specify Read Preference and Tags
+================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can use the ``forceConnectionOptions`` option to set required connection 
+option values on |compass-short|. By setting required connection options such as 
+read preference, you can restrict how users connect to your MongoDB deployment 
+and ensure that their read operations don't impact the availability of replica 
+set primaries.
+
+Procedure
+---------
+
+In this example, you limit read operations to read only from ``SECONDARY`` 
+replica set members with the ``ANALYTICS`` and ``READ_ONLY`` tags. You can 
+specify these options on the command line or in a :ref:`configuration 
+file <config-file>`. 
+
+Command Line Example
+~~~~~~~~~~~~~~~~~~~~
+
+The following command starts |compass| from the command line and uses
+``--forceConnectionOptions`` to set the ``readPreference`` and 
+``readPreferenceTags`` options:
+
+.. code-block:: sh
+
+   <path-to-Compass-executable> \
+   --forceConnectionOptions.readPreference=secondary \
+   --forceConnectionOptions.readPreferenceTags=nodeType:ANALYTICS \
+   --forceConnectionOptions.readPreferenceTags=nodeType:READ_ONLY
+
+.. note::
+
+  The name and filepath of the |compass-short| executable depend on your
+  operating system.
+
+Configuration File Example
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can specify the |compass-short| configuration file in either EJSON
+or YAML format. To set the ``readPreference`` and ``readPreferenceTags``, use 
+``--forceConnectionOptions``:
+
+EJSON
+`````
+
+.. code-block:: json
+
+   { 
+     "forceConnectionOptions": [
+       ["readPreference", "secondary"],
+       ["readPreferenceTags", "nodeType:ANALYTICS"],
+       ["readPreferenceTags", "nodeType:READ_ONLY"]
+     ] 
+   }
+
+YAML
+````
+
+.. code-block:: yaml
+
+   forceConnectionOptions:
+     - readPreference: secondary
+     - readPreferenceTags: nodeType:ANALYTICS
+     - readPreferenceTags: nodeType:READ_ONLY
+
+Learn More
+----------
+
+To learn more about the |compass| configuration file, see
+:ref:`config-file`.

source/includes/fact-force-connection-options.rst

@@ -0,0 +1,5 @@
+Assign :manual:`connection option 
+</reference/connection-string/#connection-string-options>` values for when you
+connect to your MongoDB deployment through |compass-short|. These connection 
+options cannot be overridden by connections from the |compass-short| interface or 
+a command line connection string.