(前言)
什么是GitLab CI ?
gitlab-ci全称是gitlab continuous integration,也就是基于gitlab的持续集成工具。中心思想是当每一次push到gitlab的时候,都会触发一次脚本执行,然后脚本的内容包括了测试,编译,部署等一系列自定义的内容。高版本的GitLab 自带了GitLab CI,所以不需要另外安装。
什么是GitLab-Runner?
GitLab-Runner是脚本执行的承载者,GitLab-CI事先注册好GitLab-Runner,再push 代码,对应的Runner就会执行你所定义的脚本。
环境
Centos7 GitLab(8.0版本以上,因为8.0版本之后才支持gitlab-ci) Docker Git GitLab-Runner
步骤
安装GitLab-CI这个不用安装了 装好GitLab就自带了
安装GitLab-Runner在centOS上 安装gitlab-ci-multi-runner
配置.gitlab-yml文件
一
安装GitLab-Runner
I.正常安装
(Runner服务器可以GitLab所在服务器,也可以是程序需要部署的服务器,也可以是其它服务器。)
$curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-ci-multirunner/script.rpm.sh | sudo bash $ yum install gitlab-ci-multi-runner
II.docker镜像安装
[1]先获取 gitlab-runner镜像
sudo docker pull gitlab/gitlab-runner:latest
[2]启动 gitlab-runner container
docker run -d --name gitlab-runner --restart always \ -v /srv/gitlab-runner/config:/etc/gitlab-runner \ -v /var/run/docker.sock:/var/run/docker.sock \ gitlab/gitlab-runner:latest
[3]注册runner(docker容器的话则是进入容器内执行以下指令)
gitlab-ci-multi-runner register
二
注册runner首先,进入到你的 gitlab 项目网页,找到 Settings -> CI/CI -> Runner Settings,然后找到项目对应的 url 和 token 然后它会询问一些必要的认证信息和配置信息,以下是个例子如下图:
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/ci )
https://your-gitlab-host/ci
Please enter the gitlab-ci tokenfor this runnerxxx
Please enter the gitlab-ci descriptionfor this runnermy-runner
INFO[0034] fcf5c619 Registering runner... succeeded
Please enter the executor: shell, docker, docker-ssh, ssh?docker
Please enter the Docker image (eg. ruby:2.1):maven:3-jdk-8
INFO[0037] Runner registered successfully. Feel free to start it, butif it'srunning already the config should be automatically reloaded!
然后刷新网页,如下图:可以看到Runner注册成功 另外,我们可以通过指令gitlab-ci-multi-runner list查询你注册的runner,用指令gitlab-ci-multi-runner status查看runner服务是否运行中。
三
提升构建速度
因为我们是Maven项目 配置中的maven:3-jdk-8实际就是docker image.每次构建因为都是在独立的container里,maven的.m2文件并不会被多次构建公用,所以每次maven都需要重新从maven库中下载依赖的jar包,这其实是没必要的。
由于我们在docker
container 里构建项目,我们可以使用docker的volume将.m2文件在多个container之间共享。
由此我们需要做一些变更,我们在Runner的服务器上打开/srv/gitlab-runner/config/config.toml文件。将maven
.m2目录加到volumes中。如下图
四、配置.gitlab-ci.yml
GitLab
CI的一切工作,都是由.gitlab-ci.yml来配置的。
详细文档可以参考这里(https://docs.gitlab.com/ee/ci/yaml/README.html#stage)
首先,在项目根目录下创建.gitlab-ci.yml文件(编辑完要提交到gitlab 才能生效):
配置完成后,当你在项目push代码到gitlab的时候,就会触发gitlab-ci,然后执行你定义的代码。可以在CI/CD →Pipelines 看到所有状态的Pipelines running表示正在运行,passed表示通过了。
ps:有个容易遇到的坑,当你卡在pending不动的时候,可以看看你的runner是否设置了'无tag标签也运行'
回到你的runner,点编辑,然后,勾选第二项Run untagged jobs
运行日志可以在这里查看:
五
在.gitlab-ci.yml配置里配置将构建好的文件推动到目标服务器
1.首先给GitLab-Runner的docker容器生成SSH秘钥ssh-key
生成的私钥放在.ssh/下,如图:
2.将生成的私钥id_rsa.pub文件里的公钥复制到目标服务器的/.ssh/authorized_keys里面,(如果没有authorized_keys这个文件的话则手动创建)
如下图:
1.首先将docker容器里生成的公钥作为变量存放在gitlab-ci环境中,如下图:
2.在runner容器里和目标服务器的/etc/ssh/ssh_config里进行如下配置
3.gitlab-ci.yml配置文件如下:
(图中test.sh脚本可根据实际应用情况编写,我是在项目的根目录建的脚本,因为整个项目的路径在runner执行器中执行的时候为临时路径 下图为test.sh)