Skip to content

Commit 018835a

Browse files
DOCSP-13550 Update hostname inputs in connection form
1 parent 95f679b commit 018835a

File tree

1 file changed

+121
-90
lines changed

1 file changed

+121
-90
lines changed

source/includes/steps-starting-vsce-individual-fields.yaml

Lines changed: 121 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,7 @@ content: |
5454
For more information, see the **Paste Connection String** tab in
5555
:ref:`vsce-connect-task`.
5656
57-
The :guilabel:`General` tab contains the following connection
58-
field options:
57+
The :guilabel:`General` tab contains the following options:
5958
6059
.. list-table::
6160
:header-rows: 1
@@ -64,69 +63,116 @@ content: |
6463
* - Option
6564
- Description
6665
67-
* - :guilabel:`Hostname`
68-
- Hostname of the machine where the deployment is
69-
running.
66+
* - :guilabel:`Connection Type`
67+
- Type of connection. Select your connection type from the tabs
68+
below for specific instructions for defining that connection
69+
type:
70+
71+
.. tabs::
72+
73+
.. tab:: Standalone
74+
:tabid: standalone
75+
76+
For a :manual:`Standalone </reference/connection-string/#dns-seedlist-connection-format>`,
77+
specify the following:
78+
79+
- :guilabel:`Hostname` of the machine where the
80+
deployment is running.
81+
82+
If you are running your deployment locally, this value
83+
is ``localhost``. If you are connecting to an
84+
|service| cluster, you can get your hostname from your
85+
cluster detail view in |service|.
86+
87+
If you are not sure of your hostname, contact your
88+
Database Administrator for information.
89+
90+
- :guilabel:`Port` on which the deployment is running.
91+
92+
By default, a standalone deployment operates on port
93+
``27017``. For more information on the default ports
94+
MongoDB operates on, see :manual:`Default MongoDB Port
95+
</reference/default-mongodb-port/>`.
96+
97+
If you are not sure of the port where your deployment
98+
operates, contact your Database Administrator for
99+
information.
100+
101+
Click :icon-fa4:`plus` to specify additional hostnames
102+
and associated ports.
103+
104+
.. tab:: Replica Set
105+
:tabid: replicaset
106+
107+
For a :manual:`replica set </reference/connection-string/#dns-seedlist-connection-format>`,
108+
specify the following:
109+
110+
- :guilabel:`Hostname` of the machine where the
111+
deployment is running.
70112
71-
If you are running your deployment locally, this value is
72-
``localhost``. If you are connecting to an |service| cluster,
73-
you can get your hostname from your cluster detail view in
74-
|service|.
113+
If you are running your deployment locally, this value
114+
is ``localhost``. If you are connecting to an
115+
|service| cluster, you can get your hostname from your
116+
cluster detail view in |service|.
117+
118+
If you are not sure of your hostname, contact your
119+
Database Administrator for information.
120+
121+
- :guilabel:`Port` on which the deployment is running.
122+
123+
For information on the default ports MongoDB operates
124+
on, see :manual:`Default MongoDB Port
125+
</reference/default-mongodb-port/>`.
75126
76-
If you are not sure of your hostname, contact your Database
77-
Administrator for information.
127+
If you are not sure of the port where your deployment
128+
operates, contact your Database Administrator for
129+
information.
78130
79-
* - :guilabel:`Port`
80-
- Port on which the deployment is running. Not required if
81-
you are using an :guilabel:`SRV Record` to connect to
82-
your MongoDB deployment.
131+
- *Optional*. :guilabel:`Replica Set Name` as specified
132+
in the :manual:`replica set configuration </reference/replica-configuration/>`.
83133
84-
By default, a standalone deployment operates on port ``27017``.
85-
If you are connecting to a replica set, your port may also be
86-
``27018`` or ``27019``. For more information on the default
87-
ports MongoDB operates on, see :manual:`Default MongoDB Port
88-
</reference/default-mongodb-port/>`.
134+
Click :icon-fa4:`plus` to specify additional hostnames
135+
and associated ports.
89136
90-
If you are not sure of the port where your deployment operates,
91-
contact your Database Administrator for information.
137+
.. tab:: SRV Record
138+
:tabid: srvrecord
92139
93-
* - :guilabel:`SRV Record`
94-
- Indicates whether the provided :guilabel:`Hostname`
95-
is an :manual:`SRV Record
96-
</reference/connection-string/#dns-seedlist-connection-format>`.
97-
If this toggle is enabled, you do not need to specify a port.
140+
For an :manual:`SRV Record </reference/connection-string/#dns-seedlist-connection-format>`,
141+
specify the :guilabel:`Hostname`. You do not need to
142+
specify a port.
98143
99-
.. note::
144+
.. note::
100145
101-
You can only use SRV connection strings to connect to
102-
deployments running MongoDB 3.6 and later.
146+
You can only use SRV connection strings to connect to
147+
deployments running MongoDB 3.6 and later.
103148
104-
SRV connection strings have a prefix of ``mongodb+srv:``. If
105-
you are using an SRV connection string, you do not need to
106-
include ``mongodb+srv`` in your :guilabel:`Hostname`.
149+
SRV connection strings have a prefix of
150+
``mongodb+srv:``. If you are using an SRV connection
151+
string, you do not need to include ``mongodb+srv`` in
152+
your :guilabel:`Hostname`.
107153
108-
.. example::
154+
.. example::
109155
110-
If the following is your SRV connection string for your
111-
MongoDB deployment:
156+
If the following is your SRV connection string for
157+
your MongoDB deployment:
112158
113-
.. code-block:: shell
114-
:copyable: false
159+
.. code-block:: shell
160+
:copyable: false
115161
116-
mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test
162+
mongodb+srv://<username>:<password>@gettingstarted-7q2cs.mongodb.net/test
117163
118-
Then, in |vsce|, you would specify your
119-
:guilabel:`Hostname` as:
164+
Then, in |vsce|, you would specify your
165+
:guilabel:`Hostname` as:
120166
121-
.. code-block:: shell
122-
:copyable: false
167+
.. code-block:: shell
168+
:copyable: false
123169
124-
gettingstarted-7q2cs.mongodb.net
170+
gettingstarted-7q2cs.mongodb.net
125171
126172
* - :guilabel:`Authentication`
127-
- Authentication to use if the deployment
128-
requires authentication. |service| clusters use
129-
:guilabel:`Username / Password` authentication.
173+
- Authentication to use if the deployment requires
174+
authentication. |service| clusters use :guilabel:`Username
175+
/ Password` authentication.
130176
131177
Select your authentication method from the tabs below for
132178
specific instructions:
@@ -382,59 +428,44 @@ content: |
382428
tunnel. |vsce| cannot establish a connection
383429
to multiple servers across the same SSH tunnel.
384430
---
385-
title: "Specify replica set and security connection options."
431+
title: "Specify read preference in the :guilabel:`Advanced` tab."
386432
level: 4
387433
optional: true
388434
ref: connect-additional-options
389435
content: |
390-
You can specify the following security connection options:
436+
You can select the :guilabel:`Read Preference`, which specifies how
437+
|vsce| directs read operations. Options are:
391438
392439
.. list-table::
393440
:header-rows: 1
441+
:widths: 20 50
394442
395-
* - Option
443+
* - Read Preference Mode
396444
- Description
397-
398-
* - :guilabel:`Replica Set Name`
399-
- If your MongoDB deployment is a replica set, specify the
400-
replica set name. Not required if you specify your replica
401-
set :guilabel:`Hostname` as an :guilabel:`SRV Record`.
402-
403-
* - :guilabel:`Read Preference`
404-
- Specifies how |vsce| directs read operations. Options are:
405-
406-
.. list-table::
407-
:header-rows: 1
408-
:widths: 20 50
409-
410-
* - Read Preference Mode
411-
- Description
412-
413-
* - ``primary``
414-
- Default mode. All operations read from the current
415-
replica set primary.
416-
417-
* - ``primaryPreferred``
418-
- In most situations, operations read from the primary but
419-
if it is unavailable, operations read from secondary
420-
members.
421-
422-
* - ``secondary``
423-
- All operations read from the secondary members of the
424-
replica set.
425-
426-
* - ``secondaryPreferred``
427-
- In most situations, operations read from secondary
428-
members but if no secondary members are available,
429-
operations read from the primary.
430-
431-
* - ``nearest``
432-
- Operations read from member of the replica
433-
set with the least network latency, irrespective of the
434-
member's type.
445+
446+
* - :guilabel:`Primary`
447+
- Default mode. All operations read from the current replica set
448+
primary.
449+
450+
* - :guilabel:`Primary Preferred`
451+
- In most situations, operations read from the primary but if it
452+
is unavailable, operations read from secondary members.
453+
454+
* - :guilabel:`Secondary`
455+
- All operations read from the secondary members of the replica
456+
set.
457+
458+
* - :guilabel:`Secondary Preferred`
459+
- In most situations, operations read from secondary members but
460+
if no secondary members are available, operations read from
461+
the primary.
462+
463+
* - :guilabel:`Nearest`
464+
- Operations read from member of the replica set with the least
465+
network latency, irrespective of the member's type.
435466
436-
To learn more about read preferences, see
437-
:manual:`Read Preference </core/read-preference/>`.
467+
If omitted, defaults to :guilabel:`Primary`. To learn more about read
468+
preferences, see :manual:`Read Preference </core/read-preference/>`.
438469
439470
---
440471
ref: vsce-click-connect

0 commit comments

Comments
 (0)