目前講述如何部署Phoenix應(yīng)用的文章并不多,這篇文章旨在叫你如何在Ubuntu上部署Phoenix應(yīng)用至生產(chǎn)環(huán)境,希望這篇文章能給你帶來(lái)足夠的信息,給你一種簡(jiǎn)單的方法來(lái)自動(dòng)化部署應(yīng)用并讓其熱代碼升級(jí)。
這篇文章針對(duì)的是中小型應(yīng)用,一般來(lái)說(shuō)是你的頭幾個(gè)練手的App,這里有一些前提條件:1)應(yīng)用構(gòu)建過程發(fā)生在服務(wù)器端,這里不涉及CI或是單獨(dú)的構(gòu)建服務(wù)器。2)我們使用一個(gè)服務(wù)器來(lái)放App,使用Nginx作為代理,使用postgres作為數(shù)據(jù)庫(kù),目標(biāo)服務(wù)器是Ubuntu 16.04。3)使用Gatling來(lái)達(dá)到git push一鍵部署功能。
Phoenix應(yīng)用的基本部署方式在official Phoenix deployment guide中已經(jīng)給出。這篇教程給出了部署應(yīng)用的必要操作。盡管該教程是手動(dòng)部署,但是其中許多步驟可以自動(dòng)化操作,像是edeliver(Capistrano style) 或是 Gatling (Heroku style).。
當(dāng)然,還有其他許多部署方式,如基于Docker的部署等。在我們的第一個(gè)應(yīng)用使用Gatling能輕松地做到自動(dòng)化部署還有熱代碼升級(jí),而其他部署方式卻有些復(fù)雜。Gatling已經(jīng)有半年的歷史了,所以其中還有一些坑需要填,不過它優(yōu)秀的代碼架構(gòu)使你可以很快掌握它。
1. 配置Ubuntu 16.04
這篇教程里,用來(lái)部署的用戶叫deploy。
使用visudo
命令來(lái)添加deploy用戶
sudo visudo -f /etc/sudoers.d/deploy
下面這條命令能使deploy用戶不用密碼提示
deploy ALL=(ALL) NOPASSWD:ALL
服務(wù)器要求
服務(wù)器上我們需要安裝Erlang, Elixir, Node, nginx and Postgres
Erlang和Elixir
wget https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb && sudo dpkg -i erlang-solutions_1.0_all.deb && rm erlang-solutions_1.0_all.deb
sudo apt-get update
sudo apt-get install -y esl-erlang elixir
Node.js
如果國(guó)內(nèi)安裝不了,可以到 https://npm.taobao.org/ 參考安裝方法。
curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -sudo apt-get install -y nodejs build-essential
當(dāng)然,因?yàn)樵谔斐灰嗽O(shè)置taobao的mirror。
npm config set registry https://registry.npm.taobao.org
npm info underscore
如果配置成功,第二步會(huì)有字符串返回
Nginx
Ubuntu 16.04 源里的 Nginx 版本相對(duì)較新,你也可以通過 nginx version from the Ubuntu PPA 的方式安裝最新版本的 Nginx。
sudo apt-get install nginx
Postgres
sudo apt-get install postgresql
Postgres user
sudo -u postgres createuser -s -P deploy
sudo -u postgres createdb deploy
可以通過 su - postgres 切換到 postgres 默認(rèn)用戶,psql 打開控制臺(tái),\du 查看所有用戶,\password postgres 設(shè)置密碼。
http://www.ruanyifeng.com/blog/2013/12/getting_started_with_postgresql.html
Phoenix 部署
Phoenix的官方文檔中還使用Exrm作為發(fā)行打包工具,但是1.3之后將采用它的繼任者 Distillery 了。
首先我們需要把distillery添加到mix.exs的依賴列表中,因?yàn)榇虬幾g的時(shí)候我們需要這個(gè)包。
defp deps do
[{:phoenix, "~> 1.2.0"},
...
{:distillery, "~> 1.0"}]
end
接下來(lái)我們的app名稱是MyApp。
準(zhǔn)備Distillery發(fā)布
無(wú)論你是否使用Phoenix或者Gatling,Distillery都是Elixir程序的很好的打包發(fā)布工具。可以查看它的 Getting Started 來(lái)了解基本使用方法。如果你已經(jīng)在項(xiàng)目中使用了Distillery,那么就可以直接看這篇 Using Distillery with Phoenix。
先使用命令
mix release.init
創(chuàng)建rel/config.exs,然后編輯。
在Phoenix應(yīng)用中需要有一個(gè)rel/config.exs
來(lái)存放你的發(fā)布配置。我們需要添加output_dir
來(lái)指定輸出目錄。原因是Gatling使用rel目錄而不是默認(rèn)的_build目錄。
environment :prod do
# We need to include the Erlang Run-Time System even though
# we deploy on the same machine that builds the release.
# This has to be enabled to support hot upgrades.
set include_erts: true
# ...
set output_dir: "rel/myapp"
end
注:在最新的Gatling中,不需要指定output_dir
準(zhǔn)備app
我們采用環(huán)境變量來(lái)配置生產(chǎn)環(huán)境的一些參數(shù)。Phoenix本身提供方法是使用一個(gè)單獨(dú)的prod.secret.exs
文件,讀Plataformatec的這篇文章
How to config environment variables with Elixir 你就知道為何這么做了。
下面是我們的config/prod.exs
文件。
config :my_app, MyApp.Endpoint,
# the PORT env variable will be set by Gatling in the
# init script of the service that (re)starts the app
http: [port: {:system, "PORT"}],
url: [scheme: "http", host: "myapp.com", port: 80],
cache_static_manifest: "priv/static/manifest.json",
# configuration for the Distillery release
root: ".",
server: true,
version: Mix.Project.config[:version]
config :my_app, MyApp.Endpoint,
secret_key_base: System.get_env("SECRET_KEY_BASE")
config :my_app, MyApp.Repo,
adapter: Ecto.Adapters.Postgres,
username: System.get_env("DB_USERNAME"),
password: System.get_env("DB_PASSWORD"),
database: System.get_env("DB_DATABASE"),
hostname: System.get_env("DB_HOSTNAME"),
pool_size: 20
# This line appears further down. Do not forget to uncomment it!
config :phoenix, :serve_endpoints, true
# Remove the prod secret import as we configure via environment variables
# import_config "prod.secret.exs"
配置服務(wù)器環(huán)境變量
為了使服務(wù)器上有這些變量,我們需要將它們添加至/etc/environment
這個(gè)文件。以deploy用戶登錄,修改此文件。
echo 'MIX_ENV=prod' | sudo tee -a /etc/environment
echo 'SECRET_KEY_BASE=TheSecretKeyBaseFromTheProdSecretFile' | sudo tee -a /etc/environment
echo 'DB_HOSTNAME=localhost' | sudo tee -a /etc/environment
echo 'DB_DATABASE=myapp_prod' | sudo tee -a /etc/environment
echo 'DB_USERNAME=deploy' | sudo tee -a /etc/environment
echo 'DB_PASSWORD=password_for_myapp_prod' | sudo tee -a /etc/environment
source /etc/environment
PORT無(wú)需設(shè)置因?yàn)樵赼pp啟動(dòng)時(shí)Gatling會(huì)自動(dòng)設(shè)置它。
為Gatling配置服務(wù)器
接下來(lái)我們需要在服務(wù)器上安裝Gatling了。 Gatling 是一個(gè)由 Hashrocket 開發(fā)的自動(dòng)化應(yīng)用部署工具,你可以讀一下 他們對(duì)Gatling的介紹。它作為工具很主觀,當(dāng)然也對(duì)大多數(shù)用戶的需求進(jìn)行了考慮。
mix archive.install https://github.com/hashrocket/gatling_archives/raw/master/gatling.ez
mix local.hex
mix local.rebar
安裝好Gatling tasks之后就可以在服務(wù)器上初始化應(yīng)用了,它會(huì)簡(jiǎn)歷一個(gè)空的Git倉(cāng)庫(kù)來(lái)接收你本地推送的代碼,然后在服務(wù)器上打包。記得我們之前說(shuō)的么?Gatling的打包和部署發(fā)生在同一個(gè)服務(wù)器上。現(xiàn)實(shí)生產(chǎn)中我們可需要不同服務(wù)器喲。
mix gatling.load myapp
配置Gatling
在你本機(jī)的倉(cāng)庫(kù)上添加遠(yuǎn)程production推送的地址。
git remote add production deploy@myapp.com:myapp
然后在repo的根目錄下創(chuàng)建domains
文件,里面寫上你指向這個(gè)app的域名們。
myapp.com
www.myapp.com
部署流程鉤子
Gatling對(duì)部署的每個(gè)步驟前后都有鉤子,我們需要在項(xiàng)目根目錄下添加兩個(gè)文件,來(lái)編譯和簽名資源文件。
第一個(gè)是deploy.exs
,為初始發(fā)布服務(wù)。
defmodule MyApp.DeployCallbacks do
import Gatling.Bash
def before_mix_digest(env) do
# mkdir prevents complains about this directory not existing
bash("mkdir", ~w[-p priv/static], cd: env.build_dir)
bash("npm", ~w[install], cd: env.build_dir)
bash("npm", ~w[run deploy], cd: env.build_dir)
end
end
第二個(gè)是upgrade.exs
,它與上面的文件基本相同。
defmodule MyApp.UpgradeCallbacks do
import Gatling.Bash
def before_mix_digest(env) do
bash("npm", ~w[install], cd: env.build_dir)
bash("npm", ~w[run deploy], cd: env.build_dir)
end
end
部署app
你需要在mix.exs
文件中每次都更新你的部署版本。通常有兩種做法,其一是每次commit前都手動(dòng)修改一下版本號(hào),可以參考Semantic Versioning,還有一種就是讓mix文件根據(jù)日期自動(dòng)產(chǎn)生版本號(hào)。
設(shè)置好這些我們就可以commit了,然后push到生產(chǎn)服務(wù)器上。
git push production master
使用deploy帳號(hào)登錄服務(wù)器,執(zhí)行g(shù)atling提供的deploy任務(wù)。
sudo mix gatling.deploy
它會(huì)自動(dòng)生成一個(gè)初始的發(fā)布,查找可用端口并配置nginx代理到app,并且包括了必要的websocket配置。它同時(shí)也創(chuàng)建了一個(gè)init.d腳本來(lái)管理app進(jìn)程。你可以使用service myapp
來(lái)控制app的start/stop。
常見問題
1. 如何刪除部署應(yīng)用
首先 service myapp stop
或者 ps -aux | grep myapp 看看哪些kill掉
APP=<project_name> && rm -rf ~/$(APP) && rm -rf ~/deployments/$(APP) && rm /etc/init.d/$(APP) && rm /etc/nginx/sites-enabled/$(APP) && rm /etc/init/nginx/sites-available/($APP)
https://github.com/hashrocket/gatling/issues/23
2. Distillery dependencies missing
如果出現(xiàn)以下錯(cuò)誤
One or more direct or transitive dependencies are missing from :applications or :included_applications, they will not be included in the release
將羅列的依賴添加到applications中去。
http://www.lxweimin.com/p/99b1c0eb2014
3. git push 推送生產(chǎn)環(huán)境,會(huì)運(yùn)行在dev模式
這是由于sudo的安全策略引起的,sudo命令會(huì)創(chuàng)建一個(gè)新的用戶環(huán)境。
所以在sudo命令后添加 --preserve-env
flag。或使用sudo賬戶推送。
https://github.com/hashrocket/gatling/issues/22
17ca79f
回顧
看起來(lái)我們談?wù)摿艘淮蠖巡渴餚hoenix應(yīng)用的事情,當(dāng)然,這只是冰山一角,我們僅僅粗略談了下讓你能夠快速體驗(yàn)自動(dòng)化部署的快感。
如果你需要將一個(gè)應(yīng)用部署到多個(gè)服務(wù)器上并負(fù)載均衡,可以看看這篇文章 deploying into a multi-server load balanced setup on Digital Ocean。
Ref
https://dennisreimann.de/articles/phoenix-deployment-gatling-ubuntu-digital-ocean.html