DOCSP-24594-Compass-auth-examples

source/connect/advanced-connection-options/advanced-connection.txt

@@ -113,3 +113,15 @@ Procedure
 .. seealso::
 
    To disconnect from your deployment, see :ref:`<disconnect-tab>`. 
+
+Example
+-------
+
+The following example specifies a connection with a read preference of
+:guilabel:`Secondary Preferred` in the :guilabel:`Advanced` tab. The
+:guilabel:`Secondary Preferred` read preference prevents queries from
+overloading the primary node. 
+
+.. figure:: /images/authentication/secondary-preferred.png
+   :figwidth: 662px
+   :alt: Screenshot of Compass configured to connect with read preference of secondary preferred

source/connect/advanced-connection-options/authentication-connection.txt

@@ -54,6 +54,7 @@ Procedure
       Username / Password 
       ~~~~~~~~~~~~~~~~~~~
 
+
       Provide the following information:
 
       - Username
@@ -237,6 +238,13 @@ Procedure
       LDAP
       ~~~~
 
+      .. note::
+
+         See the :ref:`Examples
+         <authentication-username-password-example>` section on this
+         page for an example of the authentication tab configured for
+         username and password authentication. 
+
       Select :guilabel:`LDAP` if the deployment uses :manual:`LDAP 
       </core/security-ldap-external/>` as its authentication mechanism. 
 
@@ -273,3 +281,32 @@ Procedure
 .. seealso::
 
    To disconnect from your deployment, see :ref:`<disconnect-tab>`.
+
+Examples
+--------
+
+.. _authentication-username-password-example:
+
+Username and Password Authentication
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example specifies a connection with username and
+password authentication with :manual:`SCRAM-SHA-256
+</core/security-scram/>` in the :guilabel:`Authentication` tab.
+
+.. figure:: /images/authentication/authentication-configuration.png
+   :figwidth: 662px
+   :alt: Screenshot of Compass configured to authenticate with username and password
+
+.. _authentication-ldap-example:
+
+LDAP Authentication
+~~~~~~~~~~~~~~~~~~~
+
+Alternatively, the following example specifies a connection with
+:manual:`LDAP </core/security-ldap-external/>` authentication in the
+:guilabel:`Authentication` tab.  
+
+.. figure:: /images/authentication/ldap-configuration.png
+   :figwidth: 662px
+   :alt: Screenshot of Compass configured to authenticate with LDAP

source/connect/advanced-connection-options/general-connection.txt

@@ -52,14 +52,31 @@ Procedure
             * - mongodb
               - :manual:`Standard Connection String Format </reference/connection-string/>`. 
                 The standard format of the MongoDB connection URI is used to 
-                connect to a MongoDB deployment by specifying its hosts directly.
+                connect to a MongoDB deployment by specifying its hosts
+                directly.
+
+                Use this option to connect to standalone, replica set,
+                or a sharded cluster
+
+                .. note::
+
+                   If you use the standard connection string format to
+                   connect to an `Atlas
+                   <https://www.mongodb.com/cloud/atlas>`__ deployment,
+                   you must turn on TLS/SSL in the
+                   :guilabel:`TLS/SSL` tab of the :guilabel:`New
+                   Connection` modal. 
 
             * - mongodb+srv 
               - :manual:`DNS Seed List Connection Format 
                 </reference/connection-string/#dns-seed-list-connection-format>`. 
                 The ``+srv`` indicates to |compass| that the hostname that follows 
                 corresponds to a DNS SRV record.
 
+              .. note::
+
+                  The mongodb+srv automatically enables TLS/SSL.
+
       b) Enter a Hostname.
 
          In the :guilabel:`Host` field, enter the hosts or hostname of the server 
@@ -93,3 +110,15 @@ Procedure
 .. seealso::
 
    To disconnect from your deployment, see :ref:`<disconnect-tab>`. 
+
+Example
+-------
+
+The following example specifies a connection with :manual:`SCRAM-SHA-256
+</core/security-scram/>` in the :guilabel:`General` tab. Since the
+connection uses the ``mongodb`` connection string scheme to connect to
+an Atlas cluster, the connection also enables TLS/SSL. 
+
+.. figure:: /images/authentication/new-atlas-connection.png
+   :figwidth: 662px
+   :alt: Screenshot of Compass configured to connect to an example Atlas cluster

source/connect/advanced-connection-options/tls-ssl-connection.txt

@@ -16,6 +16,12 @@ The :guilabel:`TLS / SSL` tab allows you to connect deployments with TLS / SSL.
 For more information on :guilabel:`TLS / SSL`, see :manual:`TLS Options 
 </reference/connection-string/#tls-options>`
 
+.. note::
+
+   If you connect to an Atlas cluster with the :manual:`standard
+   connection string format </reference/connection-string/>`, you must
+   enable TLS/SSL. 
+
 Procedure
 ---------
 
@@ -105,7 +111,8 @@ Procedure
       .. warning:: 
 
          Enabling ``tlsInsecure``, ``tlsAllowInvalidHostnames``, and 
-         ``tlsAllowInvalidCertificates`` may cause a security vulnerabilty. 
+         ``tlsAllowInvalidCertificates`` may cause a security
+         vulnerabilty. 
 
    .. step:: (Optional) For advanced connection configuration options, click the :ref:`Advanced <advanced-connection-tab>` tab.
 
@@ -114,3 +121,17 @@ Procedure
 .. seealso::
 
    To disconnect from your deployment, see :ref:`<disconnect-tab>`.
+
+Example
+-------
+
+The following example specifies a connection with TLS/SSL enabled in the
+:guilabel:`TLS / SSL` tab. This connection uses :manual:`X.509
+</core/security-x.509/>` authentication which requires a client
+certificate. 
+
+.. figure:: /images/authentication/tls-ssl-configuration.png
+   :figwidth: 662px
+   :alt: Screenshot of Compass configured to connect to an example cluster with TLS/SSL
+
+1