Skip to content

Commit f2ff18c

Browse files
ianf-mongodbianf-mongodb
authored
DOCSP-37341 v6.0 (#6820)
* DOCSP-37341 Add AVX Support Notice to Docker Page (#6705) * DOCSP-37341 Add AVX Support Notice to Docker Page * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * IR Joe Feedback * * * *
1 parent ecd5969 commit f2ff18c

File tree

4 files changed

+64
-39
lines changed

4 files changed

+64
-39
lines changed

‎snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ package-name-enterprise = "mongodb-enterprise"
237237
package-name = "mongodb"
238238
version = "6.0"
239239
latest-lts-version = "6.0"
240+
minimum-lts-version = "5.0"
240241
last-supported-version = "5.0"
241242
release = "6.0.14"
242243
version-dev = "6.0"

‎source/includes/fact-avx-support-docker.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
- MongoDB 5.0+ Docker images require `AVX
2+
<https://en.wikipedia.org/wiki/Advanced_Vector_Extensions>`__ support
3+
on your system. If your system does not support AVX, you can
4+
use a docker image of MongoDB prior to version 5.0.
5+
6+
.. warning::
7+
8+
Versions of MongoDB prior to {+minimum-lts-version+} are EOL'd and
9+
no longer supported by MongoDB. These versions should be used for
10+
testing purposes only.

‎source/tutorial/install-mongodb-community-with-docker.txt

Lines changed: 44 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,29 @@ MongoDB deployment is useful to:
2525
About This Task
2626
---------------
2727

28-
This page describes the Docker install instructions for MongoDB Community
29-
edition. The `MongoDB Enterprise Docker image <https://hub.docker.com/r/mongodb/mongodb-enterprise-server>`__
30-
in conjunction with the
31-
`MongoDB Kubernetes Operator <https://hub.docker.com/r/mongodb/mongodb-atlas-kubernetes-operator-prerelease>`__
32-
are recommended for production deployments.
33-
For enterprise instructions, see :ref:`docker-mongodb-enterprise-install`.
28+
- This page describes the Docker install instructions for MongoDB Community
29+
edition. The `MongoDB Enterprise Docker image
30+
<https://hub.docker.com/r/mongodb/mongodb-enterprise-server>`__
31+
and `MongoDB Kubernetes Operator <https://hub.docker.com/r/mongodb/mongodb-atlas-kubernetes-operator-prerelease>`__
32+
are recommended for production deployments and should be used together.
33+
For enterprise instructions, see :ref:`docker-mongodb-enterprise-install`.
3434

35-
This procedure uses the official `mongo community image
36-
<https://hub.docker.com/r/mongodb/mongodb-community-server>`__, which
37-
is maintained by MongoDB.
35+
- This procedure uses the official `MongoDB community image
36+
<https://hub.docker.com/r/mongodb/mongodb-community-server>`__, which
37+
is maintained by MongoDB.
3838

39-
A full description of `Docker <https://docs.docker.com/>`__ is beyond
40-
the scope of this documentation. This page assumes prior knowledge of
41-
Docker.
39+
- A full description of `Docker <https://docs.docker.com/>`__ is beyond
40+
the scope of this documentation. This page assumes prior knowledge of
41+
Docker.
42+
43+
.. include:: /includes/fact-avx-support-docker
4244

4345
Before You Begin
4446
----------------
4547

46-
Before you can run a MongoDB Community Docker container, you must
47-
install `Docker <https://docs.docker.com/install/>`__ .
48+
- Install `Docker <https://docs.docker.com/install/>`__
49+
50+
- Install `mongosh <https://www.mongodb.com/docs/mongodb-shell/install/>`__
4851

4952
.. _create-docker-image-community:
5053

@@ -59,28 +62,41 @@ Procedure
5962

6063
.. code-block:: sh
6164

62-
docker pull mongodb/mongodb-community-server
65+
docker pull mongodb/mongodb-community-server:latest
6366

6467
.. step:: Run the Image as a Container
6568

6669
.. code-block:: sh
6770

68-
docker run --name mongo -d mongodb/mongodb-community-server:latest
71+
docker run --name mongodb -p 27017:27017 -d mongodb/mongodb-community-server:latest
72+
73+
74+
The ``-p 27017:27017`` in this command maps the container port to the host port.
75+
This allows you to connect to MongoDB with a ``localhost:27017`` connection string.
6976

70-
.. note:: Install a Specific Version of MongoDB
77+
To install a specific version of MongoDB, specify the version
78+
after the ``:`` in the Docker run command. Docker pulls and
79+
runs the specified version.
7180

72-
To install a specific version of MongoDB, specify the version
73-
after the ``:`` in the Docker run command. Docker pulls and
74-
runs the specified version.
81+
For example, to run MongoDB 5.0:
82+
83+
.. code-block:: sh
84+
85+
docker run --name mongodb -p 27017:27017 -d mongodb/mongodb-community-server:5.0-ubuntu2004
7586

76-
For example, to run MongoDB 5.0:
87+
For a full list of available versions, see
88+
`Tags <https://hub.docker.com/r/mongodb/mongodb-community-server/tags>`__.
7789

78-
.. code-block:: sh
90+
.. note:: Add Command Line Options
7991

80-
docker run --name mongo -d mongodb/mongodb-community-server:5.0-ubi8
92+
You can use :ref:`mongod command-line options <conf-file-command-line-mapping>`
93+
by appending the command-line options to the docker run command.
8194

82-
For a full list of available MongoDB Community Server images, see:
83-
`the official Docker Hub page <https://hub.docker.com/r/mongodb/mongodb-community-server/tags>`_.
95+
For example, consider the :option:`<mongod --replSet>` docker command-line option:
96+
97+
.. code-block:: bash
98+
99+
docker run -p 27017:27017 -d mongodb/mongodb-community-server:latest --name mongodb --replSet myReplicaSet
84100

85101
.. step:: Check that the Container is Running
86102

@@ -107,15 +123,12 @@ Procedure
107123

108124
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
109125
c29db5687290 mongodb/mongodb-community-server:5.0-ubi8 "docker-entrypoint.s…" 4 seconds ago Up 3 seconds 27017/tcp mongo
110-
126+
111127
.. step:: Connect to the MongoDB Deployment with ``mongosh``
112-
113-
Open an interactive container instance of ``mongo`` and connect to
114-
the deployment with ``mongosh``.
115128

116129
.. code-block:: sh
117130

118-
docker exec -it mongo mongosh
131+
mongosh --port 27017
119132

120133
.. step:: Validate Your Deployment
121134

@@ -153,7 +166,7 @@ Procedure
153166
readOnly: false,
154167
ok: 1
155168
}
156-
169+
157170
Next Steps (Optional)
158171
---------------------
159172

‎source/tutorial/install-mongodb-enterprise-with-docker.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,22 @@ MongoDB deployment if you want to:
3838
About This Task
3939
---------------
4040

41-
This page assumes prior knowledge of Docker. A full description of
42-
`Docker <https://docs.docker.com/>`__ is beyond the scope of this
43-
documentation.
41+
- This page assumes prior knowledge of Docker. A full description of
42+
`Docker <https://docs.docker.com/>`__ is beyond the scope of this
43+
documentation.
4444

45-
This procedure uses the official `MongoDB Enterprise Advanced Server
46-
<https://hub.docker.com/r/mongodb/mongodb-enterprise-server>`__ container,
47-
which is maintained by MongoDB.
45+
- This procedure uses the official `MongoDB Enterprise Advanced Server
46+
<https://hub.docker.com/r/mongodb/mongodb-enterprise-server>`__
47+
container, which is maintained by MongoDB.
4848

49+
.. include:: /includes/fact-avx-support-docker
4950

5051
Before You Begin
5152
----------------
5253

53-
Install `Docker <https://docs.docker.com/install/>`__.
54+
- Install `Docker <https://docs.docker.com/install/>`__
5455

55-
Install `mongosh <https://www.mongodb.com/docs/mongodb-shell/install/>`__.
56+
- Install `mongosh <https://www.mongodb.com/docs/mongodb-shell/install/>`__
5657

5758
Steps
5859
-----

0 commit comments

Comments
 (0)