如何使用Docker實現PHP命令行程序的CI/CD?
本文標簽: Docker PHP命令行程序的CI/CD Codeship
內容要點: - 使用Jet設置環境並在本地運行測試 - 配置Codeship Pro每次新代碼提交時,自動運行測試 - 上一步的測試通過後,自動將更新部署到服務器
持續集成
應用程序和測試套件已經在本地運行,下一步要做的是建立一些持續集成系統。雖然可以設置服務器來執行此操作,但這個過程工作量略大,因此推薦一個像Codeship Pro的服務。
使用Jet進行本地測試
代碼提交到Codeship測試前,建議先安裝其本地版本的持續集成平臺:Jet。這會更快地推進工作,下面示例配置文件中,需要根據應用的實際情況,做出相應調整。
安裝Jet後,在項目的根目錄中創建兩個新文件——
1) codeship-services.yml – docker-compose.yml 文件的變種,適用於Codeship
2) codeship-steps.yml – 在持續集成過程中,命令和順序的說明
codeship-services.yml文件與 docker-compose.yml 幾乎一樣。內容如下:
version: "2.0" services: # PHP Application app: build: . links: - database encrypted_env_file: .env.encrypted command: cron -f # Database database: image: mariadb encrypted_env_file: .env.encrypted # Composer composer: image: composer/composer volumes: - ./:/app
codeship-steps.yml內容如下,這個文件在例子裏很簡單,按順序執行這些的命令(一個接一個地)就好。如果應用程序允許,也可以並列地跑某幾個步驟:
-type: serial steps: -service: composer command: install -service: app command: bash docker/codeship-run.sh
為了確保應用程序容器和數據庫容器已啟動,可以看到codeship-steps.yml文件調用了一個尚未創建的shell腳本。若數據庫遷移,說明測試通過。把腳本放在 ./docker/codeship-run.sh ,內容如下:
#!/usr/bin/env bash ## Ensure that the database is up and running function test_database { mysqladmin -h"$DB_HOST"-u"$DB_USERNAME"-p"$DB_PASSWORD"ping } count=0 until( test_database ) do ((count++)) ## This will check up to 100 times. if[${count}-gt 100] then echo"Services didn‘t become ready in time" exit1 fi ## And the script waits one second between each try sleep1 done ## Create the database mysql -h"$DB_HOST"-u"$DB_USERNAME"-p"$DB_PASSWORD"-e ‘CREATE DATABASE IF NOT EXISTS laravel‘ ## Run migrations php artisan migrate ## Run the test suite vendor/bin/phpunit
首先,該腳本會嘗試連接到數據庫。Codeship軟件會自動啟動應用程序容器和數據庫容器,但MySQL初始化需要幾秒,所以必須重試該test_database()功能,直到成功連接數據庫(或嘗試100次)。這在Codeship的Docker文檔中有更詳細的概述。
一旦腳本能連接到數據庫,它將創建默認數據庫(數據庫名為laravel)。然後會運行遷移,通過PHPUnit創建數據庫表和測試套件。
最後,為了測試配置正常運行和且結果通過,用Jet來運行所有步驟:
$ jet steps
如果一切正常,那麽在構建容器鏡像過程中,會看到一堆輸出,運行返回一條成功消息:
{ContainerRunStdout=step_name:"serial_bash_docker/codeship-run.sh" service_name:"app"}: PHPUnit 5.7.19 by Sebastian Bergmann and contributors. {ContainerRunStdout=step_name:"serial_bash_docker/codeship-run.sh" service_name:"app"}:. 1/1(100%) Time:1.09 seconds, Memory:12.00MB OK (1test,1 assertion) {StepFinished=step_name:"serial_bash_docker/codeship-run.sh"type:STEP_FINISHED_TYPE_SUCCESS} $
將倉庫連接到Codeship
如果尚未提交本地代碼到GitHub或Bitbucket上。每次提交代碼更改時,Codeship都自動會從私有或公共倉庫中拉取代碼,所以只需要設置Codeship去監視那個倉庫。
在Codeship中創建一個新項目,並將其連接到倉庫:
跳出提示框時,選擇Codeship Pro做為項目類型。
現在項目已經鏈接到Codeship。下次提交代碼時,Codeship將會編譯且使用與本地相同的 codeship-steps.yml 來運行。此時唯一的問題是使用本地的 .env 文件,此文件不會提交到代碼倉庫,不過有個簡單方法來設置環境變量且又不會影響安全性。
加密環境變量
因為最好的做法是不要將 .env 文件推送到持續集成服務器,所以需要提出一種安全地將變量傳遞給Codeship方法——加密 .env 文件。【原文地址:http://whosmall.com/?post=480】
首先,在Codeship找到AES密鑰(通常位於項目設置的常規頁面中),並將其放在一個名為 codeship.aes 的本地根目錄文件中。不要忘記將此文件添加到.gitignore,因為它是不應共享的密鑰:
下一步,更新 codeship-services.yml 文件,讓其使用加密的.env文件,而非明文.env文件:
version:"2.0" services: # PHP Application app: build: . links: - database encrypted_env_file: .env.encrypted command: cron -f # Database database: image: mariadb encrypted_env_file: .env.encrypted # Composer composer: image: composer/composer volumes: - ./:/app
使用Jet將.env文件加密成.env.encrypted,將加密後的.env.encrypted文件提交到軟件倉庫,然後將其推送到遠程倉庫:
$ jet encrypt .env.env.encrypted $ git add -A &&git commit -am "Adding codeship config" $ git push origin
Codeship正在編譯代碼:
也可以點擊進去,查看編譯詳細過程和每個步驟:
如果上述都無誤地執行,最後會看到一個成功的編譯結果:
自動部署
雖然持續集成服務會讓人知道編譯和測試是否通過,但使用Codeship更大的價值在於自動化部署過程,為了做到這一點,需要做幾件事情:
- 在服務器上手動配置和部署代碼庫
- 服務器上有一個SSH密鑰,允許從代碼庫拉取代碼
- 服務器上有一個腳本,用來更新代碼並重新啟動容器
準備齊全後,就可以構建一個部署者容器,其工作就是在編譯過程結束後,登陸到SSH服務器中,運行更新腳本。【原文地址:http://whosmall.com/?post=480】
這只是利用容器來部署代碼的一種方法,也許並不是最佳的方法。另一個選擇是使用Docker Hub等容器倉庫來編譯,然後直接從Docker Hub那裏更新容器。Docker在生產中的最佳做法仍在探索中,這種方法更適用也相對簡單。
首次手動部署代碼
此步驟根據主機服務提供商而有所不同,但只要服務器滿足安裝了Git,Docker和Docker Compose就可以。SSH登陸服務器:
- 創建一個新的SSH密鑰
- 賦予SSH密鑰可以從代碼庫讀取訪問
- 克隆代碼庫
- 設置.env文件,使用一個新的APP_KEY和數據庫密碼
- 使用docker-compose up -d –build 命令來制作鏡像,並且運行容器
現在可以運行 docker ps 查看,當第一次在本地配置好這個項目時,可以看到同樣的兩個容器在運行。
添加腳本更新服務器代碼
現在在本地版本的代碼中,添加一個shell腳本,該腳本將從倉庫中獲取更新的代碼,並重啟容器:
#!/usr/bin/env bash ## Pull the latest code git pull origin master ## Rebuild the containers docker-compose up -d --build ## Run migrations docker exec dockerphpcliexample_app_1 php artisan migrate --force
文件名叫deploy.sh 位於docker/文件夾中。
此時,要確保文件位於服務器上,因此提交代碼到代碼庫,又將其從服務器中拉出。通過在服務器上運行命令: $ bash docker/deploy.sh ,並確保容器仍然工作。
創建一個部署者容器
綜上所述,在編譯和測試結束後,現在需要一個容器在Codeship的CI服務器遠程運行此部署腳本。在倉庫中創建一個名為deployer/ 的新目錄,裏面包含 Dockerfile文件,.env文件和execute.sh文件。
Dockerfile:
FROM alpine:latest # Install openssh RUN apk update && apk add openssh # Prep for the ssh key RUN mkdir-p "$HOME/.ssh" RUN touch$HOME/.ssh/id_rsa RUN chmod600$HOME/.ssh/id_rsa # Add the shell script COPY execute.sh execute.sh CMD sh execute.sh
.env:
USER=<SERVER_SSH_USERNAME> HOST=<SERVER_HOST> PRIVATE_SSH_KEY=<SSH_KEY (with linebreaks replaced with `\n`)>
execute.sh:
#!/usr/bin/env bash echo-e $PRIVATE_SSH_KEY>>$HOME/.ssh/id_rsa ssh-t -oStrictHostKeyChecking=no $USER@$HOST"cd docker-php-cli-example && sh docker/deploy.sh"
這個容器將使用.env文件中的環境變量,SSH登陸到服務器運行部署腳本。
讓Codeship Pro運行部署者容器
為了讓Codeship知道部署者容器,把它添加到codeship-services.yml文件中:
# Deployer deployer: build: ./deployer encrypted_env_file: deployer/.env.encrypted codeship-steps.yml 文件: -service: deployer command: sh execute.sh
加密deployer/.env 文件,這樣可以提交到代碼庫,並且不會暴露服務器的SSH密鑰。正如對主代碼庫那樣,用jet來加密.env文件:
$ jet encrypt deployer/.env deployer/.env.encrypted
最後,把更新的代碼推到github倉庫,確保Codeship成功地編譯和部署了代碼:
原文地址: https://blog.codeship.com/adding-ci-and-cd-to-a-php-command-line-app-with-docker/
寫在最後:FOR Freedom 看看外邊的世界,以及IT這一行,少不了去Google查資料,最後,安利一些速器代理。
加速器推薦 | 免費方案 | 付費方案 | 官方網站 |
一枝紅杏加速器 | 免費方案暫無,穩定高速 | 輸入8折優惠碼wh80,年付只需80元/年 | 官網直達http://whosmall.com/go/yzhx |
安雲加速器 | 最好用的外貿VPN | 最低¥30/月 | 官網直達http://whosmall.com/go/ay |
LoCo加速器 | 每天免費2小時 | 最低¥15/月 | 官網直達http://whosmall.com/go/loco |
本文標簽: Docker PHP命令行程序的CI/CD Codeship
轉自 SUN‘S BLOG - 專註互聯網知識,分享互聯網精神!
原文地址: 《如何使用Docker實現PHP命令行程序的CI/CD?》
相關閱讀:《Mac 系統上易上手且功能全面動圖制作工具: GIF Brewery 3》
相關閱讀:《MacOS 系統上快速高效的文件查重工具:Gemini 2》
相關閱讀:《MacOS系統上高效的任務窗口管理工具:HazeOver》
相關閱讀:《MacOS 如何用 LaunchBar 一鍵上傳文件至 Google Drive?》
相關閱讀:《最好用的 Mac App 快速啟動及切換工具:Manico 2.0》
相關閱讀:《我為什麽選擇 Window Tidy 作為 MacOS 分屏工具?》
相關閱讀: 對程序員有用:2017最新能上Google的hosts文件下載及總結網友遇到的各種hosts問題解決方法及配置詳解
相關BLOG:SUN’S BLOG - 專註互聯網知識,分享互聯網精神!去看看:www.whosmall.com
原文地址:http://whosmall.com/?post=480
如何使用Docker實現PHP命令行程序的CI/CD?