Docker Compose RestartでMySQLを初期化する方法

2024-12-09に投稿10分で読む

Docker Compose RestartでMySQLを初期化する方法

Docker Compose で MySQL コンテナを取り扱っている時に、compose.yml ファイルにひと手間を加えて、Restart コマンドで初期化させる方法をご紹介します。

はじめに

この記事は、Docker Compose を使っていて、docker compose down コマンドと docker compose up コマンドを使わずに、MySQL コンテナのdocker-entrypoint-initdb.dを処理させる方法を知りたい方にオススメです（ちなみに、PostgreSQL や MongoDB のコンテナでも流用可能です）。

docker-entrypoint-initdb.d

docker-entrypoint-initdb.dは、MySQL や PostgreSQL などのデータベースコンテナで、始めて起動した時に初期化を行うための機能です。
ホストにあるディレクトリやファイルを、docker-entrypoint-initdb.dそのものやその配下のファイルとしてコンテナにマウントすることで、データベースにテーブルを作成したり、データ投入したりできるため、とても使い勝手が良いです。
この機能は、MySQL 公式の Docker Hub ページで、次のように説明されています（日本語訳を付けていますが、間違えている可能性もあるので、原文をきちんと読んでください）。

Initializing a fresh instance
When a container is started for the first time, a new database with the specified name will be created and initialized with the provided configuration variables.
Furthermore, it will execute files with extensions .sh, .sql and .sql.gz that are found in /docker-entrypoint-initdb.d.
Files will be executed in alphabetical order. You can easily populate your mysql services by mounting a SQL dump into that directory and provide custom images with contributed data.
SQL files will be imported by default to the database specified by the MYSQL_DATABASE variable.
新しいインスタンスの初期化
コンテナが始めて起動された時、指定された名前で新しいデータベースが作成され、指定された構成変数で初期化されます。
さらに、「docker-entrypoint-initdb.d」にある「.sh」と「.sql」、「.sql.gz」の拡張子を持つファイルも、実行されます。
ファイルは、アルファベット順に実行されます。SQL ダンプをそのディレクトリにマウントすることで、MySQL サービスの設定と、投入されたデータを含むカスタムイメージの供給が、簡単にできます。
SQLファイルは、MYSQL_DATABASE 変数によって指定されたデータベースにデフォルトでインポートされます。
出典：mysql - Official Image | Docker Hub

些末でも悩ましい問題

さて、MySQL のコンテナの便利なdocker-entrypoint-initdb.dですが、Docker Compose で取り扱う時には、ちょっとした不便もあります。それは、些末な不都合だけれども、使い続けると悩ましくなる、塵も積もれば山となる様な問題で、以下の2つがあります。

単純な再起動で初期化せず

docker-entrypoint-initdb.dは、コンテナ起動時のエントリーポイントの処理で、/var/lib/mysql が存在するボリュームがマウントされていなければ、実行される仕様です（処理の詳細は、MySQL 8.0 の docker-entrypoint.shを参照してください）。
ゆえに、docker compose down 以外の docker compose restart や docker compose create などの如何なるコマンドを駆使して頑張っても、それらのコマンドはボリュームを削除しないため、MySQL コンテナは初期化処理をしてくれません。

匿名ボリュームのボタ山

docker-entrypoint-initdb.dで、MySQL の初期化させる度に必ず付き纏う現象があります。それは、Anonymous Volume が一つ生成されることです。
そのため、docker compose up と docker compose down のコマンドを繰り返していたら、いつの間にかゴミボリュームの大量生産され、ホストのストレージを食い潰しそうになることもあります。
名前が無いからこそ、残しておきたいボリュームと区別が面倒で、お掃除する時には思わぬ苦行を課せられるわけです。全てのボリュームを消せばいいという思い切った考えで割り切ることもできますけど、SDGs 何それ美味しいの、みたいな正直イケてない仕様です。

問題の解決方法の発見

とある日、私は、docker-compose.yml から compose.yml への移行のために、Docker 公式のドキュメントで仕様を確認していました。
そこで、Services top-level elements ページにある volume 属性の Long syntax セクションを読んだ時に、docker-entrypoint-initdb.dにまつわる問題の解消方法をついに発見するに至りました。

tmpfs のマウント

今までボリューム利用やバインドマウントの簡単なものばかりだったため、volumes 属性の Short syntax だけを使っていました。そのため、Long Syntax であれば、tmpfs や npipe などのマウントや、追加オプションの指定ができることを知りませんでした。
このうち、tmpfs マウントは、前述した諸々の問題への解決策になります。

tmpfs とは何？

「tmpfs (Temporary File System)」とは、Unix 系 OS で、ファイルを一時的にメモリ上に保持するためのファイルシステムです。Docker では、コンテナで tmpfs としてマウントしたボリュームを、ホストのメモリに一時的に保持します。

tmpfs をどう活かすか

tmpfs の仕組み上、それをマウントしたコンテナを停止すると、それに含まれるファイルごとボリュームは揮発します。すなわち、実質的にボリューム自動削除と同じことができます。
この特性を利用すれば、MySQL のコンテナを再起動する度に、毎回新しいボリュームがマウントされる状態を作れるのです。

compose.yml を作ろう

それでは、tmpfs を活用した compose.yml ファイルを作って行きましょう。
前提として、MySQL の設定ファイルは ./build/docker/database/conf ディレクトリに、初期化時に投入する SQL ファイルなどは ./build/docker/database/init ディレクトリに、それぞれ配置されているものとします。
それを踏まえて、2024年10月時点で最新版である Aurora MySQL 3.07.x 互換で、compose.yml ファイルを作成する（併せて、ファイル内で変数を使用するために、.env ファイルも作成しています）と、以下のようになります。

compose.yml
services:
  database:
    container_name: test-database
    image: mysql:8.0.36 # Aurora MySQL 3.07.x 互換
    ports:
      - '3306:3306'
    healthcheck:
      test: "mysqladmin status -h localhost -u ${MYSQL_USER} -p${MYSQL_PASSWORD}"
      start_period: 120s
      interval: 15s
      timeout: 15s
      retries: 3
    volumes:
      - type: tmpfs
        target: /var/lib/mysql
      - type: bind
        source: ./build/docker/database/conf
        target: /etc/mysql/conf.d
        read_only: true
      - type: bind
        source: ./build/docker/database/init
        target: /docker-entrypoint-initdb.d
        read_only: true

./.env
MYSQL_PASSWORD=root
MYSQL_DATABASE=test
MYSQL_USER=user
MYSQL_PASSWORD=pass

volumes 属性の Long syntax

volumes 属性の Long Syntax で記述できるフィールド（一部抜粋）は、下表の通りです。また、記載を省略しましたが、追加オプションとなるフィールドとして、bind や volume もあります。
なお、表をご覧の通り、tmpfs の追加オプションでマウントボリュームのサイズ指定できますが、どの値が良いか決めるのが面倒なので、前述の例では省略しています。

名前	設定できる値
type	「volume」 … トップレベルの volume からマウント
	「bind」 … ディレクトリやファイルからマウント
	「tmpfs」 … ホストのメモリへマウント
source	種別に合わせたソース（「volume」の場合、ボリューム名。「bind」の場合、ディレクトリやファイルのパス。「tmpfs」の場合は、不要）
target	コンテナでマウントされた時のファイルパス
read_only	読み取り専用フラグ（「true」に設定で有効となる。デフォルトは「false」）
tmpfs.size	マウントボリュームのサイズ（数値またはバイト単位）
tmpfs.mode	マウントボリュームの Unix ファイルパーミッションビット（8 進数）。Compose 2.14.0 以上で利用可。

おわりに

この方法は、Docker compose コマンドや MySQL コンテナをメインにした検索ワードで中々ヒットせず、ググラビリティが低いネタのようでした。
tmpfs の側面から検索すると、それっぽいのが見つかりますが、tmpfs を知っている場合は答えが分かっていることになるので、検索しませんよね、という話です。
ですから、この記事で、大したことではないけれども、ちょっと悩んでいる皆さんのエンジニアライフを豊かにする助けになれば、幸いです。

参考文献

Docker

MySQL

Docker Compose RestartでMySQLを初期化する方法

https://blog.chaotic-notes.com/articles/initialize-mysql-with-docker-compose-restart/

作者

Hiroki Sugawara

投稿日

2024-12-09

更新日

2024-12-09

ライセンス

Docker Compose RestartでMySQLを初期化する方法