联调环境快速部署——基于docker-compose的CI/CD实践

项目地址: github.com/xiongwilee/…

基本特性:

  1. 快捷部署多人nginx+php的开发测试环境,也可以扩展构建其他语言;

  2. 基于Docker和docker-compose,不依赖K8S等高级编排工具,成本低廉、部署简单;

  3. Docker内置集成jenkins,一键添加开发测试角色,无需额外配置;

  4. 支持微服务架构,适用于小公司or敏捷项目团队,也可以作为Docker学习入门的case

一、背景

在角色分工明确的团队里,什么样的条件才算是最优雅的联调和测试环境?在大厂里肯定都有很多高级的解决方案,比如这些:

大型团队的合作框架下,必须依赖更复杂的DevOps架构(参考:DevOps详解)。但对于成员不多、负责的Web项目工程量也不大的团队,面临的问题肯定也更单纯:

  1. 前后端角色工程解耦,开发环境分离;

  2. 工程师只关注业务逻辑本身,持续集成;

  3. 环境和角色一键创建、一键更新、一键销毁,环境之间不受影响;

即便是只有这些需求,在以往的“开发机”的联调环境里,一旦需要添加开发或者测试人员,或者需要更新nginx的配置,再或者需要更新PHP、Nodejs的版本……对于测试环境的维护来说都是很痛苦的。

二、快速开始

注意: 当前部署方案仅依赖:Docker,Docker-compose,git

1、下载代码

$ git clone https://github.com/xiongwilee/docker-compose-boilerplate.git 复制代码

2、添加测试角色demo

$ cd docker-compose $ sh build.sh -u demo -m admin:master 复制代码

此时,在app/会创建demo目录,在nginx/conf.d会创建demo.conf文件。

3、启动服务

$ docker-compose up -d 复制代码

此时,再执行docker-compose ps会发现创建了三个镜像。然后,配置hosts使sample.demo.testdomain.com指向当前机器,然后访问http://sample.demo.testdomain.com 返回phpinfo()信息,说明创建成功。

三、部署架构说明

TIPS: 这个方案仅适用于小公司or敏捷项目团队联调测试环境的部署,同时也可以作为Docker学习入门的case,并不适用于有一定规模的生产环境。

在“开发机”上仅仅安装docker、docker-compose、git之后就能跑起来Nginx、PHP的应用,当然得益于docker容器化的思想。其实这个的实现也仅仅利用了容器化的这个特性,最终docker-compose打包的整个服务会长驻内存,无需太多的管理成本。

最终的实现还具备两个特点:

  1. 基于这个实现的boilerplate你可以轻易的迁移到其他项目,以及其他语言;

  2. 每个sample管理每个应用的仓储地址、环境变量配置、更新代码后的钩子等操作;

其实现原理为:通过脚本文件,管理docker-compose隐射到宿主机的配置、源码,同时将docker-compose暴露出来以实现服务的管理。架构图如下:




1、docker-compose配置文件:docker-compose.yml

先看docker-compose的配置文件docker-compose.yml(篇幅原因,删掉了一部分配置):

version: '3' services:     # 所有的PHP环境构建在app容器里     php:         build: ./php         expose:             - "9000"     # nginx容器     nginx:         build: ./nginx         # 端口映射         ports:             - "80:80"         # 依赖关系声明,先跑php所有服务         depends_on:             - "php"     # jenkins容器     jenkins:         image: jenkins:latest         ports:             - "8080:8080"             - "50000:50000" 复制代码

这其实就是一个普通的PHP开发环境示例:可以看到就phpnginxjenkins三个基本容器,除了jenkins,其他的容器均使用Dockerfile(build配置)来构建。

2、构建脚本:build.sh

由于在docker中实现了nginx配置文件及php源码文件的映射到宿主机,需要通过管理宿主机上文件就可以管理代码的发布和部署了,build.sh就是用来做这件事情的。

当然了,如果需要在部署代码完成之后,做重启、编译等操作,通过sample目录下的钩子就可以实现了。

具体实现可以参考build.sh源码。

四、详细配置

1、开发测试环境域名配置

nginx/conf.d/sample修改测试环境域名,示例中使用的testdomain.com改成自己的测试环境域名即可。

另外,建议把测试域名泛解析到部署这台服务的机器。

2、docker-compose.yml配置说明

docker-compose的配置文件基本不需要修改,只需要关注:nginx是80端口映射到80端口,jenkins是8080端口,而php-fpm的9000端口不对外开放即可。

当然了,如果php环境需要安装依赖,就需要修改./php/Dockerfile。此外,如果需要添加其他的语言环境,就需要添加一个容器的声明。

3、模块配置

1)部署脚本build.sh

业务模块的配置基本是通过部署脚本build.sh来操作的。执行./build.sh提示如下:

Example:   ./build.sh -u xiongwilee -m php:online,service:online Usage:   -u 必填,角色名                       示例:default   -m 选填,要更新代码的业务模块         示例:php:online,service:online   -e 选填,更新业务模块对应的环境变量   示例:php:true,service:false   -d 选填,删除角色                     示例:default 复制代码

2)PHP模块

新增角色实时上是根据php/sample目录创建了一个角色名对应的文件夹。在sample里只有四个文件:

a. 仓储配置
  • .gitaddress:声明当前模块的远程仓储地址

b. 钩子
  • on_add.sh:创建角色时下载PHP模块代码完成之后的回调钩子,用已更新环境变量等文件,执行./build.sh -u {name}会被调用

  • on_upd.sh:某个模块更新完成之后的回调钩子,用以编译、重启服务等操作,执行./build.sh -u {name} -m web:master会被调用

  • on_env.sh:更新环境变量的钩子,执行./build.sh -u {name} -m web:master -e web:true都会被调用。

c. 示例目录app/sample/sample

在sample目录下还有个sample目录,这个是一个php模块示例;新增角色之后访问sample.{name}.testdomain.com就可以来测试是否成功新增。

3)Nginx配置

a. nginx/conf.d目录

和php/sample目录一样,在nginx/conf.d下也有个sample文件,这个也是在新增角色时使用的示例配置文件。注意,新增角色会把sample中的${name}替换成当前角色名。

b. nginx/log目录

nginx/log目录及nginx所有日志文件的宿主机映射目录。

4)Jenkins配置方案

jenkins默认开启8080端口,你可以直接通过http://jenkins.testdomain.com:8080访问jenkins服务。具体初始化过程这里不详述。

a. 安装插件获取当前用户名

在通过Jenkins执行build.sh脚本时,上文提到的角色名怎么获取呢?其实就是jenkins的用户名,你可以通过创建多个jenkins的用户来创建测试环境角色。

参考jenkins插件-Build User Vars Plugin简单说明安装jenkins插件。

安装完成之后就可以通过BUILD_USER环境变量获取当前jenkins的用户名了(当然了,新建jenkins用户的用户名最好是拼音或英文)。

b. Docker镜像中的Jenkins与宿主机通信

由于jenkins存在Docker镜像中,每次jenkins操作需要执行build.sh都需要使镜像中的jenkins与宿主机通信。这里使用的方法是,在jenkins的镜像添加到宿主机的信任关系。

然后就可以通过ssh apple@{jenkins内网IP} "sh build.sh"来直接执行宿主机里的脚本了(这里肯定还有更优雅的方法)。

c. 添加job

添加一个任务后只需要配置两项:

  1. general:“参数化构建过程”:

    • 选择 "String Parameter",添加"web"、"web-fe"、"service"字段

    • 选择"Boolean Parameter",添加"web_env"、“service_env”字段。

  2. 构建:"Execute Shell":

echo "正在将 web-fe:${web_fe},web:${web},service:${service}  部署到 ${BUILD_USER_ID} 环境" ssh apple@{jenkins内网IP} "sh ~/docker-compose/build.sh -u ${BUILD_USER_ID} -m web-fe:${web_fe},web:${web},service:${service} -e web:${web_env},service:${service_env}"; 复制代码

这样,通过这个任务就可以直接在jenkins中执行宿主机中的build.sh脚本,从而实现新增角色、更新代码的操作了。

最后,如果需要在PHP的服务基础上集成其他语言的服务,比如Nodejs,涉及到的改动有:

  1. 添加Nodejs镜像:docker-compose.yml

  2. 添加部署任务:build.sh

    • 创建及删除角色流程

    • 部署流程

  3. nginx配置文件示例:nginx/conf.d/sample

五、贡献

欢迎提供其他更专业的思路,欢迎提issue、fork;也可以邮件联系:xiongwilee[at]foxmail.com


作者:Wilee
链接:https://juejin.im/post/5b7952e7e51d4538c17dd75b
来源:掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。


打赏 支付宝打赏 微信打赏

未经允许不得转载!

评论列表 0

访客
取消