Skip to content

Commit c976361

Browse files
author
Sam Kleinman
committed
DOCS-2501: build fixes
1 parent 60b3201 commit c976361

File tree

5 files changed

+148
-36
lines changed

5 files changed

+148
-36
lines changed

‎source/includes/manpage-options-auth.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. use |binary-name| to refer to the tool
2+
3+
.. option:: --authenticationDatabase <dbname>
4+
5+
.. versionadded:: 2.4
6+
7+
Specifies the database that holds the user's (e.g
8+
:option:`--username <|binary-name| --username>`) credentials.
9+
10+
.. build system replaces this with
11+
/includes/fact-authentication-source-mongo on the mongo shell
12+
man page.
13+
14+
.. include:: /includes/fact-authentication-source-tool.rst
15+
16+
See :doc:`/core/access-control` for more information on
17+
authentication in MongoDB.
18+
19+
.. option:: --authenticationMechanism <name>
20+
21+
.. versionadded:: 2.4
22+
23+
Specifies the authentication mechanism. By default, the
24+
authentication mechanism is ``MONGODB-CR``, which is the MongoDB
25+
challenge/response authentication mechanism. In |ent-build|,
26+
|binary-name| also includes support for ``GSSAPI`` to handle
27+
Kerberos authentication.
28+
29+
See :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`
30+
for more information about Kerberos authentication.

‎source/includes/manpage-options-ssl-tools.rst

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
.. COMMENT because the common settings are not quite commong
2+
-- different versions added,
3+
-- invalid certificate check differ for mongod/mongos vs mongo,
4+
-- description differ for sslPEMKeyFile
5+
using separate rsts for mongod/s, mongo, tools
6+
7+
.. COMMENT this tools include file, unlike mongod/mongos/mongo
8+
uses the replacement holder of |tool-binary| to take
9+
advantage of the replace statement already in place in the
10+
individual program's file.
11+
12+
.. include:: /includes/replace-pem-path-name.rst
13+
14+
.. option:: --ssl
15+
16+
.. versionadded:: 2.5.4
17+
18+
.. include:: /includes/note-general-ssl-support.rst
19+
20+
Enable connection to a :program:`mongod` or
21+
:program:`mongos` that has SSL support enabled.
22+
23+
.. option:: --sslPEMKeyFile <filename>
24+
25+
.. versionadded:: 2.5.4
26+
27+
.. include:: /includes/note-general-ssl-support.rst
28+
29+
Specifies the :file:`.pem` file that contains both the SSL
30+
certificate and key. |pem-path-name|
31+
32+
Required when using the :option:`--ssl` option to connect to
33+
:program:`mongod` or :program:`mongos` that have
34+
:setting:`sslCAFile` enabled *without*
35+
:setting:`sslWeakCertificateValidation`.
36+
37+
.. option:: --sslPEMKeyPassword <value>
38+
39+
.. versionadded:: 2.5.4
40+
41+
.. include:: /includes/note-general-ssl-support.rst
42+
43+
Specifies the password to de-crypt the certificate-key file
44+
(i.e. :option:`--sslPEMKeyFile`). Only use
45+
:option:`--sslPEMKeyPassword` if the certificate-key file is
46+
encrypted. In all cases, |tool-binary| will redact the password from
47+
all logging and reporting output.
48+
49+
If the private key in the PEM file is encrypted and you do not
50+
specify :option:`--sslPEMKeyPassword`, |tool-binary| will prompt for
51+
a passphrase. See :ref:`ssl-certificate-password`.
52+
53+
.. option:: --sslCAFile <filename>
54+
55+
.. versionadded:: 2.5.4
56+
57+
.. include:: /includes/note-general-ssl-support.rst
58+
59+
Specifies the :file:`.pem` file that contains the root certificate
60+
chain from the Certificate Authority. |pem-path-name|
61+
62+
.. option:: --sslCRLFile <filename>
63+
64+
.. versionadded:: 2.5.4
65+
66+
.. include:: /includes/note-general-ssl-support.rst
67+
68+
Specifies the :file:`.pem` file that contains the Certificate
69+
Revocation List. |pem-path-name|
70+
71+
.. option:: --sslFIPSMode
72+
73+
.. versionadded:: 2.5.4
74+
75+
.. include:: /includes/note-general-ssl-support.rst
76+
77+
When specified, |binary-name| will use the FIPS mode of the
78+
installed OpenSSL library. Your system must have a FIPS compliant
79+
OpenSSL library to use :option:`--sslFIPSMode`.
80+
81+
.. option:: --sslAllowInvalidCertificates
82+
83+
.. versionadded:: 2.5.4
84+
85+
.. include:: /includes/note-general-ssl-support.rst
86+
87+
Bypasses the validation checks for server certificates and allows
88+
the use of invalid certificates. When using the
89+
:setting:`sslAllowInvalidCertificates` setting, MongoDB logs as a
90+
warning the use of the invalid certificate.

‎source/includes/options-mongoexport.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ args: null
5959
description: |
6060
When used in conjunction with the corresponding option in
6161
:program:`mongod`, allows :program:`mongoexport` to export data from
62-
MongoDB instances that have every database’s files saved in discrete
62+
MongoDB instances that have every database's files saved in discrete
6363
directories on the disk. This option is only relevant when specifying
6464
the :option:`--dbpath` option.
6565
optional: true

‎source/reference/program/mongodump.txt

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -63,59 +63,59 @@ Options
6363

6464
.. program:: mongodump
6565

66-
.. include:: /includes/option-mongodump-authenticationDatabase.rst
66+
.. include:: /includes/option/option-mongodump-authenticationDatabase.rst
6767

68-
.. include:: /includes/option-mongodump-authenticationMechanism.rst
68+
.. include:: /includes/option/option-mongodump-authenticationMechanism.rst
6969

70-
.. include:: /includes/option-mongodump-collection.rst
70+
.. include:: /includes/option/option-mongodump-collection.rst
7171

72-
.. include:: /includes/option-mongodump-db.rst
72+
.. include:: /includes/option/option-mongodump-db.rst
7373

74-
.. include:: /includes/option-mongodump-dbpath.rst
74+
.. include:: /includes/option/option-mongodump-dbpath.rst
7575

76-
.. include:: /includes/option-mongodump-directoryperdb.rst
76+
.. include:: /includes/option/option-mongodump-directoryperdb.rst
7777

78-
.. include:: /includes/option-mongodump-forceTableScan.rst
78+
.. include:: /includes/option/option-mongodump-forceTableScan.rst
7979

80-
.. include:: /includes/option-mongodump-help.rst
80+
.. include:: /includes/option/option-mongodump-help.rst
8181

82-
.. include:: /includes/option-mongodump-host.rst
82+
.. include:: /includes/option/option-mongodump-host.rst
8383

84-
.. include:: /includes/option-mongodump-ipv6.rst
84+
.. include:: /includes/option/option-mongodump-ipv6.rst
8585

86-
.. include:: /includes/option-mongodump-journal.rst
86+
.. include:: /includes/option/option-mongodump-journal.rst
8787

88-
.. include:: /includes/option-mongodump-oplog.rst
88+
.. include:: /includes/option/option-mongodump-oplog.rst
8989

90-
.. include:: /includes/option-mongodump-out.rst
90+
.. include:: /includes/option/option-mongodump-out.rst
9191

92-
.. include:: /includes/option-mongodump-password.rst
92+
.. include:: /includes/option/option-mongodump-password.rst
9393

94-
.. include:: /includes/option-mongodump-port.rst
94+
.. include:: /includes/option/option-mongodump-port.rst
9595

96-
.. include:: /includes/option-mongodump-query.rst
96+
.. include:: /includes/option/option-mongodump-query.rst
9797

98-
.. include:: /includes/option-mongodump-repair.rst
98+
.. include:: /includes/option/option-mongodump-repair.rst
9999

100-
.. include:: /includes/option-mongodump-ssl.rst
100+
.. include:: /includes/option/option-mongodump-ssl.rst
101101

102-
.. include:: /includes/option-mongodump-sslAllowInvalidCertificates.rst
102+
.. include:: /includes/option/option-mongodump-sslAllowInvalidCertificates.rst
103103

104-
.. include:: /includes/option-mongodump-sslCAFile.rst
104+
.. include:: /includes/option/option-mongodump-sslCAFile.rst
105105

106-
.. include:: /includes/option-mongodump-sslCRLFile.rst
106+
.. include:: /includes/option/option-mongodump-sslCRLFile.rst
107107

108-
.. include:: /includes/option-mongodump-sslFIPSMode.rst
108+
.. include:: /includes/option/option-mongodump-sslFIPSMode.rst
109109

110-
.. include:: /includes/option-mongodump-sslPEMKeyFile.rst
110+
.. include:: /includes/option/option-mongodump-sslPEMKeyFile.rst
111111

112-
.. include:: /includes/option-mongodump-sslPEMKeyPassword.rst
112+
.. include:: /includes/option/option-mongodump-sslPEMKeyPassword.rst
113113

114-
.. include:: /includes/option-mongodump-username.rst
114+
.. include:: /includes/option/option-mongodump-username.rst
115115

116-
.. include:: /includes/option-mongodump-verbose.rst
116+
.. include:: /includes/option/option-mongodump-verbose.rst
117117

118-
.. include:: /includes/option-mongodump-version.rst
118+
.. include:: /includes/option/option-mongodump-version.rst
119119

120120
Use
121121
---

‎source/reference/program/mongoimport.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ Options
5353

5454
.. include:: /includes/option/option-mongoimport-file.rst
5555

56-
.. include:: /includes/option/option-mongoimport-forceTableScan.rst
57-
5856
.. include:: /includes/option/option-mongoimport-headerline.rst
5957

6058
.. include:: /includes/option/option-mongoimport-help.rst
@@ -69,16 +67,10 @@ Options
6967

7068
.. include:: /includes/option/option-mongoimport-jsonArray.rst
7169

72-
.. include:: /includes/option/option-mongoimport-out.rst
73-
7470
.. include:: /includes/option/option-mongoimport-password.rst
7571

7672
.. include:: /includes/option/option-mongoimport-port.rst
7773

78-
.. include:: /includes/option/option-mongoimport-query.rst
79-
80-
.. include:: /includes/option/option-mongoimport-slaveOk.rst
81-
8274
.. include:: /includes/option/option-mongoimport-ssl.rst
8375

8476
.. include:: /includes/option/option-mongoimport-sslAllowInvalidCertificates.rst

0 commit comments

Comments
 (0)