Ubuntu上使用Gatling部署Phoenix应用 - 为你的Phoenix App自建Heroku

目前讲述如何部署Phoenix应用的文章并不多，这篇文章旨在叫你如何在Ubuntu上部署Phoenix应用至生产环境，希望这篇文章能给你带来足够的信息，给你一种简单的方法来自动化部署应用并让其热代码升级。

这篇文章针对的是中小型应用，一般来说是你的头几个练手的App，这里有一些前提条件：1）应用构建过程发生在服务器端，这里不涉及CI或是单独的构建服务器。2）我们使用一个服务器来放App，使用Nginx作为代理，使用postgres作为数据库，目标服务器是Ubuntu 16.04。3）使用Gatling来达到git push一键部署功能。

Phoenix应用的基本部署方式在official Phoenix deployment guide中已经给出。这篇教程给出了部署应用的必要操作。尽管该教程是手动部署，但是其中许多步骤可以自动化操作，像是edeliver(Capistrano style) 或是 Gatling (Heroku style).。

当然，还有其他许多部署方式，如基于Docker的部署等。在我们的第一个应用使用Gatling能轻松地做到自动化部署还有热代码升级，而其他部署方式却有些复杂。Gatling已经有半年的历史了，所以其中还有一些坑需要填，不过它优秀的代码架构使你可以很快掌握它。

1. 配置Ubuntu 16.04

这篇教程里，用来部署的用户叫deploy。

使用visudo命令来添加deploy用户

sudo visudo -f /etc/sudoers.d/deploy

下面这条命令能使deploy用户不用密码提示

deploy ALL=(ALL) NOPASSWD:ALL

服务器要求

服务器上我们需要安装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
如果国内安装不了，可以到 https://npm.taobao.org/ 参考安装方法。

curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -sudo apt-get install -y nodejs build-essential

当然，因为在天朝，不要忘了设置taobao的mirror。

npm config set registry https://registry.npm.taobao.org
npm info underscore 

如果配置成功,第二步会有字符串返回

Nginx
Ubuntu 16.04 源里的 Nginx 版本相对较新，你也可以通过 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 默认用户，psql 打开控制台，\du 查看所有用户，\password postgres 设置密码。

http://www.ruanyifeng.com/blog/2013/12/getting_started_with_postgresql.html

Phoenix 部署

Phoenix的官方文档中还使用Exrm作为发行打包工具，但是1.3之后将采用它的继任者 Distillery 了。
首先我们需要把distillery添加到mix.exs的依赖列表中，因为打包编译的时候我们需要这个包。

  defp deps do
    [{:phoenix, "~> 1.2.0"},
      ...
     {:distillery, "~> 1.0"}]
  end

接下来我们的app名称是MyApp。

准备Distillery发布
无论你是否使用Phoenix或者Gatling，Distillery都是Elixir程序的很好的打包发布工具。可以查看它的 Getting Started 来了解基本使用方法。如果你已经在项目中使用了Distillery，那么就可以直接看这篇 Using Distillery with Phoenix。

先使用命令

mix release.init

创建rel/config.exs，然后编辑。

在Phoenix应用中需要有一个rel/config.exs来存放你的发布配置。我们需要添加output_dir来指定输出目录。原因是Gatling使用rel目录而不是默认的_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

准备app
我们采用环境变量来配置生产环境的一些参数。Phoenix本身提供方法是使用一个单独的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"

配置服务器环境变量
为了使服务器上有这些变量，我们需要将它们添加至/etc/environment这个文件。以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无需设置因为在app启动时Gatling会自动设置它。

为Gatling配置服务器
接下来我们需要在服务器上安装Gatling了。 Gatling 是一个由 Hashrocket 开发的自动化应用部署工具，你可以读一下 他们对Gatling的介绍。它作为工具很主观，当然也对大多数用户的需求进行了考虑。

mix archive.install https://github.com/hashrocket/gatling_archives/raw/master/gatling.ez
mix local.hex
mix local.rebar

安装好Gatling tasks之后就可以在服务器上初始化应用了，它会简历一个空的Git仓库来接收你本地推送的代码，然后在服务器上打包。记得我们之前说的么？Gatling的打包和部署发生在同一个服务器上。现实生产中我们可需要不同服务器哟。

mix gatling.load myapp

配置Gatling
在你本机的仓库上添加远程production推送的地址。

git remote add production [email protected]:myapp

然后在repo的根目录下创建domains文件，里面写上你指向这个app的域名们。

myapp.com
www.myapp.com

部署流程钩子
Gatling对部署的每个步骤前后都有钩子，我们需要在项目根目录下添加两个文件，来编译和签名资源文件。

第一个是deploy.exs，为初始发布服务。

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

第二个是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前都手动修改一下版本号，可以参考Semantic Versioning，还有一种就是让mix文件根据日期自动产生版本号。

设置好这些我们就可以commit了，然后push到生产服务器上。

git push production master

使用deploy帐号登录服务器，执行gatling提供的deploy任务。

sudo mix gatling.deploy

它会自动生成一个初始的发布，查找可用端口并配置nginx代理到app，并且包括了必要的websocket配置。它同时也创建了一个init.d脚本来管理app进程。你可以使用service myapp来控制app的start/stop。

常见问题

1. 如何删除部署应用

首先 service myapp stop
或者 ps -aux | grep myapp 看看哪些kill掉

APP= && 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

如果出现以下错误

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.jianshu.com/p/99b1c0eb2014

3. git push 推送生产环境，会运行在dev模式

这是由于sudo的安全策略引起的，sudo命令会创建一个新的用户环境。
所以在sudo命令后添加 --preserve-env flag。或使用sudo账户推送。
https://github.com/hashrocket/gatling/issues/22
17ca79f

回顾

看起来我们谈论了一大堆部署Phoenix应用的事情，当然，这只是冰山一角，我们仅仅粗略谈了下让你能够快速体验自动化部署的快感。

如果你需要将一个应用部署到多个服务器上并负载均衡，可以看看这篇文章 deploying into a multi-server load balanced setup on Digital Ocean。

Ref

https://dennisreimann.de/articles/phoenix-deployment-gatling-ubuntu-digital-ocean.html