Skip to content

Commit 44f2625

Browse files
authored
DOCSP-24594-Compass-auth-examples (#708)
* DOCSP-24594-Compass-auth-examples * DOCSP-24594-Compass-auth-examples * DOCSP-24594-Compass-auth-examples * DOCSP-24594-Compass-auth-examples * DOCSP-24594-Compass-auth-examples * DOCSP-24594 copy edits * DOCSP-24954 copy edits * DOCSP-24594 copy edits * DOCSP-24594 copy edits * DOCSP-24594 tech edits * DOCSP-24594 tech edits * DOCSP-24594 tech edits * DOCSP-24594 update tls image * DOCSP-24594 updating screenshots * DOCSP-24594 fixing build * DOCSP-24594 fixing build
1 parent 607bbe4 commit 44f2625

10 files changed

+101
-2
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,15 @@ Procedure
113113
.. seealso::
114114

115115
To disconnect from your deployment, see :ref:`<disconnect-tab>`.
116+
117+
Example
118+
-------
119+
120+
The following example specifies a connection with a read preference of
121+
:guilabel:`Secondary Preferred` in the :guilabel:`Advanced` tab. The
122+
:guilabel:`Secondary Preferred` read preference prevents queries from
123+
overloading the primary node.
124+
125+
.. figure:: /images/authentication/secondary-preferred.png
126+
:figwidth: 662px
127+
:alt: Screenshot of Compass configured to connect with read preference of secondary preferred

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Procedure
5454
Username / Password
5555
~~~~~~~~~~~~~~~~~~~
5656

57+
5758
Provide the following information:
5859

5960
- Username
@@ -244,6 +245,13 @@ Procedure
244245
LDAP
245246
~~~~
246247

248+
.. note::
249+
250+
See the :ref:`Examples
251+
<authentication-username-password-example>` section on this
252+
page for an example of the authentication tab configured for
253+
username and password authentication.
254+
247255
Select :guilabel:`LDAP` if the deployment uses :manual:`LDAP
248256
</core/security-ldap-external/>` as its authentication mechanism.
249257

@@ -280,3 +288,32 @@ Procedure
280288
.. seealso::
281289

282290
To disconnect from your deployment, see :ref:`<disconnect-tab>`.
291+
292+
Examples
293+
--------
294+
295+
.. _authentication-username-password-example:
296+
297+
Username and Password Authentication
298+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299+
300+
The following example specifies a connection with username and
301+
password authentication with :manual:`SCRAM-SHA-256
302+
</core/security-scram/>` in the :guilabel:`Authentication` tab.
303+
304+
.. figure:: /images/authentication/authentication-configuration.png
305+
:figwidth: 662px
306+
:alt: Screenshot of Compass configured to authenticate with username and password
307+
308+
.. _authentication-ldap-example:
309+
310+
LDAP Authentication
311+
~~~~~~~~~~~~~~~~~~~
312+
313+
Alternatively, the following example specifies a connection with
314+
:manual:`LDAP </core/security-ldap-external/>` authentication in the
315+
:guilabel:`Authentication` tab.
316+
317+
.. figure:: /images/authentication/ldap-configuration.png
318+
:figwidth: 662px
319+
:alt: Screenshot of Compass configured to authenticate with LDAP

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

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,31 @@ Procedure
5252
* - mongodb
5353
- :manual:`Standard Connection String Format </reference/connection-string/>`.
5454
The standard format of the MongoDB connection URI is used to
55-
connect to a MongoDB deployment by specifying its hosts directly.
55+
connect to a MongoDB deployment by specifying its hosts
56+
directly.
57+
58+
Use this option to connect to standalone, replica set,
59+
or a sharded cluster
60+
61+
.. note::
62+
63+
If you use the standard connection string format to
64+
connect to an `Atlas
65+
<https://www.mongodb.com/cloud/atlas>`__ deployment,
66+
you must turn on TLS/SSL in the
67+
:guilabel:`TLS/SSL` tab of the :guilabel:`New
68+
Connection` modal.
5669

5770
* - mongodb+srv
5871
- :manual:`DNS Seed List Connection Format
5972
</reference/connection-string/#dns-seed-list-connection-format>`.
6073
The ``+srv`` indicates to |compass| that the hostname that follows
6174
corresponds to a DNS SRV record.
6275

76+
.. note::
77+
78+
The ``+srv`` automatically enables TLS/SSL.
79+
6380
b) Enter a Hostname.
6481

6582
In the :guilabel:`Host` field, enter the hosts or hostname of the server
@@ -93,3 +110,15 @@ Procedure
93110
.. seealso::
94111

95112
To disconnect from your deployment, see :ref:`<disconnect-tab>`.
113+
114+
Example
115+
-------
116+
117+
The following example specifies a connection with :manual:`SCRAM-SHA-256
118+
</core/security-scram/>` in the :guilabel:`General` tab. Since the
119+
connection uses the ``mongodb`` connection string scheme to connect to
120+
an Atlas cluster, the connection also enables TLS/SSL.
121+
122+
.. figure:: /images/authentication/new-atlas-connection.png
123+
:figwidth: 662px
124+
:alt: Screenshot of Compass configured to connect to an example Atlas cluster

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ The :guilabel:`TLS / SSL` tab allows you to connect deployments with TLS / SSL.
1616
For more information on :guilabel:`TLS / SSL`, see :manual:`TLS Options
1717
</reference/connection-string/#tls-options>`
1818

19+
.. note::
20+
21+
If you connect to an Atlas cluster with the :manual:`standard
22+
connection string format </reference/connection-string/>`, you must
23+
enable TLS/SSL.
24+
1925
Procedure
2026
---------
2127

@@ -105,7 +111,8 @@ Procedure
105111
.. warning::
106112

107113
Enabling ``tlsInsecure``, ``tlsAllowInvalidHostnames``, and
108-
``tlsAllowInvalidCertificates`` may cause a security vulnerabilty.
114+
``tlsAllowInvalidCertificates`` may cause a security
115+
vulnerabilty.
109116

110117
.. step:: (Optional) For advanced connection configuration options, click the :ref:`Advanced <advanced-connection-tab>` tab.
111118

@@ -114,3 +121,17 @@ Procedure
114121
.. seealso::
115122

116123
To disconnect from your deployment, see :ref:`<disconnect-tab>`.
124+
125+
Example
126+
-------
127+
128+
The following example specifies a connection with TLS/SSL enabled in the
129+
:guilabel:`TLS / SSL` tab. This connection uses :manual:`X.509
130+
</core/security-x.509/>` authentication which requires a client
131+
certificate.
132+
133+
.. figure:: /images/authentication/tls-ssl-configuration.png
134+
:figwidth: 662px
135+
:alt: Screenshot of Compass configured to connect to an example cluster with TLS/SSL
136+
137+
1
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)