Docker 環境で MongoDB を使用する：Dockerfile

こんにちは、@studio_meowtoon です。今回は、WSL の Ubuntu 22.04 の Docker 環境で MongoDB を使用する手順を紹介します。

目的

Windows 11 の Linux でクラウド開発します。

こちらから記事の一覧がご覧いただけます。

実現すること

ローカル環境の Ubuntu の Docker 環境で、MongoDB コンテナを起動します。

MongoDB をコンテナとして起動

実行環境

要素	概要
terminal	ターミナル
Ubuntu	OS
Docker	コンテナ実行環境

データベース コンテナ

要素	概要
mongodb-todo	データベースコンテナ
mongodb	DB サーバー
db_todo	データベース

技術トピック

MongoDB とは？

こちらを展開してご覧いただけます。

MongoDB (モンゴディービー)

MongoDB は、は、オープンソースのドキュメント指向 NoSQL データベースです。

キーワード	内容
ドキュメント指向	データを BSON 形式 (Binary JSON の略) のドキュメントとして保存します。この柔軟なデータモデルは、複雑な階層構造を持つデータや可変スキーマに適しています。
スケーラビリティ	水平方向にスケーリングすることで大量のデータを処理できます。クラスタリングやレプリケーションを活用して高可用性も実現できます。
高速性	インメモリ処理やディスクへの効率的な書き込みなど、高速なデータ操作が可能です。また、クエリの最適化やインデックスを活用してクエリ速度を向上させることができます。
柔軟なスキーマ	データベース内の各ドキュメントは異なるスキーマを持つことができます。これにより、アプリケーションの要件変更に対応しやすく、開発の柔軟性を提供します。
JSON ライクなクエリ言語	MongoDB のクエリ言語は JSON に似ており、複雑な条件や集計も直感的に記述できます。さらに、アグリゲーションパイプラインを使用して高度な集計を行うことができます。
ユーザー認証とアクセス制御	MongoDB はアプリケーションのセキュリティをサポートし、ユーザーごとにアクセス権限を設定できます。
多様なデータタイプのサポート	テキスト、数値、日付、配列、埋め込みドキュメントなど、多様なデータタイプをサポートします。
コミュニティとエコシステム	MongoDB は活発なコミュニティと豊富なエコシステムを持ち、多くのドライバやツールが提供されています。

開発環境

• Windows 11 Home 22H2 を使用しています。

WSL の Ubuntu を操作していきますので macOS の方も参考にして頂けます。

WSL (Microsoft Store アプリ版) ※ こちらの関連記事からインストール方法をご確認いただけます

> wsl --version
WSL バージョン: 1.0.3.0
カーネル バージョン: 5.15.79.1
WSLg バージョン: 1.0.47

Ubuntu ※ こちらの関連記事からインストール方法をご確認いただけます

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 22.04.1 LTS
Release:        22.04

Docker ※ こちらの関連記事からインストール方法をご確認いただけます

$ docker --version
Docker version 23.0.1, build a5ee5b1

この記事では基本的に Ubuntu のターミナルで操作を行います。Vim を使用してコピペする方法を初めて学ぶ人のために、以下の記事で手順を紹介しています。ぜひ挑戦してみてください。

Docker 環境で MongoDB を使用する手順

Docker ネットワークを作成します

$ docker network create net-todo

説明を開きます。

要素	説明
docker network create	Docker 内でコンテナ間通信を可能にするためのネットワークを作成するコマンドです。
net-todo	net-todo という名前の Docker ネットワークが作成されます。

今後、このデータベースコンテナとの間でコンテナ間通信を行うために、ユーザ定義ネットワークを作成しています。

プロジェクトフォルダを作成して移動します。

$ mkdir -p ~/tmp/mongodb-base
$ cd ~/tmp/mongodb-base

初期データの作成

今後、ToDo リストアプリを作成する為に、以下の仕様の初期データを作成します。

ToDo リストコレクション

js ファイルを作成します。

$ vim init_db.js

ファイルの内容

init_db.js

db = db.getSiblingDB('db_todo');

db.todos.insertMany([
    {
        content: '食材を買う',
        created_date: new Date(),
        completed_date: new Date()
    },
    {
        content: '報告書を仕上げる',
        created_date: new Date(),
        completed_date: new Date()
    },
    {
        content: '運動する',
        created_date: new Date(),
        completed_date: new Date()
    },
    {
        content: '本を読む',
        created_date: new Date(),
        completed_date: null
    },
    {
        content: '請求書を支払う',
        created_date: new Date(),
        completed_date: null
    },
    {
        content: '家を掃除する',
        created_date: new Date(),
        completed_date: null
    },
    {
        content: 'プレゼンの準備する',
        created_date: new Date(),
        completed_date: null
    },
    {
        content: 'コードを書く',
        created_date: new Date(),
        completed_date: null
    }
]);

Dockerfile を作成します。

$ vim Dockerfile

ファイルの内容

Dockerfile

# set up the container.
FROM mongo:7.0-jammy

# set utf-8 encoding and the root user's password.
ENV LANG=ja_JP.UTF-8
ENV MONGO_INITDB_ROOT_USERNAME=root
ENV MONGO_INITDB_ROOT_PASSWORD=password

# copy the init js file to the init dir.
COPY init_db.js /docker-entrypoint-initdb.d/

# expose the port.
EXPOSE 27017

説明を開きます。

要素	説明
FROM mongo:7.0-jammy	MongoDB の公式ベースイメージ 7.0-jammy を使用しています。
ENV LANG=ja_JP.UTF-8	コンテナ内で使用する言語環境を ja_JP.UTF-8 に設定しています。これにより、コンテナ内のテキストエンコーディングが UTF-8 で設定されます。
ENV MONGO_INITDB_ROOT_USERNAME=root	MongoDB の初期データベースのルートユーザーのユーザー名を root に設定しています。
ENV MONGO_INITDB_ROOT_PASSWORD=password	ルートユーザーのパスワードを password に設定しています。この情報は初期データベースのセットアップ時に使用されます。
COPY init_db.js /docker-entrypoint-initdb.d/	init_db.js というファイルをコンテナ内の /docker-entrypoint-initdb.d/ ディレクトリにコピーしています。MongoDB コンテナはこのディレクトリ内のスクリプトを初期化時に実行します。このスクリプトは、初期データベースやコレクションの作成、データの挿入などを行うために使用されます。
EXPOSE 27017	コンテナ内の MongoDB のデフォルトポートである 27017 を外部に公開します。

vim をインストールする ver はこちら。

Dockerfile

# set up the container.
FROM mongo:7.0-jammy

# install vim.
RUN apt-get update && \
    apt-get install -y vim && \
    rm -rf /var/lib/apt/lists/* && \
    apt-get clean

# add encoding setting to .vimrc file.
RUN echo ':set encoding=utf-8' >> /root/.vimrc

# set utf-8 encoding and the root user's password.
ENV LANG=ja_JP.UTF-8
ENV MONGO_INITDB_ROOT_USERNAME=root
ENV MONGO_INITDB_ROOT_PASSWORD=password

# copy the init js file to the init dir.
COPY init_db.js /docker-entrypoint-initdb.d/

# expose the port.
EXPOSE 27017

要素	説明
RUN apt-get update	apt-get update は、利用可能なパッケージの最新の情報を取得します。
apt-get install -y vim	Vim エディタをインストールしています。-y フラグは、すべてのプロンプトを自動的に Yes で回答することを意味します。
rm -rf /var/lib/apt/lists/*	APT のキャッシュや一時ファイルを削除して、イメージサイズを小さくするための一般的なベストプラクティスです。
apt-get clean	不要なパッケージファイルをクリーンアップします。これにより、ディスクスペースを節約できます。
RUN echo ':set encoding=utf-8' >> /root/.vimrc	Vim の設定ファイルである .vimrc にエンコーディングの設定を追加しています。

コンテナイメージをビルドします。

$ docker build \
    --no-cache \
    --tag mongo-base:latest .

コンテナイメージを確認します。

$ docker images | grep mongo-base
mongo-base    latest    aad85085cf52    16 seconds ago    720MB

コンテナを作成・起動します。

$ docker run -d \
   --publish 27017:27017 \
   --name mongodb-todo \
   --net net-todo \
   --volume db_todo_mongo:/data/db \
   mongo-base

説明を開きます。

要素	説明
docker run	新しいコンテナを作成して実行するコマンドです。
-d	-d オプションは、コンテナをバックグラウンドで実行します。
--publish 27017:27017	--publish オプションは、ホストとコンテナ間のポートマッピングを行います。ホスト側のポート 27017 をコンテナのポート 27017 にマッピングしています。
--name mongodb-todo	--name オプションは、コンテナに mongodb-todo という名前を付けます。これにより、後でコンテナを識別しやすくなります。
--net net-todo	--net オプションは、コンテナで使用する Docker ネットワークを指定します。
--volume db_todo_mongo:/data/db	--volume オプションは、Docker ボリュームを作成し、コンテナ内の /data/db ディレクトリにマウントします。db_todo_mongo という名前のボリュームが作成されます。これにより、データベースのデータが永続化されます。
mongo-base	MongoDB のカスタムコンテナイメージを指定しています。このイメージを基にしてコンテナが作成され、MongoDB データベースが実行されます。

このコンテナを停止する場合には、以下のコマンドを実行します。

$ docker stop mongodb-todo

次にこのコンテナを起動する場合には、以下のコマンドを実行します。

$ docker start mongodb-todo

ここまでの手順で MongoDB のコンテナを作成し、データベースとコレクションを作成、またコレクションにデータを挿入することができました。

コンテナ内の MongoDB に接続します

コンテナに接続します。
※ コンテナから出るときは ctrl + D を押します。

$ docker exec -it mongodb-todo /bin/sh

説明を開きます。

要素	説明
docker exec	実行中のコンテナ内でコマンドを実行するコマンドです。
-it mongodb-todo	対話的なシェルセッションを開始するためのフラグです。これにより、mongodb-todo コンテナ内のシェルに対して入出力が可能になります。
/bin/sh	コンテナ内で実行するコマンドを指定します。ここではコンテナ内のデフォルトシェルである /bin/sh を起動しています。

mongosh のバージョンを確認します。

# mongosh --version
1.10.5

MongoDB に接続します。
※ MongoDB から出るときは ctrl + D を押します。

# mongosh --host localhost \
    --port 27017 \
    --username root \
    --password password \
    --authenticationDatabase admin

バージョンが表示されています。

Using MongoDB:          7.0.0
Using Mongosh:          1.10.5

データベースの一覧を表示します。

test> show dbs
admin    100.00 KiB
config    12.00 KiB
db_todo   40.00 KiB
local     72.00 KiB

db_todo データベースを選択します。

test> use db_todo
switched to db db_todo

コレクションの一覧を表示します。

test> show collections
todos

コレクションのデータを表示します。

test> db.todos.find()
[
  {
    _id: ObjectId("64e0138a77ed0f0752884e5b"),
    content: '食材を買う',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: ISODate("2023-08-19T00:57:46.694Z")
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e5c"),
    content: '報告書を仕上げる',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: ISODate("2023-08-19T00:57:46.694Z")
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e5d"),
    content: '運動する',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: ISODate("2023-08-19T00:57:46.694Z")
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e5e"),
    content: '本を読む',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: null
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e5f"),
    content: '請求書を支払う',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: null
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e60"),
    content: '家を掃除する',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: null
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e61"),
    content: 'プレゼンの準備する',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: null
  },
  {
    _id: ObjectId("64e0138a77ed0f0752884e62"),
    content: 'コードを書く',
    created_date: ISODate("2023-08-19T00:57:46.694Z"),
    completed_date: null
  }
]

ここまでの手順で MongoDB に接続し、データベースとコレクションの内容を確認することができました。

GUI クライアントから確認

MongoDB を GUI から操作する統合ビジュアルツールとして MongoDB Compass があります。

まとめ

ローカル環境の Ubuntu の Docker 環境で、MongoDB コンテナを起動することができました。

クラウド開発においては、Dockerfile の理解は重要です。自動ビルドツールもありますが、手動で書く必要があるケースもあります。Ubuntu を使うと Linux の知識も身に付きます。最初は難しく感じるかもしれませんが、徐々に進めていけば自信を持って書けるようになります。

どうでしたか？ MongoDB の操作には、この他にもたくさんのコマンドがあります。みなさんも少しづつ試してみてください。今後も開発環境などを紹介していきますので、ぜひお楽しみにしてください。

推奨コンテンツ