本文主要介绍了Node.js应用如何构建并部署到ECS。
背景意义
如果您的业务使用Node.js进行开发、使用二进制的制品形式进行交付,并且制品最终会运行到ECS或者自有主机上,那么本文档可以帮您实现研发流程的协同自动化。
用户诉求
一般来说,用户使用主机部署场景如下:
-
对源代码进行一定的质量检测,比如单元测试,代码扫描。
-
将源代码构建成为可交付的制品,比如二进制文件。
-
对制品进行测试环境验证。
-
使用完成验证的制品进行线上部署。
上述活动需要有不同角色的参与:开发、测试、运维。如何保证不同参与者可以使用统一的交付流程来进行协作,是云效Flow交付流水线要解决的主要问题。
解决方案
结合云效持续交付流水线和主机部署的能力,为应用持续交付提供了很好的基础保障,如图:

开发者提交代码变更到代码库,云效在监听着代码库的变动,一旦代码发生变化,将自动触发云效持续部署流水线一次构建任务的运行,包括代码检查、构建、测试部署、测试验证和生产部署等过程。其中,在构建完之后,生成制品包并自动上传至仓库,在部署阶段(测试环境的部署和生产环境的部署)时,再从制品仓库中取得最新的版本,根据不同的部署策略通过主机部署到不同环境,这里资源可以是阿里云或者自建主机资源。
操作实践
模板构建并配置流水线
-
进入云效流水线Flow,点击右上角新建流水线,选择“Node.js·测试、构建、部署到阿里云ECS/自有主机”模板后点击创建。
-
创建流水线之后点击添加流水线源,选择Flow提供的示例代码源,并进行添加。在流水线源阶段,单击添加流水线源,在右侧弹出的面板中选择代码源标签页,代码源类型选择示例代码源,代码类型选择NodeJS,代码仓库自动填充为
https://atomgit.com/flow-example/node-expressjs.git,默认分支为master,然后单击添加。 -
修改Node.js构建任务,在构建物上传步骤增加一个打包路径,填入app-configs/bin/appctl.sh。这个文件存在于代码库中appctl.sh,用于后续的主机部署。在构建阶段的Node.js 构建任务中,配置构建物上传步骤:上传方式选择归档至云效公共存储空间(供后续任务拉取并部署),制品名称为
Artifacts_${PIPELINE_ID},打包路径添加两行:第一行填.,第二行填app-configs/bin/appctl.sh。 -
接下来配置主机部署任务,在制品下拉框中选择前面构建上传步骤归档的那个制品。选择需要部署的主机组(如无主机组,点击新建主机组并参考主机组管理),然后配置部署脚本:
-
下载路径:表示希望把构建上传任务中的压缩包下载到机器上的什么位置,在本例的值为:/home/admin/app/package.tgz
-
执行用户:希望以是哪个用户的身份进行脚本执行,本例的值为:root
-
部署脚本:在机器上执行脚本的具体内容,本例的值为:
mkdir -p /home/admin/application/ && tar -zxvf /home/admin/app/package.tgz -C /home/admin/application/ && cd /home/admin/application/ && ./app-configs/bin/appctl.sh restart。勾选部署时下载制品,制品名称填写Artifacts_${PIPELINE_ID},主机组选择测试示例主机组。部署脚本中依次执行 mkdir 创建目录、tar 解压制品包,并运行appctl.sh restart重启应用。部署策略暂停方式选择第一批暂停,分批数量设为 2。
-
添加人工审核机制
如果需要保证只有经过审批的制品才能进入部署环境,则还需要添加一个人工卡点,在上述流水线主机部署前添加如下任务:在流水线的流程配置页签中,单击构建阶段与部署阶段之间的+按钮,在弹出的任务选择面板中,选择工具分类下的人工卡点。在人工卡点任务中勾选需要添加的验证人并点击确定。在流水线的构建与部署阶段之间新增一个阶段,添加人工卡点任务。在右侧编辑面板中,将验证者方式设置为或签(一名审批人同意或拒绝即可),将验证者类型设置为成员(选择企业成员作为审核人员),然后单击验证人字段,在弹出的选择验证人浮层中勾选需要审批的企业成员并单击确定。
流水线运行
配置完毕,点击保存并运行触发流水线:在流水线流程配置页面完成各阶段配置后,单击保存并运行。本示例流水线依次包含源、测试(JavaScript代码扫描、Node.js单元测试)、构建(Node.js构建)、人工卡点及部署(主机部署)阶段,其中人工卡点任务的验证者方式设置为或签,验证人为 fangqian@test.aliyunid.com,超时时间为无超时时间。
扫描、单测及构建上传的任务自动完成,并停在了卡点上:流水线触发后依次执行流水线源、测试阶段(JavaScript代码扫描和Node.js单元测试)、构建阶段(Node.js构建)三个阶段,各阶段执行完成后,流水线运行到人工卡点阶段进入等待中状态。
点击验证通过,流水线会进入主机部署的任务,点击部署详情可以看到更多部署信息:主机部署弹窗显示部署状态为部署中,部署批次 1/2,暂停方式为第一批暂停,完成机器 0/2。第1批的主机 192.168.0.41 处于部署中状态,操作列提供日志链接。
点击日志,可以看到执行的日志详情:部署详情页面显示部署状态为部署成功,完成机器 2/2,部署批次 2/2。单击部署记录右侧的日志按钮,可打开部署日志对话框,查看对应机器的详细部署日志输出。
部署回滚
如果发布完成之后发现线上服务有问题,则需要快速回滚。云效Flow提供了通过历史版本直接进行回滚的能力。
在流水线运行页面点击部署历史,然后选择相应部署任务,便可以看到该部署任务所有部署成功记录。
点击版本#3的回滚,即可回滚到该版本。在目标版本的部署记录右侧操作列,单击回滚按钮。在弹出的回滚信息-主机部署对话框中,确认当前版本与回滚目标版本,设置发布暂停方式(如第一批暂停)和发布批次,然后单击确定。
流水线初次部署时页面上可能不显示部署历史页,此时尝试刷新页面可以解决。
通知
为了更好进行协作,Flow提供了通知能力在流水线不同的生命周期节点上进行通知。一般来讲开发团队会关心部署的成功和失败,那么可以将该事件推送到团队的钉钉群中,配置方式如下,点击添加插件,选择钉钉机器人通知,填入webhook地址,再次运行之后,就会收到相应的通知,具体请参考钉钉机器人发送群消息。在主机部署任务的编辑面板中,配置部署策略:暂停方式选择第一批暂停,分批数量设置为 2。在任务插件区域展开钉钉机器人通知插件,在webhook地址输入框中填入钉钉机器人的 webhook 地址,并将运行时机设置为失败和成功时触发通知。
结语
通过以上的操作流程,就可以建立一条协同多角色的流水线,参考以下文档了解更多内容: