Skip to content

Commit

Permalink
SERVER-42846 Update manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
Kelsey T Schubert authored and evergreen committed Oct 29, 2019
1 parent d6098da commit 46d533c
Show file tree
Hide file tree
Showing 14 changed files with 4,636 additions and 808 deletions.
6 changes: 5 additions & 1 deletion debian/bsondump.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "BSONDUMP" "1" "Jul 25, 2019" "4.2" "mongodb-manual"
.TH "BSONDUMP" "1" "Aug 16, 2019" "4.2" "mongodb-manual"
.SH NAME
bsondump \- MongoDB BSON Utility
.
Expand Down Expand Up @@ -62,6 +62,10 @@ Run \fI\%bsondump\fP from the system command line, not the \fBmongo\fP shell.
BSON files, not a tool for data ingestion or other application use.
.UNINDENT
.UNINDENT
.sp
Starting in version 4.2, \fI\%bsondump\fP uses Extended
JSON v2.0 (Canonical mode)
to format its data.
.SH OPTIONS
.sp
Changed in version 3.0.0: \fI\%bsondump\fP removed the \fB\-\-filter\fP, \fB\-\-dbpath\fP and the
Expand Down
38 changes: 37 additions & 1 deletion debian/mongo.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "MONGO" "1" "Jul 25, 2019" "4.2" "mongodb-manual"
.TH "MONGO" "1" "Aug 16, 2019" "4.2" "mongodb-manual"
.SH NAME
mongo \- MongoDB Shell
.
Expand Down Expand Up @@ -59,11 +59,20 @@ The \fI\%mongo\fP shell is part of the \fI\%MongoDB distributions\fP\&.
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Starting in MongoDB 4.2, the \fI\%mongo\fP shell displays a
warning message when connected to non\-genuine MongoDB instances as
these instances may behave differently from the official MongoDB
instances; e.g. missing or incomplete features, different feature
behaviors, etc.
.IP \(bu 2
Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0
encryption on systems where TLS 1.1+ is available. For
more details, see 4.0\-disable\-tls\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SYNTAX
.INDENT 0.0
.IP \(bu 2
Expand Down Expand Up @@ -587,6 +596,15 @@ default name of \fBmongodb\fP\&.
This option is available only in MongoDB Enterprise.
.UNINDENT
.SS TLS Options
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0
encryption on systems where TLS 1.1+ is available. For
more details, see 4.0\-disable\-tls\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.SS See
Expand Down Expand Up @@ -883,6 +901,15 @@ counterparts instead. The SSL protocol is deprecated and MongoDB
supports TLS 1.0 and later.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0
encryption on systems where TLS 1.1+ is available. For
more details, see 4.0\-disable\-tls\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ssl
Expand Down Expand Up @@ -1650,6 +1677,13 @@ mongo script\-file.js \-u <user> \-p
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fBisInteractive()\fP
.UNINDENT
.UNINDENT
.SS Use \fI\%\-\-eval\fP to Print Query Results as JSON
.sp
To print return a query as JSON, from the system prompt using
Expand Down Expand Up @@ -1678,6 +1712,8 @@ the additional JavaScript required to generate this output.
/reference/method
.IP \(bu 2
/mongo
.IP \(bu 2
\fBisInteractive()\fP
.UNINDENT
.UNINDENT
.UNINDENT
Expand Down
192 changes: 126 additions & 66 deletions debian/mongod.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "MONGOD" "1" "Jul 25, 2019" "4.2" "mongodb-manual"
.TH "MONGOD" "1" "Aug 16, 2019" "4.2" "mongodb-manual"
.SH NAME
mongod \- MongoDB Server
.
Expand Down Expand Up @@ -387,6 +387,45 @@ is, you can specify one or the other, but not both.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-clusterIpSourceWhitelist <string>
New in version 3.6.

.sp
A list of IP addresses/CIDR (\fI\%Classless Inter\-Domain Routing\fP) ranges against which the
\fI\%mongod\fP validates authentication requests from other members of
the replica set and, if part of a sharded cluster, the \fBmongos\fP
instances. The \fI\%mongod\fP verifies that the originating IP is
either explicitly in the list or belongs to a CIDR range in the list. If the
IP address is not present, the server does not authenticate the
\fI\%mongod\fP or \fBmongos\fP\&.
.sp
\fI\%\-\-clusterIpSourceWhitelist\fP has no effect on a \fI\%mongod\fP started without
authentication\&.
.sp
\fI\%\-\-clusterIpSourceWhitelist\fP accepts multiple comma\-separated IPv4/6 addresses or Classless
Inter\-Domain Routing (\fI\%CIDR\fP) ranges:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-clusterIpSourceWhitelist 192.0.2.0/24,127.0.0.1,::1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Ensure \fI\%\-\-clusterIpSourceWhitelist\fP includes the IP address \fIor\fP CIDR ranges that include the
IP address of each replica set member or \fBmongos\fP in the
deployment to ensure healthy communication between cluster components.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ipv6
Enables IPv6 support. \fBmongod\fP disables IPv6 support by default.
.sp
Expand Down Expand Up @@ -978,12 +1017,26 @@ _
New in version 4.2.

.sp
Outputs the resolved YAML configuration document for the \fBmongod\fP
to \fBstdout\fP and halts the \fBmongod\fP instance. For configuration
options using externally\-sourced\-values, \fI\%\-\-outputConfig\fP returns the
resolved value for those options. This may include any configured
passwords or secrets previously obfuscated through the external
source.
Outputs the \fBmongod\fP instance\(aqs configuration options, formatted
in YAML, to \fBstdout\fP and exits the \fBmongod\fP instance. For
configuration options that uses externally\-sourced\-values,
\fI\%\-\-outputConfig\fP returns the resolved value for those options.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This may include any configured passwords or secrets previously
obfuscated through the external source.
.UNINDENT
.UNINDENT
.sp
For usage examples, see:
.INDENT 7.0
.IP \(bu 2
expansion\-directive\-output
.IP \(bu 2
/tutorial/convert\-command\-line\-options\-to\-yaml
.UNINDENT
.UNINDENT
.SS Free Monitoring
.sp
Expand Down Expand Up @@ -1504,8 +1557,35 @@ A relative LDAP query URL formatted conforming to \fI\%RFC4515\fP and \fI\%RFC45
the LDAP groups to which the authenticated user belongs to. The query is
relative to the host or hosts specified in \fI\%\-\-ldapServers\fP\&.
.sp
Use the \fB{USER}\fP placeholder in the URL to substitute the authenticated
username, or the transformed username if a \fI\%username mapping\fP is specified.
In the URL, you can use the following substituion tokens:
.TS
center;
|l|l|.
_
T{
Substitution Token
T} T{
Description
T}
_
T{
\fB{USER}\fP
T} T{
Substitutes the authenticated username, or the
\fBtransformed\fP
username if a \fI\%username mapping\fP is specified.
T}
_
T{
\fB{PROVIDED_USER}\fP
T} T{
Substitutes the supplied username, i.e. before either
authentication or \fBLDAP transformation\fP\&.
.sp
New in version 4.2.
T}
_
.TE
.sp
When constructing the query URL, ensure that the order of LDAP parameters
respects RFC4516:
Expand Down Expand Up @@ -1688,47 +1768,6 @@ in\-memory storage engine\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-nssize <value>
\fIDefault\fP: 16
.sp
Specifies the default size for namespace files, which are files that end
in \fB\&.ns\fP\&. Each collection and index counts as a namespace.
.sp
Use this setting to control size for newly created namespace files. This
option has no impact on existing files. The maximum size for a namespace
file is 2047 megabytes. The default value of 16 megabytes provides for
approximately 24,000 namespaces.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quota
Enables a maximum limit for the number data files each database can
have. When running with the \fI\%\-\-quota\fP option, MongoDB has a maximum of 8
data files per database. Adjust the quota with
\fI\%\-\-quotaFiles\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quotaFiles <number>
\fIDefault\fP: 8
.sp
Modifies the limit on the number of data files per database. \fI\%\-\-quotaFiles\fP
option requires that you set \fI\%\-\-quota\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-smallfiles
Sets MongoDB to use a smaller default file size. The \fI\%\-\-smallfiles\fP option
reduces the initial size for data files and limits the maximum size to
512 megabytes. \fI\%\-\-smallfiles\fP also reduces the size of each journal
file from 1 gigabyte to 128 megabytes. Use \fI\%\-\-smallfiles\fP if you have a large
number of databases that each holds a small quantity of data.
.sp
The \fI\%\-\-smallfiles\fP option can lead the \fBmongod\fP instance to create a large
number of files, which can affect performance for larger databases.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-syncdelay <value>
\fIDefault\fP: 60
.sp
Expand Down Expand Up @@ -1864,15 +1903,6 @@ WiredTiger storage engine.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-journalOptions <arguments>
Provides functionality for testing. Not for general use, and will affect data
file integrity in the case of abnormal system shutdown.
.sp
Not available for \fI\%mongod\fP instances that use the
in\-memory storage engine\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-journalCommitInterval <value>
\fIDefault\fP: 100 or 30
.sp
Expand All @@ -1898,10 +1928,8 @@ in\-memory storage engine\&.
Defines the maximum size of the internal cache that WiredTiger will
use for all data. The memory consumed by an index build (see
\fBmaxIndexBuildMemoryUsageMegabytes\fP) is separate from the
WiredTiger cache memory.
.sp
Starting in MongoDB 3.4, \fI\%\-\-wiredTigerCacheSizeGB\fP values can range from 0.25 GB to
10000 GB and can be a float.
WiredTiger cache memory. Starting in MongoDB 3.4, the values can range
from 0.25 GB to 10000 GB and can be a float.
.sp
Starting in MongoDB 3.4, the default WiredTiger internal cache size is
the larger of either:
Expand All @@ -1918,6 +1946,18 @@ Conversely, a system with a total of 1.25 GB of RAM will allocate 256
MB to the WiredTiger cache because that is more than half of the
total RAM minus one gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\fP).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
In some instances, such as when running in a container, the database
can have memory constraints that are lower than the total system
memory. In such instances, this memory limit, rather than the total
system memory, is used as the maximum RAM available.
.sp
To see the memory limit, see \fBhostInfo.system.memLimitMB\fP\&.
.UNINDENT
.UNINDENT
.sp
Avoid increasing the WiredTiger internal cache size above its
default value.
.sp
Expand Down Expand Up @@ -1950,9 +1990,10 @@ instances.
.sp
If you run \fI\%mongod\fP in a container (e.g. \fBlxc\fP,
\fBcgroups\fP, Docker, etc.) that does \fInot\fP have access to all of the
RAM available in a system, you must set \fI\%\-\-wiredTigerCacheSizeGB\fP to a value less
than the amount of RAM available in the container. The exact amount
depends on the other processes running in the container.
RAM available in a system, you must set \fI\%\-\-wiredTigerCacheSizeGB\fP to a value
less than the amount of RAM available in the container. The exact
amount depends on the other processes running in the container. See
\fBmemLimitMB\fP\&.
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -3949,6 +3990,25 @@ need to, but can, also specify the \fI\%\-\-kmipServerCAFile\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-eseDatabaseKeyRollover
New in version 4.2.

.sp
Roll over the encrypted storage engine database keys configured with
\fBAES256\-GCM\fP cipher.
.sp
When \fI\%mongod\fP instance is started with this option, the
instance rotates the keys and exits.
.INDENT 7.0
.INDENT 3.5
.IP "Enterprise Feature"
.sp
Available in MongoDB Enterprise only.
.UNINDENT
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB Documentation Project
.SH COPYRIGHT
Expand Down
Loading

0 comments on commit 46d533c

Please sign in to comment.