Skip to content

Commit 357968c

Browse files
Michael Paikkay-kim
authored andcommitted
DOCS-4903
1 parent 736cfcb commit 357968c

File tree

6 files changed

+54
-76
lines changed

6 files changed

+54
-76
lines changed

source/administration/production-notes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -482,8 +482,8 @@ For all MongoDB deployments:
482482
- Use the Network Time Protocol (NTP) to synchronize time among
483483
your hosts. This is especially important in sharded clusters.
484484

485-
SSL Libraries
486-
`````````````
485+
MongoDB and SSL Libraries
486+
`````````````````````````
487487

488488
On Linux platforms, you may observe one of the following statements in
489489
the MongoDB log:
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
The `default distribution of MongoDB <http://www.mongodb.org/downloads>`_
2-
does **not** contain support for SSL. To use SSL you can either compile
3-
MongoDB with SSL support or use |ent-build|. See
4-
:doc:`/tutorial/configure-ssl` for more information about SSL and MongoDB.
1+
.. versionchanged:: 3.0
2+
3+
Most MongoDB distributions now include support for SSL. See
4+
:doc:`/tutorial/configure-ssl` for more information about SSL and
5+
MongoDB.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. note:: FIPS Compatible SSL is
1+
.. note:: FIPS-compatible SSL is
22
available only in `MongoDB Enterprise
33
<http://www.mongodb.com/products/mongodb-enterprise>`_. See
44
:doc:`/tutorial/configure-fips` for more information.

source/includes/options-mongo.yaml

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,7 @@ description: |
209209
Enables connection to a :program:`mongod` or :program:`mongos` that has
210210
SSL support enabled.
211211
212-
The default distribution of MongoDB does not contain support for SSL.
213-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
212+
.. include:: /includes/fact-ssl-supported.rst
214213
optional: true
215214
---
216215
program: mongo
@@ -229,8 +228,7 @@ description: |
229228
:setting:`~net.ssl.CAFile` enabled *without*
230229
:setting:`~net.ssl.allowConnectionsWithoutCertificates`.
231230
232-
The default distribution of MongoDB does not contain support for SSL.
233-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
231+
.. include:: /includes/fact-ssl-supported.rst
234232
optional: true
235233
---
236234
program: mongo
@@ -250,8 +248,7 @@ description: |
250248
specify the {{role}} option, the {{program}} will prompt for a
251249
passphrase. See :ref:`ssl-certificate-password`.
252250
253-
The default distribution of MongoDB does not contain support for SSL.
254-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
251+
.. include:: /includes/fact-ssl-supported.rst
255252
optional: true
256253
---
257254
program: mongo
@@ -265,8 +262,7 @@ description: |
265262
from the Certificate Authority. Specify the file name of the
266263
:file:`.pem` file using relative or absolute paths.
267264
268-
The default distribution of MongoDB does not contain support for SSL.
269-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
265+
.. include:: /includes/fact-ssl-supported.rst
270266
271267
.. include:: /includes/warning-always-use-sslCAFile-for-mongo.rst
272268
optional: true
@@ -282,8 +278,7 @@ description: |
282278
List. Specify the file name of the :file:`.pem` file using relative or
283279
absolute paths.
284280
285-
The default distribution of MongoDB does not contain support for SSL.
286-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
281+
.. include:: /includes/fact-ssl-supported.rst
287282
optional: true
288283
---
289284
program: mongo
@@ -306,8 +301,7 @@ description: |
306301
:setting:`~net.ssl.allowInvalidCertificates` setting, MongoDB logs as a
307302
warning the use of the invalid certificate.
308303
309-
The default distribution of MongoDB does not contain support for SSL.
310-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
304+
.. include:: /includes/fact-ssl-supported.rst
311305
optional: true
312306
---
313307
program: mongo
@@ -331,6 +325,5 @@ inherit:
331325
program: _shared
332326
file: options-shared.yaml
333327
post: |
334-
The default distribution of MongoDB does not contain support for SSL.
335-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
328+
.. include:: /includes/fact-ssl-supported.rst
336329
...

source/includes/options-mongod.yaml

Lines changed: 31 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -604,8 +604,7 @@ description: |
604604
- Recommended. Send the x.509 certificate for authentication and
605605
accept only x.509 certificates.
606606
607-
The default distribution of MongoDB does not contain support for SSL.
608-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
607+
.. include:: /includes/fact-ssl-supported.rst
609608
optional: true
610609
---
611610
program: mongod
@@ -1135,48 +1134,47 @@ description: |
11351134
:option:`--port`. By default, :option:`--sslOnNormalPorts` is
11361135
disabled.
11371136
1138-
The default distribution of MongoDB does not contain support for SSL.
1139-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1137+
.. include:: /includes/fact-ssl-supported.rst
11401138
optional: true
11411139
---
11421140
program: mongod
11431141
name: sslMode
11441142
args: <mode>
11451143
directive: option
11461144
description: |
1147-
.. versionadded:: 2.6
1145+
.. versionadded:: 2.6
11481146
1149-
Enables SSL or mixed SSL used for all network connections. The
1150-
argument to the {{role}} option can be one of the following:
1147+
Enables SSL or mixed SSL used for all network connections. The
1148+
argument to the {{role}} option can be one of the following:
11511149
1152-
.. list-table::
1153-
:header-rows: 1
1154-
:widths: 20 40
1150+
.. list-table::
1151+
:header-rows: 1
1152+
:widths: 20 40
11551153
1156-
* - Value
1154+
* - Value
1155+
1156+
- Description
11571157
1158-
- Description
1158+
* - ``disabled``
11591159
1160-
* - ``disabled``
1160+
- The server does not use SSL.
11611161
1162-
- The server does not use SSL.
1162+
* - ``allowSSL``
11631163
1164-
* - ``allowSSL``
1164+
- Connections between servers do not use SSL. For incoming
1165+
connections, the server accepts both SSL and non-SSL.
11651166
1166-
- Connections between servers do not use SSL. For incoming
1167-
connections, the server accepts both SSL and non-SSL.
1167+
* - ``preferSSL``
11681168
1169-
* - ``preferSSL``
1169+
- Connections between servers use SSL. For incoming
1170+
connections, the server accepts both SSL and non-SSL.
11701171
1171-
- Connections between servers use SSL. For incoming
1172-
connections, the server accepts both SSL and non-SSL.
1172+
* - ``requireSSL``
11731173
1174-
* - ``requireSSL``
1174+
- The server uses and accepts only SSL encrypted connections.
11751175
1176-
- The server uses and accepts only SSL encrypted connections.
1176+
.. include:: /includes/fact-ssl-supported.rst
11771177
1178-
The default distribution of MongoDB does not contain support for SSL.
1179-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
11801178
optional: true
11811179
---
11821180
program: mongod
@@ -1192,8 +1190,7 @@ description: |
11921190
11931191
When SSL is enabled, you must specify {{role}}.
11941192
1195-
The default distribution of MongoDB does not contain support for SSL.
1196-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1193+
.. include:: /includes/fact-ssl-supported.rst
11971194
optional: true
11981195
---
11991196
program: mongod
@@ -1213,8 +1210,7 @@ description: |
12131210
specify the {{role}} option, the {{program}} will prompt for a
12141211
passphrase. See :ref:`ssl-certificate-password`.
12151212
1216-
The default distribution of MongoDB does not contain support for SSL.
1217-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1213+
.. include:: /includes/fact-ssl-supported.rst
12181214
optional: true
12191215
---
12201216
program: mongod
@@ -1232,9 +1228,7 @@ description: |
12321228
authentication, the cluster uses the ``.pem`` file specified in the
12331229
{{pemKeyOption}} option.
12341230
1235-
The default distribution of MongoDB does not contain support for
1236-
SSL. For more information on MongoDB and SSL, see
1237-
:doc:`/tutorial/configure-ssl`.
1231+
.. include:: /includes/fact-ssl-supported.rst
12381232
optional: true
12391233
replacement:
12401234
pemKeyOption: :option:`--sslPEMKeyFile`
@@ -1255,8 +1249,7 @@ description: |
12551249
{{role}} option, the {{program}} will prompt for a passphrase. See
12561250
:ref:`ssl-certificate-password`.
12571251
1258-
The default distribution of MongoDB does not contain support for SSL.
1259-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1252+
.. include:: /includes/fact-ssl-supported.rst
12601253
optional: true
12611254
---
12621255
program: mongod
@@ -1270,8 +1263,7 @@ description: |
12701263
from the Certificate Authority. Specify the file name of the
12711264
:file:`.pem` file using relative or absolute paths.
12721265
1273-
The default distribution of MongoDB does not contain support for SSL.
1274-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1266+
.. include:: /includes/fact-ssl-supported.rst
12751267
12761268
.. include:: /includes/warning-x509-requires-sslCAfile.rst
12771269
optional: true
@@ -1287,8 +1279,7 @@ description: |
12871279
List. Specify the file name of the :file:`.pem` file using relative or
12881280
absolute paths.
12891281
1290-
The default distribution of MongoDB does not contain support for SSL.
1291-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1282+
.. include:: /includes/fact-ssl-supported.rst
12921283
optional: true
12931284
---
12941285
program: mongod
@@ -1303,8 +1294,7 @@ description: |
13031294
the :setting:`~net.ssl.allowInvalidCertificates` setting, MongoDB
13041295
logs as a warning the use of the invalid certificate.
13051296
1306-
The default distribution of MongoDB does not contain support for SSL.
1307-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1297+
.. include:: /includes/fact-ssl-supported.rst
13081298
optional: true
13091299
---
13101300
program: mongod
@@ -1333,8 +1323,7 @@ description: |
13331323
Use the {{role}} option if you have a mixed deployment that includes
13341324
clients that do not or cannot present certificates to the {{program}}.
13351325
1336-
The default distribution of MongoDB does not contain support for SSL.
1337-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1326+
.. include:: /includes/fact-ssl-supported.rst
13381327
replacement:
13391328
old_name: "``--sslAllowConnectionsWithoutCertificates``"
13401329
optional: true
@@ -1352,8 +1341,7 @@ description: |
13521341
{{program}} instances if the hostnames in their certificates do not
13531342
match their configured hostname.
13541343
1355-
The default distribution of MongoDB does not contain support for SSL.
1356-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
1344+
.. include:: /includes/fact-ssl-supported.rst
13571345
optional: true
13581346
---
13591347
program: mongod

source/includes/options-shared.yaml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ description: |
115115
Enables connection to a :program:`mongod` or :program:`mongos` that has
116116
SSL support enabled.
117117
118-
The default distribution of MongoDB does not contain support for SSL.
119-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
118+
.. include:: /includes/fact-ssl-supported.rst
120119
optional: true
121120
---
122121
program: _shared
@@ -131,8 +130,7 @@ description: |
131130
from the Certificate Authority. Specify the file name of the
132131
:file:`.pem` file using relative or absolute paths.
133132
134-
The default distribution of MongoDB does not contain support for SSL.
135-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
133+
.. include:: /includes/fact-ssl-supported.rst
136134
137135
.. include:: /includes/warning-always-use-sslCAFile-for-mongo.rst
138136
optional: true
@@ -154,8 +152,7 @@ description: |
154152
:setting:`~net.ssl.CAFile` enabled *without*
155153
:setting:`~net.ssl.allowConnectionsWithoutCertificates`.
156154
157-
The default distribution of MongoDB does not contain support for SSL.
158-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
155+
.. include:: /includes/fact-ssl-supported.rst
159156
optional: true
160157
---
161158
program: _shared
@@ -175,8 +172,7 @@ description: |
175172
the {{role}} option, the {{program}} will prompt for a passphrase. See
176173
:ref:`ssl-certificate-password`.
177174
178-
The default distribution of MongoDB does not contain support for SSL.
179-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
175+
.. include:: /includes/fact-ssl-supported.rst
180176
optional: true
181177
---
182178
program: _shared
@@ -191,8 +187,7 @@ description: |
191187
List. Specify the file name of the :file:`.pem` file using relative or
192188
absolute paths.
193189
194-
The default distribution of MongoDB does not contain support for SSL.
195-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
190+
.. include:: /includes/fact-ssl-supported.rst
196191
optional: true
197192
---
198193
program: _shared
@@ -210,8 +205,7 @@ description: |
210205
:setting:`~net.ssl.allowInvalidCertificates` setting, MongoDB logs as a
211206
warning the use of the invalid certificate.
212207
213-
The default distribution of MongoDB does not contain support for SSL.
214-
For more information on MongoDB and SSL, see :doc:`/tutorial/configure-ssl`.
208+
.. include:: /includes/fact-ssl-supported.rst
215209
optional: true
216210
---
217211
program: _shared
@@ -225,6 +219,8 @@ description: |
225219
Disables the validation of the hostnames in SSL certificates. Allows
226220
{{program}} to connect to MongoDB instances if the hostname their
227221
certificates do not match the specified hostname.
222+
223+
.. include:: /includes/fact-ssl-supported.rst
228224
optional: true
229225
---
230226
program: _shared

0 commit comments

Comments
 (0)