NishidaRyu416/bitnami-docker-mongodb

Bitnami MongoDB Docker Image

What is MongoDB?

MongoDB is a cross-platform document-oriented database. Classified as a NoSQL database, MongoDB eschews the traditional table-based relational database structure in favor of JSON-like documents with dynamic schemas, making the integration of data in certain types of applications easier and faster.

All MongoDB versions released after October 16, 2018 (3.6.9 or later, 4.0.4 or later or 4.1.5 or later) are licensed under the Server Side Public License that is not currently accepted as a Open Source license by the Open Source Iniciative (OSI).

TL;DR;

$ docker run --name mongodb bitnami/mongodb:latest

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-mongodb/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

• Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
• With Bitnami images the latest bug fixes and features are available as soon as possible.
• Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
• All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
• All Bitnami images available in Docker Hub are signed with Docker Content Trust (DTC). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
• Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

How to deploy MongoDB in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami MongoDB Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Supported tags and respective Dockerfile links

NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

• 4.1-ol-7, 4.1.13-ol-7-r39 (4.1/ol-7/Dockerfile)
• 4.1-debian-9, 4.1.13-debian-9-r38, 4.1, 4.1.13, 4.1.13-r38 (4.1/debian-9/Dockerfile)
• 4.0-ol-7, 4.0.10-ol-7-r40 (4.0/ol-7/Dockerfile)
• 4.0-debian-9, 4.0.10-debian-9-r40, 4.0, 4.0.10, 4.0.10-r40, latest (4.0/debian-9/Dockerfile)
• 3.6-ol-7, 3.6.13-ol-7-r31 (3.6/ol-7/Dockerfile)
• 3.6-debian-9, 3.6.13-debian-9-r31, 3.6, 3.6.13, 3.6.13-r31 (3.6/debian-9/Dockerfile)

Subscribe to project updates by watching the bitnami/mongodb GitHub repo.

Get this image

The recommended way to get the Bitnami MongoDB Docker Image is to pull the prebuilt image from the Docker Hub Registry.

$ docker pull bitnami/mongodb:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

$ docker pull bitnami/mongodb:[TAG]

If you wish, you can also build the image yourself.

$ docker build -t bitnami/mongodb:latest https://github.com/bitnami/bitnami-docker-mongodb.git

Persisting your database

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami path. If the mounted directory is empty, it will be initialized on the first run.

$ docker run \
    -v /path/to/mongodb-persistence:/bitnami \
    bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    volumes:
      - /path/to/mongodb-persistence:/bitnami

Connecting to other containers

Using Docker container networking, a MongoDB server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

In this example, we will create a MongoDB client instance that will connect to the server instance that is running on the same docker network as the client.

Step 1: Create a network

$ docker network create app-tier --driver bridge

Step 2: Launch the MongoDB server instance

Use the --network app-tier argument to the docker run command to attach the MongoDB container to the app-tier network.

$ docker run -d --name mongodb-server \
    --network app-tier \
    bitnami/mongodb:latest

Step 3: Launch your MongoDB client instance

Finally we create a new container instance to launch the MongoDB client and connect to the server created in the previous step:

$ docker run -it --rm \
    --network app-tier \
    bitnami/mongodb:latest mongo --host mongodb-server

Using Docker Compose

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named app-tier. In this example we assume that you want to connect to the MongoDB server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  app-tier:
    driver: bridge

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    networks:
      - app-tier
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - app-tier

IMPORTANT:

1. Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
2. In your application container, use the hostname mongodb to connect to the MongoDB server

Launch the containers using:

$ docker-compose up -d

Configuration

Initializing a new instance

When the container is executed for the first time, it will execute the files with extensions .sh, and .js located at /docker-entrypoint-initdb.d.

In order to have your custom files inside the docker image you can mount them as a volume.

Passing extra command-line flags to mongod startup

Passing extra command-line flags to the mongod service command is possible through the following env var:

• MONGODB_EXTRA_FLAGS: Flags to be appended to the startup command. No defaults

$ docker run --name mongodb -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_EXTRA_FLAGS='--wiredTigerCacheSizeGB=2' bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MONGODB_EXTRA_FLAGS=--wiredTigerCacheSizeGB=2

Configuring system log verbosity level

Configuring the system log verbosity level is possible through the following env vars:

• MONGODB_DISABLE_SYSTEM_LOG: Whether to enable/disable system log on MongoDB. Default: no. Possible values: [yes, no].
• MONGODB_SYSTEM_LOG_VERBOSITY: MongoDB system log verbosity level. Default: 0. Possible values: [0, 1, 2, 3, 4, 5]. For more information about the verbosity levels please refer to the MongoDB documentation

$ docker run --name mongodb -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_SYSTEM_LOG_VERBOSITY='3' bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MONGODB_SYSTEM_LOG_VERBOSITY=3

Enabling/disabling IPv6

Enabling/disabling IPv6 is possible through the following env var:

• MONGODB_ENABLE_IPV6: Whether to enable/disable IPv6 on MongoDB. Default: yes. Possible values: [yes, no]

$ docker run --name mongodb -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_ENABLE_IPV6=yes bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MONGODB_ENABLE_IPV6=yes

Enabling/disabling directoryPerDB

Enabling/disabling directoryPerDB is possible through the following env var:

• MONGODB_ENABLE_DIRECTORY_PER_DB: Whether to enable/disable directoryPerDB on MongoDB. Default: yes. Possible values: [yes, no]

$ docker run --name mongodb -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_ENABLE_DIRECTORY_PER_DB=yes bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MONGODB_ENABLE_DIRECTORY_PER_DB=yes

Setting the root password on first run

Passing the MONGODB_ROOT_PASSWORD environment variable when running the image for the first time will set the password of the root user to the value of MONGODB_ROOT_PASSWORD and enabled authentication on the MongoDB server.

$ docker run --name mongodb \
  -e MONGODB_ROOT_PASSWORD=password123 bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - MONGODB_ROOT_PASSWORD=password123

The root user is configured to have full administrative access to the MongoDB server. When MONGODB_ROOT_PASSWORD is not specified the server allows unauthenticated and unrestricted access.

Creating a user and database on first run

You can create a user with restricted access to a database while starting the container for the first time. To do this, provide the MONGODB_USERNAME, MONGODB_PASSWORD and MONGODB_DATABASE environment variables.

$ docker run --name mongodb \
  -e MONGODB_USERNAME=my_user -e MONGODB_PASSWORD=password123 \
  -e MONGODB_DATABASE=my_database bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    environment:
      - MONGODB_USERNAME=my_user
      - MONGODB_PASSWORD=password123
      - MONGODB_DATABASE=my_database

Note! Creation of a user enables authentication on the MongoDB server and as a result unauthenticated access by any user is not permitted.

Setting up a replication

A replication cluster can easily be setup with the Bitnami MongoDB Docker Image using the following environment variables:

• MONGODB_REPLICA_SET_MODE: The replication mode. Possible values primary/secondary/arbiter. No defaults.
• MONGODB_REPLICA_SET_NAME: MongoDB replica set name. Default: replicaset
• MONGODB_PORT_NUMBER: The port each MongoDB will use. Default: 27017
• MONGODB_PRIMARY_HOST: MongoDB primary host. No defaults.
• MONGODB_PRIMARY_PORT_NUMBER: MongoDB primary node port, as seen by other nodes. Default: 27017
• MONGODB_ADVERTISED_HOSTNAME: MongoDB advertised hostname. No defaults. It is recommended to pass this environment variable if you experience issues with ephemeral IPs. Setting this env var makes the nodes of the replica set to be configured with a hostname instead of the machine IP.

Only for authentication:

• MONGODB_REPLICA_SET_KEY: MongoDB replica set key. Length should be greater than 5 characters and should not contain any special characters. Required for all nodes. No default.
• MONGODB_ROOT_PASSWORD: MongoDB root password. No defaults. Only for primary node.
• MONGODB_PRIMARY_ROOT_PASSWORD: MongoDB primary root password. No defaults. Only for secondaries and aribters nodes.

In a replication cluster you can have one primary node, zero or more secondary nodes and zero or one arbiter node.

Note: The total number of nodes on a replica set sceneraio cannot be higher than 8 (1 primary, 6 secondaries and 1 arbiter)

Step 1: Create the replication primary

The first step is to start the MongoDB primary.

$ docker run --name mongodb-primary \
  -e MONGODB_REPLICA_SET_MODE=primary \
   bitnami/mongodb:latest

In the above command the container is configured as the primary using the MONGODB_REPLICA_SET_MODE parameter.

Step 2: Create the replication secondary node

Next we start a MongoDB secondary container.

$ docker run --name mongodb-secondary \
  --link mongodb-primary:primary \
  -e MONGODB_REPLICA_SET_MODE=secondary \
  -e MONGODB_PRIMARY_HOST=primary \
  -e MONGODB_PRIMARY_PORT_NUMBER=27017 \
  bitnami/mongodb:latest

In the above command the container is configured as a secondary using the MONGODB_REPLICA_SET_MODE parameter. The MONGODB_PRIMARY_HOST and MONGODB_PRIMARY_PORT_NUMBER parameters are used connect and with the MongoDB primary.

Step 3: Create a replication arbiter node

Finally we start a MongoDB arbiter container.

$ docker run --name mongodb-arbiter \
  --link mongodb-primary:primary \
  -e MONGODB_REPLICA_SET_MODE=arbiter \
  -e MONGODB_PRIMARY_HOST=primary \
  -e MONGODB_PRIMARY_PORT_NUMBER=27017 \
  bitnami/mongodb:latest

In the above command the container is configured as a arbiter using the MONGODB_REPLICA_SET_MODE parameter. The MONGODB_PRIMARY_HOST and MONGODB_PRIMARY_PORT_NUMBER parameters are used connect and with the MongoDB primary.

You now have a three node MongoDB replication cluster up and running which can be scaled by adding/removing secondarys.

With Docker Compose the replicaset can be setup using:

version: '2'

services:
  mongodb-primary:
    image: 'bitnami/mongodb:latest'
    environment:
      - MONGODB_REPLICA_SET_MODE=primary
    volumes:
      - 'mongodb_master_data:/bitnami'

  mongodb-secondary:
    image: 'bitnami/mongodb:latest'
    depends_on:
      - mongodb-primary
    environment:
      - MONGODB_REPLICA_SET_MODE=secondary
      - MONGODB_PRIMARY_HOST=mongodb-primary
      - MONGODB_PRIMARY_PORT_NUMBER=27017

  mongodb-arbiter:
    image: 'bitnami/mongodb:latest'
    depends_on:
      - mongodb-primary
    environment:
      - MONGODB_REPLICA_SET_MODE=arbiter
      - MONGODB_PRIMARY_HOST=mongodb-primary
      - MONGODB_PRIMARY_PORT_NUMBER=27017

volumes:
  mongodb_master_data:
    driver: local

Or in case you want to set up the replicaset with authentication you can use the following file:

version: '2'

services:
  mongodb-primary:
    image: 'bitnami/mongodb:latest'
    environment:
      - MONGODB_REPLICA_SET_MODE=primary
      - MONGODB_ROOT_PASSWORD=password123
      - MONGODB_REPLICA_SET_KEY=replicasetkey123
    volumes:
      - 'mongodb_master_data:/bitnami'

  mongodb-secondary:
    image: 'bitnami/mongodb:latest'
    depends_on:
      - mongodb-primary
    environment:
      - MONGODB_REPLICA_SET_MODE=secondary
      - MONGODB_PRIMARY_HOST=mongodb-primary
      - MONGODB_PRIMARY_PORT_NUMBER=27017
      - MONGODB_PRIMARY_ROOT_PASSWORD=password123
      - MONGODB_REPLICA_SET_KEY=replicasetkey123

  mongodb-arbiter:
    image: 'bitnami/mongodb:latest'
    depends_on:
      - mongodb-primary
    environment:
      - MONGODB_REPLICA_SET_MODE=arbiter
      - MONGODB_PRIMARY_HOST=mongodb-primary
      - MONGODB_PRIMARY_PORT_NUMBER=27017
      - MONGODB_PRIMARY_ROOT_PASSWORD=password123
      - MONGODB_REPLICA_SET_KEY=replicasetkey123

volumes:
  mongodb_master_data:
    driver: local

Scale the number of secondary nodes using:

$ docker-compose up --detach --scale mongodb-primary=1 --scale mongodb-secondary=3 --scale mongodb-arbiter=1

The above command scales up the number of secondary nodes to 3. You can scale down in the same way.

Note: You should not scale up/down the number of primary nodes. Always have only one primary node running.

How is a replica set configured?

There are three different roles in a replica set configuration (primary, secondary or arbiter). Each one of these roles are configured in a different way:

Primary node configuration:

The replica set is started with the rs.initiate() command and some configuration options to force the primary to be the primary. Basically, the priority is increased from the default (1) to 5. To verify the primary is actually the primary we validate it with the db.isMaster().ismaster command.

The primary node has a volume attached so the data is preserved between deployments as long as the volume exists.

In addition, the primary node initialization script will check for the existence of a .initialized file in the /bitnami/mongodb folder to discern whether it should create a new replica set or on the contrary a replica set has already been initialized.

If the primary got killed and the volume is deleted, in order to start it again in the same replica set it is important to launch the container with the original IP so other members of the replica set already knows about it.

Secondary node configuration:

Once the primary node is up and running we can start adding secondary nodes (and arbiter). For that, the secondary node connects to the primary node and add itself as a secondary node with the command rs.add(SECONDARY_NODE_HOST).

After adding the secondary nodes we verified they have been successfully added by executing rs.status().members to see if they appear in the list.

Arbiter node configuration:

Finally, the arbiters follows the same procedure than secondary nodes with the exception that the command to add it to the replica set is rs.addArb(ARBITER_NODE_HOST). An arbiter should be added when the sum of primary nodes plus secondaries nodes is even.

Configuration file

The image looks for configurations in /opt/bitnami/mongodb/conf/. You can mount a volume at /opt/bitnami/mongodb/conf/ and copy/edit the configurations in the /path/to/mongodb-configuration-persistence/. The default configurations will be populated to the conf/ directory if it's empty.

Step 1: Run the MongoDB image

Run the MongoDB image, mounting a directory from your host.

$ docker run --name mongodb -v /path/to/mongodb-configuration-persistence:/opt/bitnami/mongodb/conf bitnami/mongodb:latest

or using Docker Compose:

version: '2'

services:
  mongodb:
    image: 'bitnami/mongodb:latest'
    ports:
      - "27017:27017"
    volumes:
      - /path/to/mongodb-configuration-persistence:/opt/bitnami/mongodb/conf

Step 2: Edit the configuration

Edit the configuration on your host using your favorite editor.

$ vi /path/to/mongodb-configuration-persistence/mongodb.conf

Step 3: Restart MongoDB

After changing the configuration, restart your MongoDB container for changes to take effect.

$ docker restart mongodb

or using Docker Compose:

$ docker-compose restart mongodb

Refer to the configuration file options manual for the complete list of MongoDB configuration options.

Logging

The Bitnami MongoDB Docker image sends the container logs to the stdout. To view the logs:

$ docker logs mongodb

or using Docker Compose:

$ docker-compose logs mongodb

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Upgrade this image

Bitnami provides up-to-date versions of MongoDB, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.

Step 1: Get the updated image

$ docker pull bitnami/mongodb:latest

or if you're using Docker Compose, update the value of the image property to bitnami/mongodb:latest.

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

$ docker stop mongodb

or using Docker Compose:

$ docker-compose stop mongodb

Next, take a snapshot of the persistent volume /path/to/mongodb-persistence using:

$ rsync -a /path/to/mongodb-persistence /path/to/mongodb-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

You can use this snapshot to restore the database state should the upgrade fail.

Step 3: Remove the currently running container

$ docker rm -v mongodb

or using Docker Compose:

$ docker-compose rm -v mongodb

Step 4: Run the new image

Re-create your container from the new image.

$ docker run --name mongodb bitnami/mongodb:latest

or using Docker Compose:

$ docker-compose up mongodb

Notable Changes

3.6.9, 4.0.4 and 4.1.5 or later

• All MongoDB versions released after October 16, 2018 (3.6.9 or later, 4.0.4 or later or 4.1.5 or later) are licensed under the Server Side Public License that is not currently accepted as a Open Source license by the Open Source Iniciative (OSI).

3.6.6-r16 and 4.1.1-r9

• The MongoDB container has been migrated to a non-root user approach. Previously the container ran as the root user and the MongoDB daemon was started as the mongo user. From now on, both the container and the MongoDB daemon run as user 1001. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing USER 1001 to USER root in the Dockerfile.

3.2.7-r5

• MONGODB_USER parameter has been renamed to MONGODB_USERNAME.

3.2.6-r0

• All volumes have been merged at /bitnami/mongodb. Now you only need to mount a single volume at /bitnami/mongodb for persistence.
• The logs are always sent to the stdout and are no longer collected in the volume.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

• Host OS and version
• Docker version (docker version)
• Output of docker info
• Version of this container (echo $BITNAMI_IMAGE_VERSION inside the container)
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright (c) 2015-2019 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.