Laravelの開発環境をDockerで構築します。自動化ツール

Laravelの開発環境をDockerで構築する

Laravel を使って Web アプリケーション開発をする際に、開発環境をどうするかというのはわりと最初に考えるところでもあります。
既にオンプレミスやクラウド上に構築された開発サーバを使うか..自身の PC に仮想環境を構築...VirtualBox? Vagrant？ Docker？選択肢は多岐に渡ります。
今回は、Laravel の開発環境を Docker で構築していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E6%A4%9C%E8%A8%BC%E7%92%B0%E5%A2%83">検証環境</a></li>
<li><a href="#%E6%A7%8B%E7%AF%89%E3%81%99%E3%82%8B%E6%A7%8B%E6%88%90">構築する構成</a></li>
<li><a href="#laravel-%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Laravel インストール</a></li>
<li><a href="#dockerfile">Dockerfile</a>
<ol>
<li><a href="#app">APP</a></li>
<li><a href="#db">DB</a></li>
</ol>
</li>
<li><a href="#docker-compose">Docker Compose</a></li>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%8A%E8%B5%B7%E5%8B%95">コンテナ起動</a></li>
</ol>
<h2 id="検証環境">検証環境</h2>
今回の検証環境については、以下の通りです。
<ul>
<li>macOS Mojave</li>
<li>docker for Mac</li>
</ul>
今回は、Mac 環境で、docker for Mac と composer がインストールされている前提で進めていきます。
<h2 id="構築する構成">構築する構成</h2>
Laravel を動作させるためには、WEB サーバとデータベースが必要です。なので今回はアプリケーション用と DB 用２つの Docker イメージを作成します。さらにそれをまとめて管理できるように、Docker Compose を使用します。
ちなみに今回のデモでは、以下の構成で構築します。
<ul>
<li>CentOS 7（最新版）</li>
<li>Apache 2.4</li>
<li>PHP 7.2</li>
<li>MySQL 8.0（最新版）</li>
<li>Laravel 5.7（最新版）</li>
</ul>
いくつかファイルを作成するので、今回のディレクトリ構成は以下で開始します。
<pre><code class="hljs language-shell">./
├── docker
│   ├── app
│   └── db
└── laravel
</code></pre>
docker ディレクトリに設定ファイル等を設置します。 laravel ディレクトリには Laravel をインストールします。
<h2 id="laravel-インストール">Laravel インストール</h2>
まずは Laravel をインストールしておきます。プロジェクトルートで composer を使って Laravel をインストールします。
<pre><code class="hljs language-shell">composer create-project laravel/laravel --prefer-dist laravel
</code></pre>
laravel ディレクトリ配下へインストールされます。
<h2 id="dockerfile">Dockerfile</h2>
app/DB それぞれのイメージを作成するために Dockerfile を作成します。
<h3 id="app">APP</h3>
アプリケーション側のイメージを定義します。 docker/app 配下に Dockerfile を作成して以下を定義します。
<dl class="description_setting">
<dt>docker/app/Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM centos:latest

RUN yum -y update &#x26;&#x26; yum -y install httpd

RUN yum -y install epel-release \
&#x26;&#x26; rpm -ivh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm \
&#x26;&#x26; yum -y install --enablerepo=remi,remi-php72 php \
php-opcache php-devel php-mbstring php-mcrypt php-mysqlnd php-phpunit-PHPUnit \
php-pecl-xdebug php-gd php-intl php-symfony php-pdo php-xml php-tokenizer php-pear php-zip

ENTRYPOINT ["/usr/sbin/httpd", "-DFOREGROUND"]
</code></pre>
</dd>
</dl>
上から解説します。
<pre><code class="hljs language-dockerfile">FROM centos:latest
</code></pre>
ベースイメージとして CentOS の最新版を指定しています。
<pre><code class="hljs language-dockerfile">RUN yum -y update &#x26;&#x26; yum -y install httpd
</code></pre>
Apache をインストールします。
<pre><code class="hljs language-dockerfile">RUN yum -y install epel-release \
&#x26;&#x26; rpm -ivh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm \
&#x26;&#x26; yum -y install --enablerepo=remi,remi-php72 php \
php-opcache php-devel php-mbstring php-mcrypt php-mysqlnd php-phpunit-PHPUnit \
php-pecl-xdebug php-gd php-intl php-symfony php-pdo php-xml php-tokenizer php-pear php-zip
</code></pre>
PHP とエクステンションをインストールします。 PHP7.2 と、Laravel の動作に必要な PHP 拡張を指定しています。
<pre><code class="hljs language-dockerfile">ENTRYPOINT ["/usr/sbin/httpd", "-DFOREGROUND"]
</code></pre>
コンテナ起動時に Apache を起動します。
<h3 id="db">DB</h3>
次に、データベース側のイメージを定義します。 docker/db 配下に Dockerfile を作成して以下を定義します。
<dl class="description_setting">
<dt>docker/db/Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM mysql:latest
COPY ./conf.d /etc/mysql/conf.d
</code></pre>
</dd>
</dl>
ベースイメージに MySQL の最新版を指定しています。そして、設定ファイルをコピーして MySQL の設定を行います。
docker/db 配下に conf.d ディレクトリを作成し、設定ファイルを定義します。
<dl class="description_setting">
<dt>docker/db/conf.d/my.cnf</dt>
<dd>
<pre><code class="hljs language-ini">[mysqld]
# Character code setting / collation order setting
character_set_server=utf8mb4
collation-server=utf8mb4_bin

collation_server = utf8mb4_ja_0900_as_cs

# Default Authentication Plugin
default_authentication_plugin=mysql_native_password

# Japan time
default-time-zone='+9:00'

[mysql]
default-character-set=utf8mb4
</code></pre>
</dd>
</dl>
文字コードの設定などを行なっていますが、自身の好きな設定にしていただければ良いです。
<h2 id="docker-compose">Docker Compose</h2>
Dockerfile を作成が完了したので、次にそれらを Docker Compose で管理します。
docker/ 配下に docker-compose.yml を作成して以下を定義します。
<pre><code class="hljs language-yaml">version: '3'
services:
 db:
 container_name: laravel_db_sample
 build: ./db/
 image: laravel_db_sample
 environment:
 MYSQL_ROOT_PASSWORD: Password@1234
 MYSQL_DATABASE: laravel_db
 ports:
 - 3306:3306
 app:
 container_name: laravel_app_sample
 build: ./app/
 image: laravel_app_sample
 ports:
 - 80:8000
 links:
 - db
 volumes:
 - ../laravel:/var/www/html/laravel
 stdin_open: true
 tty: true
 depends_on:
 - db
</code></pre>
今回は PHP のビルトインウェブサーバーを利用するので、アプリケーション側のポートを 80 番から 8000 番にマッピングするようにしています。
Laravel をインストールした laravel ディレクトリをボリュームとしてマウントしています。
<h2 id="コンテナ起動">コンテナ起動</h2>
全ての設定が完了したので、コンテナを起動させます。
docker ディレクトリへ移動し、以下の docker-compose コマンドを叩きます。
<pre><code class="hljs language-shell">docker-compose up -d --build
</code></pre>
Docker イメージが作成され、コンテナが起動します。
初回はイメージを作成するため若干時間がかかりますが、一度作成されてしまえば次回からは高速でコンテナが起動します。
<pre><code class="hljs language-shell">docker-compose up -d // 2 回目からはこっちで OK
</code></pre>
コンテナが立ち上がったら、Laravel のストレージとログディレクトリのパーミッションを変更します。以下の docker コマンドを叩きます。
<pre><code class="hljs language-shell">docker exec -it laravel_app_sample chown -R apache:apache /var/www/html/laravel/storage /var/www/html/laravel/bootstrap/cache
</code></pre>
最後にビルトインサーバーを起動します。以下の docker コマンドを叩きます。
<pre><code class="hljs language-shell">docker exec -it laravel_app_sample php /var/www/html/laravel/artisan serve --host 0.0.0.0
</code></pre>
ビルトインサーバーが立ち上がったら、ブラウザから http://localhost へアクセスします。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/162/OZ5mMPc3OHuPqarmKAgf.png" width="600" height="294" alt="Laravel 初期画面"></div>
Docker コンテナが起動し、正常に動作している事を確認できました。もちろん Laravel ソースはコンテナを落としても消えないので、ここから開発を進めていけます。
ちなみに、コンテナをストップさせる時は以下の docker-compose コマンドを叩きます。
<pre><code class="hljs language-shell"># コンテナのストップ
docker-compose down

# イメージも削除する
docker-compose down --rmi all
</code></pre>
最終的なディレクトリ構成は以下になります。
<pre><code class="hljs language-shell">.
├── docker
│   ├── app
│   │   └── Dockerfile
│   ├── db
│   │   ├── Dockerfile
│   │   └── conf.d
│   │   └── my.cnf
│   └── docker-compose.yml
└── laravel
   └── # Laravel ソース一式
</code></pre>
<h2 id="まとめ">まとめ</h2>
作業は以上で終了です。 Docker を用いた開発環境構築は既存のイメージを使ったりなど、今回の手順以外にも手段は結構あるので、自分に最も合う方法を探す事をお勧めします。
開発環境の構築に Docker を用いると構築時間を短縮できるので、そもそもの目的である Laravel での Web アプリケーション開発に集中する事ができます。また「infrastructure as code 」によって安定して環境の構築や配布が行え、かつ高速に動作するので、Docker はおすすめです。
ちなみに今回は、コンテナを立ち上げる前に Laravel をインストールしたり、コンテナを立ち上げたあとにビルトインサーバーを起動させたりと、若干の作業が発生していましたが、 これらの作業も全て自動化したツールを Github にアップしてあります。 
<a href="https://github.com/rito328/laravel-docker" rel="noopener noreferrer" target="_blank">Laravel Docker Starter</a> 
こちらでは、今回扱わなかったマイグレーションやシーディングも実行されるようにしてあります。その他、詳細は README を確認してください。

Laravel を使って Web アプリケーション開発をする際に、開発環境をどうするかというのはわりと最初に考えるところでもあります。
既にオンプレミスやクラウド上に構築された開発サーバを使うか..自身の PC に仮想環境を構築...VirtualBox? Vagrant？ Docker？選択肢は多岐に渡ります。
今回は、Laravel の開発環境を Docker で構築していきます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E6%A4%9C%E8%A8%BC%E7%92%B0%E5%A2%83">検証環境</a></li>
<li><a href="#%E6%A7%8B%E7%AF%89%E3%81%99%E3%82%8B%E6%A7%8B%E6%88%90">構築する構成</a></li>
<li><a href="#laravel-%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Laravel インストール</a></li>
<li><a href="#dockerfile">Dockerfile</a>
<ol>
<li><a href="#app">APP</a></li>
<li><a href="#db">DB</a></li>
</ol>
</li>
<li><a href="#docker-compose">Docker Compose</a></li>
<li><a href="#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%8A%E8%B5%B7%E5%8B%95">コンテナ起動</a></li>
</ol>
<h2 id="検証環境">検証環境</h2>
今回の検証環境については、以下の通りです。
<ul>
<li>macOS Mojave</li>
<li>docker for Mac</li>
</ul>
今回は、Mac 環境で、docker for Mac と composer がインストールされている前提で進めていきます。
<h2 id="構築する構成">構築する構成</h2>
Laravel を動作させるためには、WEB サーバとデータベースが必要です。なので今回はアプリケーション用と DB 用２つの Docker イメージを作成します。さらにそれをまとめて管理できるように、Docker Compose を使用します。
ちなみに今回のデモでは、以下の構成で構築します。
<ul>
<li>CentOS 7（最新版）</li>
<li>Apache 2.4</li>
<li>PHP 7.2</li>
<li>MySQL 8.0（最新版）</li>
<li>Laravel 5.7（最新版）</li>
</ul>
いくつかファイルを作成するので、今回のディレクトリ構成は以下で開始します。
<pre><code class="hljs language-shell">./
├── docker
│   ├── app
│   └── db
└── laravel
</code></pre>
docker ディレクトリに設定ファイル等を設置します。 laravel ディレクトリには Laravel をインストールします。
<h2 id="laravel-インストール">Laravel インストール</h2>
まずは Laravel をインストールしておきます。プロジェクトルートで composer を使って Laravel をインストールします。
<pre><code class="hljs language-shell">composer create-project laravel/laravel --prefer-dist laravel
</code></pre>
laravel ディレクトリ配下へインストールされます。
<h2 id="dockerfile">Dockerfile</h2>
app/DB それぞれのイメージを作成するために Dockerfile を作成します。
<h3 id="app">APP</h3>
アプリケーション側のイメージを定義します。 docker/app 配下に Dockerfile を作成して以下を定義します。
<dl class="description_setting">
<dt>docker/app/Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM centos:latest

RUN yum -y update &#x26;&#x26; yum -y install httpd

RUN yum -y install epel-release \
&#x26;&#x26; rpm -ivh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm \
&#x26;&#x26; yum -y install --enablerepo=remi,remi-php72 php \
php-opcache php-devel php-mbstring php-mcrypt php-mysqlnd php-phpunit-PHPUnit \
php-pecl-xdebug php-gd php-intl php-symfony php-pdo php-xml php-tokenizer php-pear php-zip

ENTRYPOINT ["/usr/sbin/httpd", "-DFOREGROUND"]
</code></pre>
</dd>
</dl>
上から解説します。
<pre><code class="hljs language-dockerfile">FROM centos:latest
</code></pre>
ベースイメージとして CentOS の最新版を指定しています。
<pre><code class="hljs language-dockerfile">RUN yum -y update &#x26;&#x26; yum -y install httpd
</code></pre>
Apache をインストールします。
<pre><code class="hljs language-dockerfile">RUN yum -y install epel-release \
&#x26;&#x26; rpm -ivh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm \
&#x26;&#x26; yum -y install --enablerepo=remi,remi-php72 php \
php-opcache php-devel php-mbstring php-mcrypt php-mysqlnd php-phpunit-PHPUnit \
php-pecl-xdebug php-gd php-intl php-symfony php-pdo php-xml php-tokenizer php-pear php-zip
</code></pre>
PHP とエクステンションをインストールします。 PHP7.2 と、Laravel の動作に必要な PHP 拡張を指定しています。
<pre><code class="hljs language-dockerfile">ENTRYPOINT ["/usr/sbin/httpd", "-DFOREGROUND"]
</code></pre>
コンテナ起動時に Apache を起動します。
<h3 id="db">DB</h3>
次に、データベース側のイメージを定義します。 docker/db 配下に Dockerfile を作成して以下を定義します。
<dl class="description_setting">
<dt>docker/db/Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM mysql:latest
COPY ./conf.d /etc/mysql/conf.d
</code></pre>
</dd>
</dl>
ベースイメージに MySQL の最新版を指定しています。そして、設定ファイルをコピーして MySQL の設定を行います。
docker/db 配下に conf.d ディレクトリを作成し、設定ファイルを定義します。
<dl class="description_setting">
<dt>docker/db/conf.d/my.cnf</dt>
<dd>
<pre><code class="hljs language-ini">[mysqld]
# Character code setting / collation order setting
character_set_server=utf8mb4
collation-server=utf8mb4_bin

collation_server = utf8mb4_ja_0900_as_cs

# Default Authentication Plugin
default_authentication_plugin=mysql_native_password

# Japan time
default-time-zone='+9:00'

[mysql]
default-character-set=utf8mb4
</code></pre>
</dd>
</dl>
文字コードの設定などを行なっていますが、自身の好きな設定にしていただければ良いです。
<h2 id="docker-compose">Docker Compose</h2>
Dockerfile を作成が完了したので、次にそれらを Docker Compose で管理します。
docker/ 配下に docker-compose.yml を作成して以下を定義します。
<pre><code class="hljs language-yaml">version: '3'
services:
 db:
 container_name: laravel_db_sample
 build: ./db/
 image: laravel_db_sample
 environment:
 MYSQL_ROOT_PASSWORD: Password@1234
 MYSQL_DATABASE: laravel_db
 ports:
 - 3306:3306
 app:
 container_name: laravel_app_sample
 build: ./app/
 image: laravel_app_sample
 ports:
 - 80:8000
 links:
 - db
 volumes:
 - ../laravel:/var/www/html/laravel
 stdin_open: true
 tty: true
 depends_on:
 - db
</code></pre>
今回は PHP のビルトインウェブサーバーを利用するので、アプリケーション側のポートを 80 番から 8000 番にマッピングするようにしています。
Laravel をインストールした laravel ディレクトリをボリュームとしてマウントしています。
<h2 id="コンテナ起動">コンテナ起動</h2>
全ての設定が完了したので、コンテナを起動させます。
docker ディレクトリへ移動し、以下の docker-compose コマンドを叩きます。
<pre><code class="hljs language-shell">docker-compose up -d --build
</code></pre>
Docker イメージが作成され、コンテナが起動します。
初回はイメージを作成するため若干時間がかかりますが、一度作成されてしまえば次回からは高速でコンテナが起動します。
<pre><code class="hljs language-shell">docker-compose up -d // 2 回目からはこっちで OK
</code></pre>
コンテナが立ち上がったら、Laravel のストレージとログディレクトリのパーミッションを変更します。以下の docker コマンドを叩きます。
<pre><code class="hljs language-shell">docker exec -it laravel_app_sample chown -R apache:apache /var/www/html/laravel/storage /var/www/html/laravel/bootstrap/cache
</code></pre>
最後にビルトインサーバーを起動します。以下の docker コマンドを叩きます。
<pre><code class="hljs language-shell">docker exec -it laravel_app_sample php /var/www/html/laravel/artisan serve --host 0.0.0.0
</code></pre>
ビルトインサーバーが立ち上がったら、ブラウザから http://localhost へアクセスします。
<div class="img_wrap"><img src="/images/posts/162/OZ5mMPc3OHuPqarmKAgf.png" width="600" height="294" alt="Laravel 初期画面"></div>
Docker コンテナが起動し、正常に動作している事を確認できました。もちろん Laravel ソースはコンテナを落としても消えないので、ここから開発を進めていけます。
ちなみに、コンテナをストップさせる時は以下の docker-compose コマンドを叩きます。
<pre><code class="hljs language-shell"># コンテナのストップ
docker-compose down

# イメージも削除する
docker-compose down --rmi all
</code></pre>
最終的なディレクトリ構成は以下になります。
<pre><code class="hljs language-shell">.
├── docker
│   ├── app
│   │   └── Dockerfile
│   ├── db
│   │   ├── Dockerfile
│   │   └── conf.d
│   │   └── my.cnf
│   └── docker-compose.yml
└── laravel
   └── # Laravel ソース一式
</code></pre>
<h2 id="まとめ">まとめ</h2>
作業は以上で終了です。 Docker を用いた開発環境構築は既存のイメージを使ったりなど、今回の手順以外にも手段は結構あるので、自分に最も合う方法を探す事をお勧めします。
開発環境の構築に Docker を用いると構築時間を短縮できるので、そもそもの目的である Laravel での Web アプリケーション開発に集中する事ができます。また「infrastructure as code 」によって安定して環境の構築や配布が行え、かつ高速に動作するので、Docker はおすすめです。
ちなみに今回は、コンテナを立ち上げる前に Laravel をインストールしたり、コンテナを立ち上げたあとにビルトインサーバーを起動させたりと、若干の作業が発生していましたが、 これらの作業も全て自動化したツールを Github にアップしてあります。 
<a href="https://github.com/rito328/laravel-docker" rel="noopener noreferrer" target="_blank">Laravel Docker Starter</a> 
こちらでは、今回扱わなかったマイグレーションやシーディングも実行されるようにしてあります。その他、詳細は README を確認してください。

Author