Skip to content

Commit f0ea3e8

Browse files
mdb-ashleyAshley Brownjeff-allen-mongo
authored
DOCS-15050 Add array option to queryPassword type (#491) (#611)
* 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 dadb13d commit f0ea3e8

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
@@ -2298,7 +2298,7 @@ Core Options
22982298
method: <string>
22992299
saslMechanisms: <string>
23002300
queryUser: <string>
2301-
queryPassword: <string>
2301+
queryPassword: <string | array>
23022302
useOSDefaults: <boolean>
23032303
transportSecurity: <string>
23042304
timeoutMS: <int>
@@ -2911,7 +2911,7 @@ Key Management Configuration Options
29112911
method: <string>
29122912
saslMechanisms: <string>
29132913
queryUser: <string>
2914-
queryPassword: <string>
2914+
queryPassword: <string | array>
29152915
useOSDefaults: <boolean>
29162916
transportSecurity: <string>
29172917
timeoutMS: <int>
@@ -2976,24 +2976,9 @@ Key Management Configuration Options
29762976

29772977
.. setting:: security.ldap.bind.queryPassword
29782978

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

29982983

29992984
.. setting:: security.ldap.bind.useOSDefaults

‎source/reference/program/mongod.txt‎

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

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

961-
.. versionadded:: 3.4 Available in MongoDB Enterprise only.
961+
*Available in MongoDB Enterprise only.*
962962

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

985985

986-
.. option:: --ldapQueryPassword <string>
986+
.. option:: --ldapQueryPassword <string | array>
987987

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

1011992

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

‎source/reference/program/mongoldap.txt‎

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

240240

241-
.. option:: --ldapQueryPassword=<string>
241+
.. option:: --ldapQueryPassword=<string | array>
242242

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

260247

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

0 commit comments

Comments
 (0)