Erlang/Elixir: 使用 Edeliver 进行自动化的持续部署

Elixir 部署系列

Erlang/Elixir: 用Distillery替换Exam打包器
Erlang/Elixir: Edeliver 持续部署 Checklist
Erlang/Elixir: 使用 Edeliver 进行持续部署

增加 2016-08-19
Erlang/Elixir: 用Distillery替换Exam打包器
更新 2016-07-25
这里有一篇Gitbooks上的文章专门简介如何搭建,配置一个Phoenix应用程序的自动化构建,部署的过程Phoenix持续部署

Edeliver 是一个基于 deliver 的构建和部署工具.
它提供了一个 Bash 脚本来帮助你构建, 部署, 以及执行热代码升级

部署相关的系列文章
Edeliver 持续部署Checklist

Edeliver 部署关系图示

本文我们来聊一聊关于 Erlang/Elixir 的部署问题. 最原始的 Erlang, 我们要使用一大堆工具, 比如 reltool, 后来有了rebar, 还后来 relx 也出来了, Elixir 生态链中还有个 Exrm 打包工具, 是基于 relx 创建发布包的, 打包好了呢, 需要部署到服务器上去运行.

Exrm 打好的包, 一般情况, 我直接用 scp 复制到服务器上的某个目录, 然后在登录到远程服务器解压, 升级等操作. 而 Edeliver 让这个过程完全自动化, 提高了效率, 并且更加适用于中等规模的应用程序部署.

构建 Erlang/Elixir 初始发布版本, 并部署到产品服务器.

mix edeliver build release --branch=master -V
mix edeliver deploy release to production -V
mix edeliver start production -V

把上面三个单独的命令合并为一个

mix edeliver update production --branch=master --start-deploy -V

配置

在项目目录下创建一个 .deliver 目录, 然后在其中添加 config 文件.

#!/usr/bin/env bash

APP="your-erlang-app" # name of your release

# 构建主机的地址, 用户名, 和构建目录
BUILD_HOST="build-system.acme.org"
BUILD_USER="build"
BUILD_AT="/tmp/erlang/my-app/builds"

# 测试目标主机的地址, 用户名, 和部署目录, 多个目标服务器地址用空格分隔开
STAGING_HOSTS="test1.acme.org test2.acme.org"
STAGING_USER="test"
TEST_AT="/test/my-erlang-app"

# 产品目标主机的地址, 用户名, 和部署目录, 多个目标服务器地址用空格分隔开
PRODUCTION_HOSTS="deploy1.acme.org deploy2.acme.org"
PRODUCTION_USER="production"
DELIVER_TO="/opt/my-erlang-app"

本质上, Edeliver 使用 SSH 和 scp 来部署发布. 如果需要无密码登陆, 可通过 ssh-keygen 工具创建密钥对, 把公钥添加到服务器的 ~/.ssh/authorized_keys 文件中即可.

项目配置

defp deps do
    [{:edeliver, ">= 1.2.8"}]
end

def application, do: [
    applications: [
      # ...
      :edeliver,
    ],
  ]

不同的部署目标不同的配置

对于一个需要实现 Failover/Takeover 分布式应用程序来讲, 每个节点的配置是不一样的, 这样在部署的时候就要去编写不同的配置文件.

Edeliver 提供了这样一个功能

TODO::目前项目还没有到这个阶段以后再研究.

构建

必须在和目标系统类似 (建议完全一样的系统) 的系统上构建. 如果想在 Linux 上部署产品系统, 那么发布也应该在 Linux 系统上构建(建议使用相同厂商的 Linux 发型版). 不要求在产品系统上安装 Erlang/OTP 和 Elixir 运行时, 他们会随打包系统自动包含进发布包分发到产品系统上. 下面的配置变量是必须的:

构建完成后, 发布包会被复制到你的本地 .deliver/releases 目录. 然后通过下面的命令发布到产品服务器. 如果成功编译和生成发布包. 发布包会从构建主机复制到发布存储, 默认发布存储的位置在项目根目录下的 .deliver 目录的 releases 子目录, 但可以通过配置环境变量来自定义, 例如:

准确的讲, 是复制到 RELEASE_STORE 环境变量指定的位置, 如果设置了该环境变量的话. 如果没有设置 RELEASE_STORE 环境变量, 默认为项目根目录的 .deliver/releases 子目录.

RELEASE_STORE=/tmp/.deliver                                       # 本地目录
[email protected]:/releases                    # 远程主机
RELEASE_STORE=s3://AWS_ACCESS_KEY_ID@AWS_SECRET_ACCESS_KEY:bucket # 亚马逊S3

发布使用RELEASE_DIR=环境变量来确定发布归档包的位置. 如果未设置, 默认目录包含releases文件的目录. 比如: 如果$APP=myApp, releases的位置为rel/myApp/myApp/releases/RELEASE. 关于完整的 edeliver 命令, 可以通过运行 mix help edeliver 查看:

别自己创建 $BUILD_AT, $TEST_AT, $DELIVER_TO 目录. config/*.secret.exs 应该放在$CONFIG_AT目录, *.vm.args 文件处理节点名称, 集群等配置参数

构建一个全新的版本

mix edeliver build release --version=0.0.1

部署第一个版本

mix edeliver deploy release to production --version=0.0.1 --start-deploy

构建一个升级版本

热升级包含该两条路径

• 从Git仓库发布一个升级包

• 从之前发布的版本构建一个升级包

提升版本号, 在 mix.exs 提升项目的版本号, 下面的命令是直接从源码仓库构建一个热升级包

git commit -m 'Bump version to 0.0.2'              # 提交
git tag 0.0.2                                      # 打TAG
mix edeliver build upgrade --from=0.0.1 --to=0.0.2 # 构建

部署一个升级版本

mix edeliver deploy upgrade to production --version=0.0.2

构建从 v1.0 到 v2.0 的升级包, 并部署升级到产品环境

mix edeliver build upgrade --from=v1.0 --to=v2.0
mix edeliver deploy upgrade to production

或者, 如果在发布存在有旧的发布版本, 可以用那个旧的发布版本来构建升级而不是Git的旧版修订/Tag

mix edeliver build upgrade --with=v1.0 --to=v2.0
mix edeliver deploy upgrade to production

注意 --from= 和 --with= 的区别. --from=指定git仓库的tag, --with=指定旧的release版本号. 可以通过命令mix edeliver show releases查看当前有哪些版本可用.

# 运行Ecto 移植
mix edeliver migrate production

或者使用 --run-migrations 选项在升级期间自动运行

升级 Patch 版本号

mix edeliver build release --increment-version=patch -V

这个命令也是用于构建一个发布包, 只是他会从Git工作区读取最新的Tag版本, 并在此基础上加1, 比如当前仓库中的Tag最新为 1.0.2, 那么该命令会创建一个 1.0.3 的发布版本.

单个命令完成升级

mix edeliver upgrade production -V

上面这个命令将会执行如下步骤:

• 检查所有运行节点的当前版本

• 验证所有节点运行在相同的版本

• 构建从该版本到当前版本的升级包

• 自动给 relup 文件打补丁

• 节点运行的同事部署升级包(热更新)

• 验证所有的节点运行在已升级的版本

• 部署发布包到其他没有处于运行状态的节点

排错

构建主机需要安装好 Erlang/Elixir 的构建环境, 推荐使用 kerl 编译 Erlang, kiex 安装 Elixir. 然后把下面两行脚本添加到用户目录的 .profile 文件中. 目的是让 Edeliver 能够找到 Elixir 工具的位置

. /home/ycc/.kerl/installs/18.3_systemtap/activate
test -s "$HOME/.kiex/scripts/kiex" && source "$HOME/.kiex/scripts/kiex"
kiex use 1.2.5 > /dev/null 2>&1

关于热升级的问题

根据实践验证, 请保证你的项目中 applications, deps 升级前后保持一致, 否则热升级可能导致失败, 如果applications, deps有修改, 这种情况下最好用下面的命令做一次全新部署.

mix edeliver build release --version=<new_version> -V
mix edeliver deploy to production --version=<new_version> -V
mix edeliver start production -V

关于 -V, --verbose 参数

我们在构建发布包的时候, 有时候会出错, 可以通过构建是添加 -V 参数来看到构建过程的大量信息, 包括 git 本地工作区的 HEAD 的指向, 编译的详细输出(mix compile的输出), 默认情况 Edeliver 会从拉取 HEAD 指向的分支来构建发布.

集群设置

在vm.args设置节点名称和 cookie

在配置文件 prod.exs 中配置 :kernel 模块的 :sync_nodes_mandator 和 :sync_nodes_optional 选项

use Mix.Config
config :kernel, distributed: [{:opencv_thumbnail_server, 5000, [
  :"[email protected]",
  :"[email protected]",
  :"[email protected]",
  :"[email protected]",
  :"[email protected]"
]}]
config :kernel, inet_dist_listen_min: 9100
config :kernel, inet_dist_listen_max: 9105
config :kernel, sync_nodes_mandatory: [
  :"[email protected]",
  :"[email protected]"
]
config :kernel, sync_nodes_optional: [
  :"[email protected]",
  :"[email protected]"
]
config :kernel, sync_nodes_timeout: 10000

上传到服务器的压缩包解压后, 需要修改,下面两个文件的节点名字和 distributed 配置.

./releases/0.0.1/sys.config
./releases/0.0.1/vm.args

其他管理命令

# 显示发布版本清单
$ mix edeliver show releases
# 停止线上的服务器
$ mix edeliver stop production
# 显示线上服务器当前运行的版本
$ mix edeliver version production
# 重启线上服务器
$ mix edeliver restart production
# 启动
$ mix edeliver start production

总结

大体上一个全新的部署过程就是三个命令

mix edeliver build release --V                # 构建发布包
mix edeliver deploy release to production --V # 部署(上传, 解压)到产品服务器
mix edeliver start production --V             # 启动产品服务器

如果上线前还需要部署到 staging 服务器进行测试, 或者灰度发布

热升级的过程为

mix edeliver build upgrade --with=0.1.3 --to=0.1.14 -V        # 构建一个从0.1.13到0.1.14的升级包
mix edeliver deploy upgrade to production --version=0.1.14 -V # 部署升级包0.1.14到线上

关于Git仓库的问题

我们一般在 develop 分支下进行开发, 而 edeliver 构建发布包的时候是去 master 分支拉取源码进行构建的, 因此我们在开发过程中需要注意版本和分支的管理.

这里我使用了 gitflow 这个工具来管理项目的版本和发布. 假设我们现在需要向线上发布一个新版本, develop 分支需要合并到master, 先修改 mix.exs 提升一下版本, 并提交, 然后:

git add .
git commit -m 'bump version to 0.1.14'
git push

发布

git flow release start 0.1.14
git flow release publish 0.1.14 # Push发布分支0.1.14到远程仓库,以便在构建主机上编译,打包和部署
git flow release finish 0.1.14
git push 
git push --tags
git checkout develop            # 回到 develop 继续开发

参考资料

Fast Continuous Deployment of an Elixir Gameserver
Real World Elixir Deployment
Edeliver API Reference