Skip to content

Commit 865a750

Browse files
(DOCSP-7107): New connection ux (#185)
* (DOCSP-7107): New connection ux * Updates per Steve's feedback
1 parent f7e560c commit 865a750

14 files changed

+526
-482
lines changed

source/connect.txt

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,66 @@ Connect to MongoDB
1212
:depth: 1
1313
:class: singlecol
1414

15-
This page outlines how to use |compass-short| to connect to your
16-
MongoDB host.
15+
This page outlines how to use |compass| to connect to a
16+
MongoDB host. You can connect to a standalone, replica set,
17+
or sharded cluster host.
1718

18-
.. note::
19+
If you need to install |compass-short|, see
20+
:ref:`download-install` for instructions.
21+
22+
Considerations
23+
--------------
24+
25+
- When connecting |compass-short| to a replica set, it is not
26+
recommended to connect directly to an individual replica
27+
set member. If the member to which you are connected switches from a
28+
:manual:`primary </core/replica-set-primary/>` member to a
29+
:manual:`secondary </core/replica-set-secondary/>` or vice versa as
30+
the result of an election, |compass-short| may either forcibly close
31+
the connection or display stale data.
32+
33+
Instead, to connect to a replica set, use either the replica set
34+
:guilabel:`SRV record` or :guilabel:`Replica Set Name` when
35+
filling in your connection information.
1936

20-
.. include:: /includes/fact-non-genuine-warning.rst
37+
- .. include:: /includes/fact-non-genuine-warning.rst
2138

2239
Connect
2340
-------
2441

25-
.. include:: /includes/steps/starting-compass.rst
42+
When you open |compass-short|, an initial connection dialog appears:
43+
44+
.. figure:: /images/compass/paste-connection-string.png
45+
:figwidth: 690px
46+
47+
|compass-short| provides two methods to connect to your deployment,
48+
either providing your deployment connection string or filling in your
49+
deployment information in specific fields.
50+
51+
.. tabs::
52+
53+
.. tab:: Paste Connection String
54+
:tabid: paste-connection-string
55+
56+
.. include:: /includes/steps/starting-compass-paste-string.rst
57+
58+
.. tab:: Fill in Individual Fields
59+
:tabid: individual-fields
60+
61+
.. include:: /includes/steps/starting-compass-individual-fields.rst
62+
63+
For MongoDB permissions required to access |compass-short|,
64+
see :ref:`required-access`.
65+
66+
.. note::
67+
68+
|compass| securely stores sensitive information entered in the
69+
connection form using an API that is specific to your operating
70+
system.
71+
72+
For more information on how |compass-short| handles sensitive
73+
data, refer to the
74+
:ref:`FAQ page <compass-faq-confidential-data>`.
2675

2776
.. _disconnect:
2877

25.5 KB
Loading
89.7 KB
Loading
Loading

source/includes/fact-connect-auth-info.rst

Lines changed: 0 additions & 95 deletions
This file was deleted.

source/includes/fact-connect-host-description.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

source/includes/fact-connect-port-description.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

source/includes/fact-connect-srv-description.rst

Lines changed: 0 additions & 30 deletions
This file was deleted.

source/includes/list-table-ssh-connection.rst

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)