Skip to content

Commit 2153725

Browse files
mdb-ashleyAshley Brownjeff-allen-mongo
authored
DOCS-15050 Add array option to queryPassword type (#491) (#609)
* Updating queryPassword type to include array * Changing or to pipe * DOCS-15050 Attempting includes * DOCS-15050 Includes fix with comment tags * DOCS-15050 Fixing syntax errors * DOCS-15050 Working on syntax errors * DOCS-15050 Fixed some wording * Update source/reference/configuration-options.txt Co-authored-by: jeff-allen-mongo <[email protected]> * Update source/reference/configuration-options.txt Co-authored-by: jeff-allen-mongo <[email protected]> Co-authored-by: Ashley Brown <[email protected]> Co-authored-by: jeff-allen-mongo <[email protected]> Co-authored-by: Ashley Brown <[email protected]> Co-authored-by: jeff-allen-mongo <[email protected]>
1 parent 1560f1e commit 2153725

File tree

4 files changed

+105
-61
lines changed

4 files changed

+105
-61
lines changed

‎source/includes/query-password.rst

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
2+
.. START-CONFIG-QUERYPASSWORD
3+
4+
*Type*: string or array
5+
6+
*Available in MongoDB Enterprise only.*
7+
8+
The password used to bind to an LDAP server when using
9+
:setting:`~security.ldap.bind.queryUser`. You must use
10+
:setting:`~security.ldap.bind.queryPassword` with
11+
:setting:`~security.ldap.bind.queryUser`.
12+
13+
If not set, :binary:`~bin.mongod` or :binary:`~bin.mongos` does not attempt to
14+
bind to the LDAP server.
15+
16+
You can configure this setting on a running :binary:`~bin.mongod` or
17+
:binary:`~bin.mongos` using :dbcommand:`setParameter`.
18+
19+
Starting in MongoDB 4.4, the ``ldapQueryPassword``
20+
:dbcommand:`setParameter` command accepts either a string or
21+
an array of strings. If ``ldapQueryPassword`` is set to an array, MongoDB tries
22+
each password in order until one succeeds. Use a password array to roll over the
23+
LDAP account password without downtime.
24+
25+
.. note::
26+
27+
Windows MongoDB deployments can use :setting:`~security.ldap.bind.useOSDefaults`
28+
instead of :setting:`~security.ldap.bind.queryUser` and
29+
:setting:`~security.ldap.bind.queryPassword`. You cannot specify both
30+
:setting:`~security.ldap.bind.queryPassword` and
31+
:setting:`~security.ldap.bind.useOSDefaults` at the same time.
32+
33+
.. END-CONFIG-QUERYPASSWORD
34+
35+
36+
.. START-MONGOD-QUERYPASSWORD
37+
38+
*Available in MongoDB Enterprise only.*
39+
40+
The password used to bind to an LDAP server when using
41+
:option:`--ldapQueryUser`. You must use :option:`--ldapQueryPassword` with
42+
:option:`--ldapQueryUser`.
43+
44+
If not set, :program:`mongod` does not attempt to bind to the LDAP server.
45+
46+
You can configure this setting on a running :program:`mongod` using
47+
:dbcommand:`setParameter`.
48+
49+
Starting in MongoDB 4.4, the ``ldapQueryPassword``
50+
:dbcommand:`setParameter` command accepts either a string or
51+
an array of strings. If ``ldapQueryPassword`` is set to an array, MongoDB tries
52+
each password in order until one succeeds. Use a password array to roll over the
53+
LDAP account password without downtime.
54+
55+
.. note::
56+
57+
Windows MongoDB deployments can use :option:`--ldapBindWithOSDefaults`
58+
instead of :option:`--ldapQueryUser` and :option:`--ldapQueryPassword`.
59+
You cannot specify both :option:`--ldapQueryPassword` and
60+
:option:`--ldapBindWithOSDefaults` at the same time.
61+
62+
.. END-MONGOD-QUERYPASSWORD
63+
64+
65+
.. START-MONGOLDAP-QUERYPASSWORD
66+
67+
*Available in MongoDB Enterprise only.*
68+
69+
The password used to bind to an LDAP server when using
70+
:option:`--ldapQueryUser`. You must use :option:`--ldapQueryPassword` with
71+
:option:`--ldapQueryUser`.
72+
73+
If not set, :program:`mongoldap` does not attempt to bind to the LDAP server.
74+
75+
You can configure this setting on a running :program:`mongoldap` using
76+
:dbcommand:`setParameter`.
77+
78+
Starting in MongoDB 4.4, the ``ldapQueryPassword``
79+
:dbcommand:`setParameter` command accepts either a string or
80+
an array of strings. If ``ldapQueryPassword`` is set to an array, MongoDB tries
81+
each password in order until one succeeds. Use a password array to roll over the
82+
LDAP account password without downtime.
83+
84+
.. note::
85+
86+
Windows MongoDB deployments can use :option:`--ldapBindWithOSDefaults`
87+
instead of :option:`--ldapQueryUser` and :option:`--ldapQueryPassword`.
88+
You cannot specify both :option:`--ldapQueryPassword` and
89+
:option:`--ldapBindWithOSDefaults` at the same time.
90+
91+
.. END-MONGOLDAP-QUERYPASSWORD

‎source/reference/configuration-options.txt

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2261,7 +2261,7 @@ Core Options
22612261
method: <string>
22622262
saslMechanisms: <string>
22632263
queryUser: <string>
2264-
queryPassword: <string>
2264+
queryPassword: <string | array>
22652265
useOSDefaults: <boolean>
22662266
transportSecurity: <string>
22672267
timeoutMS: <int>
@@ -2913,7 +2913,7 @@ Key Management Configuration Options
29132913
method: <string>
29142914
saslMechanisms: <string>
29152915
queryUser: <string>
2916-
queryPassword: <string>
2916+
queryPassword: <string | array>
29172917
useOSDefaults: <boolean>
29182918
transportSecurity: <string>
29192919
timeoutMS: <int>
@@ -2978,24 +2978,9 @@ Key Management Configuration Options
29782978

29792979
.. setting:: security.ldap.bind.queryPassword
29802980

2981-
*Type*: string
2982-
2983-
.. versionadded:: 3.4 Available in MongoDB Enterprise only.
2984-
2985-
The password used to bind to an LDAP server when using
2986-
:setting:`~security.ldap.bind.queryUser`. You must use :setting:`~security.ldap.bind.queryPassword` with
2987-
:setting:`~security.ldap.bind.queryUser`.
2988-
2989-
If unset, :binary:`~bin.mongod` or :binary:`~bin.mongos` will not attempt to bind to the LDAP server.
2990-
2991-
This setting can be configured on a running :binary:`~bin.mongod` or :binary:`~bin.mongos` using
2992-
:dbcommand:`setParameter`.
2993-
2994-
.. note::
2995-
2996-
Windows MongoDB deployments can use :setting:`~security.ldap.bind.useOSDefaults`
2997-
instead of :setting:`~security.ldap.bind.queryPassword` and :setting:`~security.ldap.bind.queryPassword`. You cannot specify
2998-
both :setting:`~security.ldap.bind.queryPassword` and :setting:`~security.ldap.bind.useOSDefaults` at the same time.
2981+
.. include:: /includes/query-password.rst
2982+
:start-after: START-CONFIG-QUERYPASSWORD
2983+
:end-before: END-CONFIG-QUERYPASSWORD
29992984

30002985

30012986
.. setting:: security.ldap.bind.useOSDefaults

‎source/reference/program/mongod.txt

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -959,7 +959,7 @@ LDAP Authentication or Authorization Options
959959

960960
.. option:: --ldapQueryUser <string>
961961

962-
.. versionadded:: 3.4 Available in MongoDB Enterprise only.
962+
*Available in MongoDB Enterprise only.*
963963

964964
The identity with which :program:`mongod` binds as, when connecting to or
965965
performing queries on an LDAP server.
@@ -984,30 +984,11 @@ LDAP Authentication or Authorization Options
984984
both :option:`--ldapQueryUser` and :option:`--ldapBindWithOSDefaults` at the same time.
985985

986986

987-
.. option:: --ldapQueryPassword <string>
987+
.. option:: --ldapQueryPassword <string | array>
988988

989-
.. versionadded:: 3.4 Available in MongoDB Enterprise only.
990-
991-
The password used to bind to an LDAP server when using
992-
:option:`--ldapQueryUser`. You must use :option:`--ldapQueryPassword` with
993-
:option:`--ldapQueryUser`.
994-
995-
If unset, :program:`mongod` will not attempt to bind to the LDAP server.
996-
997-
This setting can be configured on a running :program:`mongod` using
998-
:dbcommand:`setParameter`.
999-
1000-
Starting in MongoDB 4.4, the ``ldapQueryPassword``
1001-
:dbcommand:`setParameter` command accepts either a string or
1002-
an array of strings. If set to an array, each password is tried
1003-
until one succeeds. This can be used to perform a rollover of the
1004-
LDAP account password without downtime for MongoDB.
1005-
1006-
.. note::
1007-
1008-
Windows MongoDB deployments can use :option:`--ldapBindWithOSDefaults`
1009-
instead of :option:`--ldapQueryPassword` and :option:`--ldapQueryPassword`. You cannot specify
1010-
both :option:`--ldapQueryPassword` and :option:`--ldapBindWithOSDefaults` at the same time.
989+
.. include:: /includes/query-password.rst
990+
:start-after: START-MONGOD-QUERYPASSWORD
991+
:end-before: END-MONGOD-QUERYPASSWORD
1011992

1012993

1013994
.. option:: --ldapBindWithOSDefaults <bool>

‎source/reference/program/mongoldap.txt

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -241,24 +241,11 @@ Options
241241
both :option:`--ldapQueryUser` and :option:`--ldapBindWithOSDefaults` at the same time.
242242

243243

244-
.. option:: --ldapQueryPassword=<string>
244+
.. option:: --ldapQueryPassword=<string | array>
245245

246-
.. versionadded:: 3.4 Available in MongoDB Enterprise only.
247-
248-
The password used to bind to an LDAP server when using
249-
:option:`--ldapQueryUser`. You must use :option:`--ldapQueryPassword` with
250-
:option:`--ldapQueryUser`.
251-
252-
If unset, :program:`mongoldap` will not attempt to bind to the LDAP server.
253-
254-
This setting can be configured on a running :program:`mongoldap` using
255-
:dbcommand:`setParameter`.
256-
257-
.. note::
258-
259-
Windows MongoDB deployments can use :option:`--ldapBindWithOSDefaults`
260-
instead of :option:`--ldapQueryPassword` and :option:`--ldapQueryPassword`. You cannot specify
261-
both :option:`--ldapQueryPassword` and :option:`--ldapBindWithOSDefaults` at the same time.
246+
.. include:: /includes/query-password.rst
247+
:start-after: START-MONGOLDAP-QUERYPASSWORD
248+
:end-before: END-MONGOLDAP-QUERYPASSWORD
262249

263250

264251
.. option:: --ldapBindWithOSDefaults=<bool>

0 commit comments

Comments
 (0)