Skip to content

Commit 0fe4fd1

Browse files
jason-price-mongodbjason-price-mongodb
jason-price-mongodb
and
jason-price-mongodb
authored
DOCS-15299 fips mode legacy shell (#1215)
* DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-fips-mode-legacy-shell * DOCS-15299-fips-mode-legacy-shell * DOCS-15299-fips-mode-legacy-shell * DOCS-15299-fips-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell * DOCS-15299-FIPS-mode-legacy-shell Co-authored-by: jason-price-mongodb <[email protected]>
1 parent c9db2f5 commit 0fe4fd1

15 files changed

+182
-6
lines changed

‎source/includes/install-mongodb-apt-get-commands.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
You can also install the MongoDB Shell that uses the system's OpenSSL.
2+
You must have already installed OpenSSL on your system before
3+
installing this version of the MongoDB Shell.
4+
5+
You can install all of the MongoDB Enterprise packages and the
6+
MongoDB Shell that uses the system's OpenSSL without removing the
7+
MongoDB Shell first. For example:
8+
9+
.. code-block:: sh
10+
11+
sudo apt-get install -y mongodb-enterprise mongodb-mongosh-shared-openssl11
12+
13+
The following example removes the MongoDB Shell and then installs the
14+
MongoDB Shell that uses the system's OpenSSL 1.1:
15+
16+
.. code-block:: sh
17+
18+
sudo apt-get remove -y mongodb-mongosh && sudo apt-get install -y
19+
mongodb-mongosh-shared-openssl11
20+
21+
The following example removes the MongoDB Shell and then installs the
22+
MongoDB Shell that uses the system's OpenSSL 3:
23+
24+
.. code-block:: sh
25+
26+
sudo apt-get remove -y mongodb-mongosh && sudo apt-get install -y
27+
mongodb-mongosh-shared-openssl3
28+
29+
You can also choose the MongoDB packages to install.
30+
31+
The following example installs MongoDB Enterprise and tools, and the
32+
MongoDB Shell that uses the system's OpenSSL 1.1:
33+
34+
.. code-block:: sh
35+
36+
sudo apt-get install -y mongodb-enterprise-database
37+
mongodb-enterprise-tools mongodb-mongosh-shared-openssl11
38+
39+
The following example installs MongoDB Enterprise and tools, and the
40+
MongoDB Shell that uses the system's OpenSSL 3:
41+
42+
.. code-block:: sh
43+
44+
sudo apt-get install -y mongodb-enterprise-database
45+
mongodb-enterprise-tools mongodb-mongosh-shared-openssl3

‎source/includes/install-mongodb-shell-tarball.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Download the package for the version of ``mongosh`` you need from the
2+
|mdb-download-link| and uncompress the package.

‎source/includes/install-mongodb-yum-commands.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
You can also install the MongoDB Shell that uses the system's OpenSSL.
2+
You must have already installed OpenSSL on your system before
3+
installing this version of the MongoDB Shell.
4+
5+
You can install all of the MongoDB Enterprise packages and the
6+
MongoDB Shell that uses the system's OpenSSL without removing the
7+
MongoDB Shell first. For example:
8+
9+
.. code-block:: sh
10+
11+
sudo yum install -y mongodb-enterprise mongodb-mongosh-shared-openssl11
12+
13+
The following example removes the MongoDB Shell and then installs the
14+
MongoDB Shell that uses the system's OpenSSL 1.1:
15+
16+
.. code-block:: sh
17+
18+
sudo yum remove -y mongodb-mongosh && sudo yum install -y
19+
mongodb-mongosh-shared-openssl11
20+
21+
The following example removes the MongoDB Shell and then installs the
22+
MongoDB Shell that uses the system's OpenSSL 3:
23+
24+
.. code-block:: sh
25+
26+
sudo yum remove -y mongodb-mongosh && sudo yum install -y
27+
mongodb-mongosh-shared-openssl3
28+
29+
You can also choose the MongoDB packages to install.
30+
31+
The following example installs MongoDB Enterprise and tools, and the
32+
MongoDB Shell that uses the system's OpenSSL 1.1:
33+
34+
.. code-block:: sh
35+
36+
sudo yum install -y mongodb-enterprise-database
37+
mongodb-enterprise-tools mongodb-mongosh-shared-openssl11
38+
39+
The following example installs MongoDB Enterprise and tools, and the
40+
MongoDB Shell that uses the system's OpenSSL 3:
41+
42+
.. code-block:: sh
43+
44+
sudo yum install -y mongodb-enterprise-database
45+
mongodb-enterprise-tools mongodb-mongosh-shared-openssl3

‎source/includes/list-mongodb-enterprise-packages.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ repository, and contains the following officially-supported packages:
3636

3737
* - ``{+package-name+}-mongosh``
3838
- Contains the MongoDB Shell (:binary:`~bin.mongosh`).
39-
39+
40+
* - ``{+package-name+}-shared-openssl*``
41+
- Contains the MongoDB Shell that uses the OpenSSL version already
42+
installed on your computer (:binary:`~bin.mongosh`).
43+
4044
* - ``{+package-name-enterprise+}-tools``
4145
- A ``metapackage`` that automatically installs the component
4246
packages listed below:

‎source/includes/steps-install-mongodb-enterprise-on-linux.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ content: |
2929
:mongosh:`Install </install>` ``mongosh`` then use the MongoDB Shell
3030
to connect to your deployment.
3131
32+
.. include:: /includes/install-mongodb-shell-tarball.rst
3233
...

‎source/includes/steps-install-mongodb-on-amazon-tarball.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,5 @@ content: |
6565
:mongosh:`Install </install>` ``mongosh`` then use the MongoDB Shell
6666
to connect to your deployment.
6767
68+
.. include:: /includes/install-mongodb-shell-tarball.rst
6869
...

‎source/includes/steps-install-mongodb-on-linux.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,5 @@ content: |
6767
:mongosh:`Install </install>` ``mongosh`` then use the MongoDB Shell
6868
to connect to your deployment.
6969
70+
.. include:: /includes/install-mongodb-shell-tarball.rst
7071
...

‎source/includes/steps-install-mongodb-on-ubuntu-tarball.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,6 @@ content: |
6464
:mongosh:`Install </install>` ``mongosh`` then use the MongoDB Shell
6565
to connect to your deployment.
6666
67+
.. include:: /includes/install-mongodb-shell-tarball.rst
6768
...
6869

‎source/reference/command/serverStatus.txt

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1445,8 +1445,9 @@ network
14451445
"clientsRunning" : <num>,
14461446
"clientsWaitingForData" : <num>
14471447
}
1448-
}
1449-
},
1448+
},
1449+
"listenerProcessingTime" : { durationMicros: <num> } // Added in MongoDB 6.1
1450+
}
14501451

14511452
.. serverstatus:: network
14521453

@@ -1626,6 +1627,22 @@ network
16261627
Number of clients using the ``fixed`` service executor that are
16271628
waiting for incoming data from the network.
16281629

1630+
.. serverstatus:: network.listenerProcessingTime
1631+
1632+
.. versionadded:: 6.1
1633+
1634+
A document that reports the total time the database listener spends
1635+
allocating incoming database connection requests to dedicated
1636+
threads.
1637+
1638+
.. serverstatus:: network.listenerProcessingTime.durationMicros
1639+
1640+
.. versionadded:: 6.1
1641+
1642+
Total time in microseconds the database listener spends allocating
1643+
incoming database connection requests to dedicated threads that
1644+
perform database operations.
1645+
16291646
opLatencies
16301647
~~~~~~~~~~~
16311648

‎source/tutorial/configure-fips.txt

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,51 @@ Select the tab below for your platform:
242242
Additional Considerations
243243
--------------------------
244244

245-
.. include:: /includes/fact-5.1-scram-sha-1-fips-default.rst
245+
SCRAM SHA and FIPS Mode
246+
~~~~~~~~~~~~~~~~~~~~~~~
246247

247-
.. include:: /includes/extracts/4.2-changes-fips.rst
248+
.. include:: /includes/fact-5.1-scram-sha-1-fips-default.rst
248249

249250
.. include:: /includes/md5-and-scram-sha-1.rst
251+
252+
Database Tools and FIPS Mode
253+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
254+
255+
Starting in MongoDB 4.2, the following programs no longer support the
256+
:option:`--sslFIPSMode <mongod --sslFIPSMode>` option:
257+
258+
- :binary:`~bin.mongodump`
259+
- :binary:`~bin.mongoexport`
260+
- :binary:`~bin.mongofiles`
261+
- :binary:`~bin.mongoimport`
262+
- :binary:`~bin.mongorestore`
263+
- :binary:`~bin.mongostat`
264+
- :binary:`~bin.mongotop`
265+
266+
``mongod``, ``mongos``, and FIPS Mode
267+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268+
269+
If you configure :binary:`~bin.mongod` and :binary:`~bin.mongos` to use
270+
FIPS mode, ``mongod`` and ``mongos`` use FIPS-compliant connections.
271+
272+
MongoDB Shell and FIPS Mode
273+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
274+
275+
The default :binary:`MongoDB Shell <~bin.mongosh>` distribution:
276+
277+
- Contains OpenSSL 1.1.
278+
- Uses FIPS-compliant connections to :binary:`~bin.mongod` and
279+
:binary:`~bin.mongos` if you configure ``mongod`` and ``mongos`` to
280+
use FIPS mode.
281+
282+
MongoDB also provides a MongoDB Shell distribution that can use:
283+
284+
- OpenSSL 1.1 and OpenSSL 3 installed on your server.
285+
- ``--tlsFIPSMode`` option, which enables the ``mongosh`` FIPS mode.
286+
287+
.. seealso::
288+
289+
- To download MongoDB Shell distributions that contain OpenSSL 1.1
290+
and OpenSSL 3, go to the `MongoDB Download Center
291+
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
292+
- :ref:`mdb-shell-install`

‎source/tutorial/install-mongodb-enterprise-on-amazon.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ Amazon Linux:
7171

7272
.. include:: /includes/steps/install-mongodb-enterprise-on-amazon.rst
7373

74+
.. note::
75+
76+
.. include:: /includes/install-mongodb-yum-commands.rst
77+
7478
Run MongoDB Enterprise Edition
7579
------------------------------
7680

‎source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ the ``.tgz``.
9292

9393
.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst
9494

95+
.. include:: /includes/install-mongodb-shell-tarball.rst
96+
9597
Run MongoDB Enterprise Edition
9698
------------------------------
9799

‎source/tutorial/install-mongodb-enterprise-on-debian.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ Follow these steps to install MongoDB |edition| Edition using the
6565

6666
.. include:: /includes/steps/install-mongodb-enterprise-on-debian.rst
6767

68+
.. note::
69+
70+
.. include:: /includes/install-mongodb-apt-get-commands.rst
71+
6872
Run MongoDB Enterprise Edition
6973
------------------------------
7074

‎source/tutorial/install-mongodb-enterprise-on-red-hat.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ Follow these steps to install MongoDB |edition| Edition using the
5858

5959
.. include:: /includes/steps/install-mongodb-enterprise-on-red-hat.rst
6060

61+
.. note::
62+
63+
.. include:: /includes/install-mongodb-yum-commands.rst
64+
6165
Run MongoDB Enterprise Edition
6266
------------------------------
6367

‎source/tutorial/install-mongodb-enterprise-on-ubuntu.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ Install MongoDB Enterprise Edition
6666
Follow these steps to install MongoDB |edition| Edition using the
6767
|package-manager| package manager.
6868

69-
.. include:: /includes/steps/install-mongodb-enterprise-on-ubuntu.rst
69+
.. note::
70+
71+
.. include:: /includes/install-mongodb-apt-get-commands.rst
7072

7173
Run MongoDB Enterprise Edition
7274
------------------------------

0 commit comments

Comments
 (0)