Create a Local Atlas Deployment with Docker

docker pull mongodb/mongodb-atlas-local:latest
.. step:: Run the Docker image.
**Example:**
.. tabs::
.. tab:: Manually Connect no Auth
:tabid: no-auth
.. code-block:: sh
docker run -p 27017:27017 mongodb/mongodb-atlas-local
.. tab:: Manually Connect with Auth
:tabid: with-auth
.. code-block:: sh
docker run -e MONGODB_INITDB_ROOT_USERNAME=user -e MONGODB_INITDB_ROOT_PASSWORD=pass -p 27017:27017 mongodb/mongodb-atlas-local
.. tab:: Automate Connection
:tabid: automate-connection
To automate a containerized deployment of |service|, you'll need to wait
for the container to be in a healthy state before you can connect to |service|.
The following example demonstrates deploying an |service| image in Docker
and polling Docker to check the state of the container. Once the
container is in a healthy state, the script automates a connection
to your |service| instance with `Mongosh <https://www.mongodb.com/docs/mongodb-shell/install/>`__.
a. Create a file called ``mongodb-atlas-local.sh``, and paste the
following script into your new file.
.. code-block:: sh
# Start mongodb-atlas-local container
echo "Starting the container"
CONTAINER_ID=$(docker run --rm -d -P mongodb/mongodb-atlas-local:latest)
echo "waiting for container to become healthy..."
function wait() {
CONTAINER_ID=$1
echo "waiting for container to become healthy..."
for _ in $(seq 120); do
STATE=$(docker inspect -f '{{ .State.Health.Status }}' "$CONTAINER_ID")
case $STATE in
healthy)
echo "container is healthy"
return 0
;;
unhealthy)
echo "container is unhealthy"
docker logs "$CONTAINER_ID"
stop
exit 1
;;
*)
sleep 1
esac
done
echo "container did not get healthy within 120 seconds, quitting"
docker logs mongodb_atlas_local
stop
exit 2
}
wait "$CONTAINER_ID"
EXPOSED_PORT=$(docker inspect --format='{{ (index (index .NetworkSettings.Ports "27017/tcp") 0).HostPort }}' "$CONTAINER_ID")
# Build the connectionstring
CONNECTION_STRING="mongodb://127.0.0.1:$EXPOSED_PORT/test?directConnection=true"
# Example usage of the connection string to connect to mongosh
mongosh "$CONNECTION_STRING"
b. Run the following command to make the file executable.
.. code-block:: sh
chmod +x mongodb-atlas-local.sh
c. Run the executable.
.. code-block:: sh
./mongodb-atlas-local.sh
.. step:: Connect to the local |service| deployment.
To connect to the local |service| deployment from the host (not
container), copy and paste the following command into a new
terminal, and replace the ``{connection_string}`` variable with
your connection string.
.. note::
The following example uses :binary:`~bin.mongosh`, but you can use the
connection method that you prefer.
.. code-block:: sh
mongosh {connection_string}
**Examples:**
.. tabs::
.. tab:: No Authentication
:tabid: no-auth
.. code-block:: sh
mongosh "mongodb://localhost:27017/?directConnection=true"
.. tab:: With Authentication
:tabid: with-auth
.. code-block:: sh
mongosh "mongodb://user:pass@localhost:27017/?directConnection=true"

brew install docker-compose
To learn more, see the `Docker Compose install documentation
<https://docs.docker.com/compose/install/>`__.
.. step:: Create a ``docker-compose.yaml`` file.
Create the ``docker-compose.yaml`` file in the same directory
that you run Docker Compose from. For a complete and detailed
example, see :ref:`atlas-cli-docker-compose`.
**Example:**
.. code-block:: sh
:linenos:
services:
mongodb:
image: mongodb/mongodb-atlas-local
environment:
- MONGODB_INITDB_ROOT_USERNAME=user
- MONGODB_INITDB_ROOT_PASSWORD=pass
ports:
- 27018:27017
.. step:: Run Docker Compose.
The following command creates a local |service| deployment with
|fts| capabilities enabled.
**Example:**
.. code-block:: sh
docker-compose up
.. step:: Connect to the local |service| deployment.
To connect to the local |service| deployment from the host (not
container), copy and paste the following command into a new
terminal, and replace the ``{connection_string}`` variable with
your connection string.
.. note::
The following example uses :binary:`~bin.mongosh`, but you can use the
connection method that you prefer.
.. code-block:: sh
mongosh {connection_string}
**Example:**
.. code-block:: sh
mongosh "mongodb://user:pass@localhost:27018/?directConnection=true"
.. step:: (Optional) Stop the container.
.. code-block:: sh
docker compose down -v

brew install docker-compose
To learn more, see the `Docker Compose install documentation
<https://docs.docker.com/compose/install/>`__.
.. step:: Create a ``docker-compose.yaml`` file.
Update the ``docker-compose.yaml`` file to mount the necessary
data directories as volumes.
**Example:**
.. code-block:: sh
:linenos:
services:
mongodb:
hostname: mongodb
image: mongodb/mongodb-atlas-local
environment:
- MONGODB_INITDB_ROOT_USERNAME=user
- MONGODB_INITDB_ROOT_PASSWORD=pass
ports:
- 27019:27017
volumes:
- data:/data/db
- config:/data/configdb
volumes:
data:
config:
.. step:: Run Docker Compose.
The following command creates a local |service| deployment with
|fts| capabilities enabled.
**Example:**
.. code-block:: sh
docker-compose up
You can also run Docker Compose in `detached mode <https://docs.docker.com/reference/cli/docker/compose/up/#options>`__.
**Example:**
.. code-block:: sh
docker-compose up -d
.. step:: Connect to the local |service| deployment.
To connect to the local |service| deployment from the host (not
container), copy and paste the following command into a new
terminal, and replace the ``{connection_string}`` variable with
your connection string.
.. note::
The following example uses :binary:`~bin.mongosh`, but you can use the
connection method that you prefer.
.. code-block:: sh
mongosh {connection_string}
**Example:**
.. code-block:: sh
mongosh "mongodb://user:pass@localhost:27019/?directConnection=true"

brew install syft
To learn more, see the :github:`syft README
</anchore/syft/blob/main/README.md>`.
.. step:: Run syft.
.. code-block:: sh
syft mongodb/mongodb-atlas-local

brew install cosign
To learn more, see the `cosign Installation
<https://docs.sigstore.dev/cosign/system_config/installation/>`__.
.. step:: Run the following commands.
**Example:**
.. code-block:: sh
curl -O https://cosign.mongodb.com/mongodb-atlas-local.pem
.. code-block:: sh
COSIGN_REPOSITORY="docker.io/mongodb/signatures" cosign verify --private-infrastructure --key=./mongodb-atlas-local.pem "mongodb/mongodb-atlas-local";

on:
push:
branches:
- main
pull_request:
jobs:
run:
runs-on: ubuntu-latest
services:
mongodb:
image: mongodb/mongodb-atlas-local
ports:
- 27017:27017
steps:
- name: install mongosh
run: |
curl --output mongosh.deb https://downloads.mongodb.com/compass/mongodb-mongosh_2.2.1_amd64.deb
sudo dpkg -i mongosh.deb
mongosh --version
- run: mongosh 'mongodb://localhost/?directConnection=true' --eval 'show dbs'