基於Docker的PHP開發環境
【編者的話】本文作者是Geoffrey,他是一個PHP的Web開發者,喜歡DevOps和Docker。本文主要介紹瞭如何使用Docker構建PHP的開發環境,文中作者也探討了構建基於Docker的開發環境應該使用單容器還是多容器,各有什麼利弊。推薦PHP開發者閱讀。
現在很多開發者都使用Vagrant來管理他們的虛擬機器開發環境,Vagrant確實很酷, 不過也有不少缺點(最主要的是它佔用太多的資源)。在容器技術、Docker和更多類Docker技術出現後,解決這個問題就變得簡單了。
免責宣告
由於boot2docker
的工作方式,本文所述的方法在你的環境中可能無法正常執行。如果需要在非Linux環境下共享資料夾到Docker容器,還需要注意更多額外的細節。後續我會寫篇文章專門來介紹實際遇到的問題。
怎樣才算是好的開發環境
首先,我們得知道什麼才是好的開發環境, 對於我而言,一個好的開發環境需要具備以下幾個特點:
- 可隨意使用。我必須可以隨意刪除和建立新的環境。
- 快速啟動。我想要用它工作時候,它立馬就能用。
- 易於更新。在我們行業中,事物發展變化非常快,必須能讓我很容易將我的開發環境更新到新的軟體版本。
而Docker都支援以上這些特點,甚至更多。你幾乎可以即時銷燬和重建容器,而更新環境只需要重建你當前使用的映象即可。
什麼是PHP開發環境
目前Web應用錯綜複雜,PHP開發環境需要很多的東西,為了保證環境的簡單性,需要做各種各樣的限制。
我們這次使用Nginx、PHP5-FPM、MySQL來執行Synmfony專案。由於在容器中執行命令列會更復雜,所以這方面的內容我會放到下一篇部落格中再說。
Pet 與 Cattle
另一個我們要討論的重點是:我們要把開發環境部署在多容器還是單容器中。 兩種方式各有優點:
- 單容器易於分發、維護。因為它們是獨立的,所有的東西都執行在同一個容器中,這點就像是一個虛擬機器。但這也意味著,當你要升級其中的某樣東西(比如PHP新版本)的時候, 需要重新構建整個容器。
- 多容器可以在新增元件時提供更好的模組化。因為每個容器包含了堆疊的一部分:Web、PHP、MySQL等,這樣可以單獨擴充套件每個服務或者新增服務,並且不需要重建所有的東西。
因為我比較懶,加上我需要在我的筆記本上放點別的內容,所以,這裡我們只介紹單個容器的方法。
初始化工程
首先要做的是初始化一個新的Symfony工程. 推薦的方法是用composer
create-project
命令。本來可以在工作站上安裝composer,但是那樣太簡單了。這次我們通過Docker來使用它。
我之前發過一篇關於Docker命令的文章:make docker commands
(好吧,我說謊了,我本來把它寫在這篇文章中了,然後覺得把它獨立出來會比較好)。
不管怎麼樣,你可以讀一下。接下來如果還沒有composer
命令的話,你可以建立一個屬於自己的composer
別名。
$ alias composer="docker run -i -t -v $PWD:/srv ubermuda/composer"
現在你可以初始化Symfony工程了:
$ composer create-project symfony/framwork-standard-edition SomeProject
帥呆了!下面來點實在的工作。(省略了博主自娛自樂的一堆balabla....原文:Awesome. Give yourself a high-five, get a cup of coffee or whatever is your liquid drug of choice, and get ready for the real work.)
容器
構建一個執行標準Symfony專案且自給自足的容器相當容易,只需要安裝好常用的Nginx、PHP5-FPM和MySQL-Server即可,然後把預先準備好的Nginx的虛擬主機配置檔案扔進去,再複製一些配置檔案進去就完事了。 本容器的原始碼在GitHub上的 ubermuda/docker-symfony倉庫中可以找到。 Dockerfile 是Docker構建映象要用到的配置檔案,我們來看一下:
FROM debian:wheezy
ENV DEBIAN_FRONTEND noninteractive
RUN apt-get update -y
RUN apt-get install -y nginx php5-fpm php5-mysqlnd php5-cli mysql-server supervisor
RUN sed -e 's/;daemonize = yes/daemonize = no/' -i /etc/php5/fpm/php-fpm.conf
RUN sed -e 's/;listen.owner/listen.owner/' -i /etc/php5/fpm/pool.d/www.conf
RUN sed -e 's/;listen.group/listen.group/' -i /etc/php5/fpm/pool.d/www.conf
RUN echo "ndaemon off;" >> /etc/nginx/nginx.conf
ADD vhost.conf /etc/nginx/sites-available/default
ADD supervisor.conf /etc/supervisor/conf.d/supervisor.conf
ADD init.sh /init.sh
EXPOSE 80 3306
VOLUME ["/srv"]
WORKDIR /srv
CMD ["/usr/bin/supervisord"]
我們通過擴充套件 debian:wheezy
這個基礎映象開始,然後通過一系列的sed
命令來配置Nginx和PHP5-FPM。
RUN sed -e 's/;daemonize = yes/daemonize = no/' -i /etc/php5/fpm/php-fpm.conf
RUN sed -e 's/;listen.owner/listen.owner/' -i /etc/php5/fpm/pool.d/www.conf
RUN sed -e 's/;listen.group/listen.group/' -i /etc/php5/fpm/pool.d/www.conf
RUN echo "ndaemon off;" >> /etc/nginx/nginx.conf
這裡我們要做兩件事。 首先配置PHP5-FPM和Nginx讓他們在前臺執行以便supervisord可以追蹤到他們。
然後,配置PHP5-FPM以指定的使用者執行Web-Server,並處理好檔案許可權。
接下來需要安裝一組配置檔案,首先是Nginx的虛擬主機配置檔案vhost.conf:
server {
listen 80;
server_name _;
access_log /var/log/nginx/access.log;
error_log /var/log/nginx/error.log;
root /srv/web;
index app_dev.php;
location / {
try_files $uri $uri/ /app_dev.php?$query_string;
}
location ~ [^/].php(/|$) {
fastcgi_pass unix:/var/run/php5-fpm.sock;
include fastcgi_params;
}
}
因為我們不需要域名,所以把server_name
設成了_
(有點像perl的$_
佔位符變數), 並配置根目錄(document root)為/svr/web, 我們會把應用程式部署在/srv
下,剩下的就是標準的Mginx + PHP5-FPM配置.
因為一個容器每次只能執行一個程式, 我們需要supervisord(或者任何別的程序管理器,不過我比較中意supervisord)。幸運的是, 這個程序管理器會產生我們需要的所有程序!下面是一小段supervisord的配置:
[supervisord]
nodaemon=true
[program:nginx]
command=/usr/sbin/nginx
[program:php5-fpm]
command=/usr/sbin/php5-fpm
[program:mysql]
command=/usr/bin/mysqld_safe
[program:init]
command=/init.sh
autorestart=false
redirect_stderr=true
redirect_stdout=/srv/app/logs/init.log
這裡我們需要做的是定義所有的服務, 加上一個特殊的program:init
程序,它不是一個實際的服務,而是一個獨創的執行啟動指令碼的方式。
這個啟動指令碼的問題在於,它通常需要先啟動某些服務。比如,你可能要初始化一些資料庫表,但前提是你得先把MySQL跑起來,一個可能的解決辦法是,在啟動指令碼中啟動MySQL,然後初始化表,然後為了防止影響到supervisord的程序管理,需要停掉MySQL,最後再啟動supervisord。
這樣的指令碼看起來類似下面這樣:
/etc/init.d/mysql start
app/console doctrine:schema:update --force
/etc/init.d/mysql stop
exec /usr/bin/supervisord
看起來醜爆了有木有,咱換種方式,讓supervisor來執行它並且永不重啟。實際的init.sh
指令碼如下:
#!/bin/bash
RET=1
while [[ RET -ne 0 ]]; do
sleep 1;
mysql -e 'exit' > /dev/null 2>&1; RET=$?
done
DB_NAME=${DB_NAME:-symfony}
mysqladmin -u root create $DB_NAME
if [ -n "$INIT" ]; then
/srv/$INIT
fi
指令碼先等待MySQL啟動,然後根據環境變數DB_NAME
建立DB,預設為symfony
, 然後在INIT環境變數中查詢要執行的指令碼,並嘗試執行它。本文的結尾有說明如何使用這些環境變數。
構建並執行映象
萬事俱備只欠東風。我們還要構建Symfony Docker映象, 使用docker build
命令:
$ cd docker-symfony
$ docker build -t symfony .
現在,可以使用它來執行你的Symfony工程了:
$ cd SomeProject
$ docker run -i -t -P -v $PWD:/srv symfony
我們來看看這一連串的選項分別是幹嘛的:
-
-i
啟動互動(interactive)模式, 也就是說,STDIO
(標準輸入輸出)連線到了你當前的終端上。當你要接收日誌或者給程序傳送訊號時,它很有用。 -
-t
為容器建立一個虛擬TTY
, 它跟-i
是好基友,通常一起使用。 -
-P
告訴Docker守護程序釋出所有指定的埠, 本例中為80埠。 -
-v $PWD:/srv
把當前目錄掛載到容器的/srv目錄。掛載一個目錄使得目錄內容對目標掛載點可用。
現在你還記得之前提到的DB_NAME
和INIT
環境變量了吧,幹嘛用的呢:用於自定義你的環境。 基本上你可以通過 docker run
的-e
選項在容器中設定環境變數,啟動指令碼會拿到環境變數,因此,如果你的DB名為some_project_dev
, 你就可以這麼執行容器:
$ docker run -i -t -P -v $PWD:/srv -e DB_NAME=some_project_dev symfony
INIT
環境變數就更強大了,它允許你啟動時執行指定的指令碼。比如, 你有一個bin/setup
指令碼執行composer install
命令並且設定資料庫schema:
#!/bin/bash
composer install
app/console doctrine:schema:update --force
用-e
來執行它:
$ docker run -i -t -P
-v $PWD:/srv
-e DB_NAME=some_project_dev
-e INIT=bin/setup
注意,-e
選項可以在docer run
中多次使用,看起來相當酷。另外,你的啟動指令碼需要可執行許可權(chmod +x
)。
現在我們通過curl
傳送請求到容器,來檢查一下是否所有的東西都像預期一樣工作。首先,我們需要取到Docker對映到容器的80埠的公共埠,用docker port
命令:
$ docker port $(docker ps -aql 1) 80
0.0.0.0:49153
docker ps -aql 1
是個好用的命令,可以方便的檢索到最後一個容器的id, 在我們的例子中,Docker 把容器的80埠對映到了49153埠。我們 curl 一下看看。
$ curl http://localhost:49153
You are not allowed to access this file. Check app_dev.php for more information.
當我們不從localhost(譯者注:容器的localhost)訪問dev controller時,得到了Symfony的預設錯誤訊息,這再正常不過了, 因為我們不是從容器內部發送 curl 請求的, 所以,可以安全的從前端控制器web/app_dev.php
中移除這些行。
// This check prevents access to debug front controllers that are deployed by accident to production servers.
// Feel free to remove this, extend it, or make something more sophisticated.
if (isset($_SERVER['HTTP_CLIENT_IP'])
|| isset($_SERVER['HTTP_X_FORWARDED_FOR'])
|| !(in_array(@$_SERVER['REMOTE_ADDR'], array('127.0.0.1', 'fe80::1', '::1')) || php_sapi_name() === 'cli-server')
)
{
header('HTTP/1.0 403 Forbidden');
exit('You are not allowed to access this file. Check '.basename(__FILE__).' for more information.');
}
這些行阻止了任何從localhost以外的地方訪問dev controller。
現在再curl的時候就可以正常工作了,或者用瀏覽器訪問 http://localhost:49153/:
很容易吧! 現在我們可以快速的啟動、更新環境了,但還是有很多地方需要改進。 原文連結:A PHP development environment with Docker (翻譯:何林沖 審校:郭蕾)