基于GitLab的CI/CD系统重点记要

Posted 2023-02-18

参考技术A Gitlab是套功能完善的源码管理系统，平时用于公司内部各研发组的源码同步、问题跟踪、开发协同。Gitlab自带的CI/CD功能与Gitlab更简单、灵活的协同工作，也减小了日常维护的压力，因此，本文针对Gitlab的CI/CD功能做的要点分享。

基于GitLab的CI/CD系统由Gitlab与Gitlab-runner两个主要部分构成。

Gitlab源码库管理系统，提供基于Git的源码库管理、协作、权限等丰富的功能。

在Gitlab源码库的根目录中如果创建有`.gitlab-ci.yml`文件，相当于为当前源码库启用了CI/CD功能。

该文件用于控制CI/CD流程与行为，每次源码的提交、合并动作都会触发Gitlab执行当前操作分支上的该文件。

该文件中通过gitlab提供的关键字、预定义变量、脚本代码等等来规划pipeline和定义Job，实现依据条件控制不同Gitlab-Runner中的执行器进行需要动作，共同完成代码的编译、打包、发布等操作。

Gitlab-Runner运行在本地或远程目标机上的一个程序，作用是接收执行Gitlab的指令，比如编译、打包部署等等。

一个Gitlab可接入多个Gitlab-Runner，每个Runner可以注册多种相同或不同形式的“执行器”。

Runner与Gitlab联接需要通过Gitlab生成的Token，每个Runner对应且仅对应到一个唯一的Token。

Gitlab-Runner基于Go语言开发，可运行在多种系统平台。Gitlab-runner在Gitlab中有三种使用权限范围，第一种是全局共享，第二种是群组共享，第三种是项目特定。

Gitlab-Runner的作用是接收Gitlab指令，并控制与管理“执行器”的程序。具体动作执行则是由Runner派生出的“执行器”这个逻辑模块来完成，Runner支持多种“执行器”形式，有Shell，有Docker等等。

Gitlab-Runner的安装有两种方式，一种是直接安装到原生系统，另一种是以Docker容器方式进行安装。Runner安装完成后，需要执行Runner中的注册命令，建立与Gitlab的关联。

在注册过程中需要填入Gitlab服务器地址、Gitlab提供的Token、执行器形式，以及不同执行器的配置等等。

将Runner以原生系统方式进行安装（也可以以Docker形式安装），并在Runner注册时选择Docker执行器形式。

在注册过程中会要求指定一个Docker Image，该Docker Image是默认用于执行指令的实体（即在`.gitlab-ci.yml`中未指定Image时默认使用，也可以在Job中明确指定其它的Docker Image）。Runner注册完成后会在`/etc/gitlab-runner`中生成一个`config.toml`文件，如要修改Runner配置，可重新注册（重新注册原配置不会删除，原注册的执行器还保持有效，需要在Gitlab端删除）或修改该文件。另外，一个Runner实例可以配置多个同类型或不同类型的执行器。

执行器是用于Job执行不同的指令，因此执行器的环境需要依据Job的具体要求进行配置，比如用于Java构建，则执行器环境中需要支持jdk、maven等指令。由于本篇用的是Docker形式的执行器，因此在指定的DockerImage中要安装好JDK与MAVEN包（注：为了更好的利用自建的DockerImage，需要创建一个Docker私服，可以用Harbor或Nexus3来实现自定义的Docker Image的管理）。

每个Job都会重新启动一个新的容器，并且会自动完成源码库的下载（放在启动容器的`/build`目录中），并且这个不要求执行器镜像支持Git（原理不清楚，有清楚的欢迎评论区指教！），如何在Job中禁止下载原码还需要再学习（有清楚的欢迎评论区指教！）。

以下是`config.toml`文件及主要字段说明:

`.gitlab-ci.yml`文件必须在源码库的根目录中，该文件用于控制源码何时、何地、如何加工处理代码的配置脚本，并且需要符合`YAML`的格式与语法。

在该脚本中，通过`stages`关键字定义代码处理阶段，定义的上下顺序则是阶段执行次序。

然后就是各种各样的JOB定义，在Job中需要指明哪个阶段执行，在哪个执行器运行，什么条件下执行，以及执行的具体动作。多个不同的JOB可以关联到同一个阶段，实现并发处理不同的事务。

Gitlab为CI/CD提供了平台与机制，在微服务、异构系统开发时代CI/CD已成为必不可少的效率工具，也可以说是软件自动化生产线，但要用好和维护好一套CI/CD，需要有丰富的研发经验与广泛的系统知识。