Skip to content

Commit ce796a9

Browse files
(DOCSP-28684): Include LDAP SRV details in config docs (#6184)
* (DOCSP-28684): Include LDAP SRV details in config docs * use replacements * change mongod replacement * review feedback * typo * edits
1 parent 8ca7a85 commit ce796a9

File tree

5 files changed

+30
-8
lines changed

5 files changed

+30
-8
lines changed

Diff for: source/core/security-ldap-external.txt

+6
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,12 @@ configuration file:
227227
- Quote-enclosed comma-separated list of LDAP servers in ``host[:port]``
228228
format.
229229

230+
You can prefix LDAP servers with ``srv:`` and ``srv_raw:``.
231+
232+
.. |ldap-binary| replace:: :binary:`mongod`
233+
234+
.. include:: /includes/ldap-srv-details.rst
235+
230236
- **YES**
231237

232238
* - :setting:`security.ldap.authz.queryTemplate`

Diff for: source/core/security-ldap.txt

+6
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,12 @@ configuration file:
216216
- Quote-enclosed comma-separated list of LDAP servers in ``host[:port]``
217217
format.
218218

219+
You can prefix LDAP servers with ``srv:`` and ``srv_raw:``.
220+
221+
.. |ldap-binary| replace:: :binary:`mongod`
222+
223+
.. include:: /includes/ldap-srv-details.rst
224+
219225
- **YES**
220226

221227
* - :setting:`security.ldap.bind.method`

Diff for: source/includes/ldap-srv-details.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
If your connection string specifies ``"srv:<DNS_NAME>"``, |ldap-binary|
2+
verifies that ``"_ldap._tcp.gc._msdcs.<DNS_NAME>"`` exists for SRV to
3+
support Active Directory. If not found, |ldap-binary| verifies that
4+
``"_ldap._tcp.<DNS_NAME>"`` exists for SRV. If an SRV record cannot be
5+
found, |ldap-binary| warns you to use ``"srv_raw:<DNS_NAME>"`` instead.
6+
7+
If your connection string specifies ``"srv_raw:<DNS_NAME>"``,
8+
|ldap-binary| performs an SRV record lookup for ``"<DNS NAME>"``.

Diff for: source/reference/configuration-options.txt

+6
Original file line numberDiff line numberDiff line change
@@ -3134,6 +3134,12 @@ Key Management Configuration Options
31343134
:setting:`security.ldap.servers`. MongoDB supports following LDAP referrals as defined in `RFC 4511
31353135
4.1.10 <https://www.rfc-editor.org/rfc/rfc4511.txt>`_. Do not use :setting:`security.ldap.servers`
31363136
for listing every LDAP server in your infrastructure.
3137+
3138+
You can prefix LDAP servers with ``srv:`` and ``srv_raw:``.
3139+
3140+
.. |ldap-binary| replace:: :binary:`mongod`
3141+
3142+
.. include:: /includes/ldap-srv-details.rst
31373143

31383144
This setting can be configured on a running :binary:`~bin.mongod` or :binary:`~bin.mongos` using
31393145
:dbcommand:`setParameter`.

Diff for: source/reference/program/mongoldap.txt

+4-8
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,12 @@ configuration files are valid, the output might be as follows:
157157
Behavior
158158
--------
159159

160-
Starting in MonogoDB 5.1, ``mongoldap`` supports prefixing LDAP
160+
Starting in MongoDB 5.1, ``mongoldap`` supports prefixing LDAP
161161
server with ``srv:`` and ``srv_raw:``.
162162

163-
If your connection string specifies ``"srv:<DNS_NAME>"``, ``mongoldap``
164-
verifies that ``"_ldap._tcp.gc._msdcs.<DNS_NAME>"`` exists for SRV to
165-
support Active Directory. If not found, it verifies
166-
``"_ldap._tcp.<DNS_NAME>"`` exists for SRV. If an SRV record cannot be
167-
found, ``mongoldap`` warns you to use ``"srv_raw:<DNS_NAME>"`` instead.
168-
``mongoldap`` does the reverse check for ``"srv_raw:<DNS_NAME>"`` by
169-
checking for ``"_ldap._tcp.<DNS NAME>"``.
163+
.. |ldap-binary| replace:: ``mongoldap``
164+
165+
.. include:: /includes/ldap-srv-details.rst
170166

171167
Options
172168
-------

0 commit comments

Comments
 (0)