一、背景
如果你
1.使用Java进行开发
2.使用Jar/War的制品形式进行交付
3.制品最终会运行在ECS或者自有主机上
那么本文档可以帮助您实现研发流程的协同自动化。
二、用户诉求
一般来说,用户使用主机部署场景如下:
1.对源代码进行一定的质量检测,比如单元测试,代码扫描
2.将源代码构建成为可交付的制品,比如Jar/War
3.对制品进行测试环境验证
4.使用完成验证的制品进行线上部署
上述活动需要有不同角色的参与:开发、测试、运维。如何保证不同参与者可以使用统一的交付流程来进行协作,是云效Flow交付流水线要解决的主要问题。
三、云效解决方案
结合云效持续交付流水线和主机部署的能力,为应用持续交付提供了很好的基础保障,如图:
开发者提交代码变更到代码库,云效在监听着代码库的变动,一旦代码发生变化,将自动触发云效持续部署流水线一次构建任务的运行,包括代码检查、构建、测试部署、测试验证和生产部署等过程。其中,在构建完之后,生成制品包并自动上传至OSS仓库,在部署阶段(测试环境的部署和生产环境的部署)时,再从制品仓库中取得最新的版本,根据不同的部署策略通过主机部署到不同环境,这里资源可以是阿里云或者自建主机资源。
四、云效操作实践
接下来以一个 Java Spring Boot 的代码库为例,讲解如何进行构建并部署到阿里云 ECS 服务器。
2、配置代码库
创建流水线之后会自动弹出添加代码源的窗口,这里选择Flow提供的示例代码源,并进行添加
3、配置构建上传任务
修改一下“Java构建上传”的任务,增加一个打包路径,填入deploy.sh。这个文件存在于代码库中,其中包含了在ECS上进行应用启动的脚本,为了进行后续的主机部署,需要将这个文件也打入到压缩包中,在后续的主机部署任务中可以看到如何使用该deploy.sh。在该配置中指定了target/和deploy.sh两个路径,所以Flow会将这两个文件(夹)打包成为一个压缩包,并进行归档,在Flow中我们称之为制品,该制品也会在后续的主机部署任务中用到。
4、配置部署任务
接下来配置主机部署任务,在制品下拉框中选择“制品名称.default”,也就是前面的“Java构建上传”步骤归档的那个制品。为了配置主机组,需要先创建一个,点击“新建主机组”。
选择”阿里云ECS“,点击”新建服务授权”,跳转到阿里云,完成RAM授权,然后会自动跳回到Flow。此时再选择相应的地区,并选择需要部署的ECS,点击下一步,填写主机组名称,然后点击保存,完成主机组创建。新建的主机组会自动填入到流水线配置中。
接下来进行部署脚本的配置:
a.下载路径:表示希望把”构建上传”任务中的压缩包下载到机器上的什么位置,在本例的值为:/home/admin/app/package.tgz
b.执行用户:希望以是哪个用户的身份进行脚本执行,本例的值为:root
c.部署脚本:在机器上执行脚本的具体内容,本例的值为:
mkdir -p /home/admin/application/
tar zxvf /home/admin/app/package.tgz -C /home/admin/application/
sh /home/admin/application/deploy.sh restart
部署策略配置
a、暂停方式:希望一个主机组中的机器以什么样的暂停方式进行,比如第一批暂停,每批暂停,或者不暂停。推荐使用第一批暂停,在发布完第一批之后,对线上服务进行观察,如果没有异常,则可以继续其余批的发布
b、分批数量:希望主机组中的机器分为几批进行发布。比如一共4台机器,分两批,则每批同时发布2台机器。
5、添加人工卡点
为了保证经过审批的制品才能进入部署环境,需要添加一个人工卡点,这里假设这个环境是测试环境,需要有测试管理员来审批才能进入。
首先需要在企业中创建一个角色”测试管理员“,并将企业用户”张三”的角色设置为该角色。
然后回到流水线继续进行配置,在主机部署前面添加一个任务,搜索”人工卡点“,并按照角色进行配置:
以上演示了如何添加一个进入测试环境的卡点,添加生产环境的卡点也是类似的,这里不再赘述,可以类似的进行配置。
6、运行流水线
配置完毕,点击”保存并运行”触发流水线:
扫描、单测及构建上传的任务自动完成,并停在了卡点上:
普通人员无权限通过,切换到张三的账号之后,可以通过或者拒绝:
点击”验证通过“,流水线会进入主机部署的任务,点击”部署详情”可以看到更多部署信息:
点击查看日志,可以看到执行的日志详情:
日志显示部署成功,此时访问该主机的公网接口可以看到服务已经可以正常访问了:
$ curl http://4*.2**.1**.1*:****/Greetings from Spring Boot!
7、回滚
如果发布完成之后发现线上服务有问题,则需要快速回滚。云效Flow提供了通过历史版本直接进行回滚的能力。
在流水线运行页面点击”部署历史“,然后选择相应的部署任务,便可以看到该部署任务所有的成功部署记录
点击版本4的”回滚“,即可回滚到该版本
8、通知
为了更好的进行协作,Flow提供了通知能力在流水线不同的生命周期节点上进行通知。一般来讲开发团队会关心部署的成功和失败,那么可以将该事件推送到团队的钉钉群中,配置方式如下,点击”添加插件”,选择钉钉机器人通知,填入webhook地址,运行时机选择”失败“,”成功”
再次运行之后,就会收到相应的通知:
五、总结
通过以上的操作流程,就可以建立起来一个协同多角色的流水线。