Skip to content

Commit fae4a49

Browse files
corryrootcorryroot
authored
(DOCSP-13242): Added missing settings (#333)
* (DOCSP-13242): Added missing settings * (DOCSP-13242): Added missing markup * (DOCSP-13242): Incorporated JW's feedback * (DOCSP-13242): Incorporated JW's feedback * (DOCSP-13242): Incorporated JW's final set of comments * (DOCSP-13242): Deleted trailing space
1 parent 705502e commit fae4a49

File tree

1 file changed

+131
-32
lines changed

1 file changed

+131
-32
lines changed

‎source/reference/mms-cluster-settings-file.txt‎

Lines changed: 131 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ The configuration file for creating or updating a |cloud| or
5656

5757
* - ``version``
5858
- string
59-
- Version of the :manual:`mongod
60-
</reference/program/mongod/#bin.mongod>` process to deploy.
59+
- Version of the |mongod| process to deploy.
6160

6261
* - ``featureCompatibilityVersion``
6362
- string
@@ -68,9 +67,7 @@ The configuration file for creating or updating a |cloud| or
6867
* - ``processes``
6968
- array of objects
7069
- Required for replica sets. An array of objects containing
71-
settings for each
72-
:manual:`mongod </reference/program/mongod/#bin.mongod>`
73-
process. Each ``mongod`` has
70+
settings for each |mongod| process. Each ``mongod`` has
7471
:ref:`replica set member settings <replica-set-member-settings>`.
7572

7673
* - ``shards``
@@ -87,8 +84,7 @@ The configuration file for creating or updating a |cloud| or
8784
* - ``mongos``
8885
- array of objects
8986
- Required for sharded clusters. An array of objects containing
90-
settings for each :manual:`mongos </reference/program/mongos>`
91-
instance.
87+
settings for each |mongos| instance.
9288

9389
.. _replica-set-member-settings:
9490

@@ -108,53 +104,158 @@ replica set member:
108104
- Description
109105
- Required?
110106

107+
* - ``auditLogDestination``
108+
- string
109+
- Setting that enables :manual:`auditing </core/auditing>` and
110+
specifies where to send all audit events. {+mcli+} accepts the
111+
following values:
112+
113+
- ``syslog``
114+
115+
Output the audit events to ``syslog`` in JSON format.
116+
117+
- ``console``
118+
119+
Output the audit events to ``stdout`` in JSON format.
120+
121+
- ``file``
122+
123+
Output the audit events to the file specified in
124+
the ``auditLogPath`` setting in the format specified in
125+
the ``auditLogFormat`` setting.
126+
127+
This setting corresponds to the :manual:`auditLog.destination</reference/configuration-options/#auditLog.destination>`
128+
configuration file option.
129+
- no
130+
131+
* - ``auditLogFormat``
132+
- string
133+
- Format of the output file for
134+
:manual:`auditing </core/auditing>` if ``auditLogDestination`` is
135+
set to ``file``.
136+
137+
{+mcli+} accepts the following values:
138+
139+
- ``JSON``
140+
141+
Output the audit events in JSON format to the file specified
142+
in the ``auditLogPath`` setting.
143+
144+
- ``BSON``
145+
146+
Output the audit events in BSON binary format to the file
147+
specified in the ``auditLogPath`` setting.
148+
149+
This setting corresponds to the :manual:`auditLog.format
150+
</reference/configuration-options/#auditLog.format>`
151+
configuration file option.
152+
- no
153+
154+
* - ``auditLogPath``
155+
- string
156+
- Output file for :manual:`auditing </core/auditing>` if
157+
``auditLogDestination`` has a value of ``file``. The
158+
``auditLogPath`` option can take either an absolute or a
159+
relative path name.
160+
161+
This setting corresponds to the :manual:`auditLog.path
162+
</reference/configuration-options/#auditLog.path>`
163+
configuration file option.
164+
- no
165+
166+
* - ``bindIp``
167+
- string
168+
- Hostnames and/or IP addresses and/or full Unix domain socket
169+
paths on which |mongos| or |mongod| should listen for client
170+
connections. You may attach |mongos| or |mongod| to any
171+
interface. To bind to multiple addresses, enter a list of
172+
comma-separated values.
173+
174+
This setting corresponds to the :manual:`net.bindIp
175+
</reference/configuration-options/#net.bindIp>`
176+
configuration file option.
177+
- no
178+
179+
* - ``bindIpAll``
180+
- boolean
181+
- Flag that indicates whether the |mongos| or |mongod| instance
182+
binds to all IPv4 addresses (for example, ``0.0.0.0``). If
183+
``ipv6`` is set to ``true``, ``bindIpAll` also binds to IPv6
184+
addresses (for exmaple, ``::``). {+mcli+} accepts ] the
185+
following values: ``true`` or ``false``.
186+
187+
This setting corresponds to the :manual:`net.bindIpAll
188+
</reference/configuration-options/#net.bindIpAll>`
189+
configuration file option.
190+
- no
191+
111192
* - ``buildIndexes``
112193
- boolean
113-
- Flag that indicates whether to direct the :manual:`mongod
114-
</reference/program/mongod/#bin.mongod>` to build indexes.
115-
Value can be ``true`` or ``false``.
194+
- Flag that indicates whether to direct the |mongod| to build
195+
indexes. {+mcli+} accepts the following values: ``true`` or
196+
``false``.
116197

117198
This setting corresponds to the :manual:`buildIndexes
118-
</reference/replica-configuration/#rsconf.members[n].buildIndexes>`
119-
:manual:`mongod </reference/program/mongod/#bin.mongod>` replica set
120-
configuration option.
199+
</reference/replica-configuration/#rsconf.members[n].buildIndexes>`
200+
replica set configuration option.
121201
- no
122202

123203
* - ``dbPath``
124204
- string
125-
- Directory where the :manual:`mongod
126-
</reference/program/mongod/#bin.mongod>` instance stores its
205+
- Directory where the |mongod| instance stores its
127206
data. This cannot be modified after deployment.
128207
- yes
129208

130209
* - ``delay``
131210
- int
132211
- Number of seconds behind the primary member that
133-
this member should lag. This setting corresponds to the
212+
this member should lag.
213+
214+
This setting corresponds to the
134215
:manual:`slaveDelay
135-
</reference/replica-configuration/#rsconf.members[n].slaveDelay>`
136-
:manual:`mongod </reference/program/mongod/#bin.mongod>` replica set
137-
configuration option.
216+
</reference/replica-configuration/#rsconf.members[n].slaveDelay>`
217+
replica set configuration option.
138218
- no
139219

140220
* - ``hostname``
141221
- string
142222
- Name of the host to add to the replica set. This is the
143-
host on which |mms| deploys the :manual:`mongod
144-
</reference/program/mongod/#bin.mongod>` process.
223+
host on which |mms| deploys the |mongod| process.
145224
- yes
146225

226+
* - ``ipv6``
227+
- boolean
228+
- Flag that indicates whether the deployment supports |ipv6|.
229+
{+mcli+} accepts the following values: ``true`` or ``false``.
230+
231+
This setting corresponds to the :manual:`net.ipv6
232+
</reference/configuration-options/#net.ipv6>`
233+
configuration file option.
234+
- no
235+
236+
* - ``logDestination``
237+
- string
238+
- Destination to which MongoDB sends all log output. {+mcli+}
239+
accepts the following values: ``file`` or ``syslog``. If you
240+
specify ``file``, you must also specify ``logPath``.
241+
242+
If you do not specify ``logDestination``, MongoDB
243+
sends all log output to standard output.
244+
245+
This setting corresponds to the :manual:`systemLog.destination
246+
</reference/configuration-options/#systemLog.destination>`
247+
configuration file option.
248+
- no
249+
147250
* - ``logPath``
148251
- string
149-
- Location and name of the log file for the :manual:`mongod
150-
</reference/program/mongod/#bin.mongod>` process
151-
on the host.
252+
- Location and name of the log file for the |mongod| process on
253+
the host.
152254
- yes
153255

154256
* - ``port``
155257
- integer
156-
- Port for the replica set member. The :manual:`mongod
157-
</reference/program/mongod/#bin.mongod>` process
258+
- Port for the replica set member. The |mongod| process
158259
must have exclusive access to the specified port.
159260
- yes
160261

@@ -392,7 +493,7 @@ replica set member:
392493
* - ``votes``
393494
- integer
394495
- Number that indicates whether the replica set member
395-
votes in the election. Value can be:
496+
votes in the election. {+mcli+} accepts the following values:
396497

397498
- ``0`` if the replica set member cannot vote
398499
- ``1`` if the replica set member can vote
@@ -426,11 +527,9 @@ shard:
426527

427528
* - ``processes``
428529
- array of objects
429-
- An array of objects containing settings
430-
for each
431-
:manual:`mongod </reference/program/mongod/#bin.mongod>`
432-
process. Each ``mongod`` has
433-
:ref:`replica set member settings <replica-set-member-settings>`.
530+
- An array of objects containing settings for each |mongod|
531+
process. Each ``mongod`` has :ref:`replica set member settings
532+
<replica-set-member-settings>`.
434533
- yes
435534

436535
.. _mms-sample-config-file:

0 commit comments

Comments
 (0)