GitLabCI

GitLab CI 简介

Pipeline

Pipeline 指的是流水线,在 GitLab 中,当有新提交推送到仓库中时,会自动触发流水线。流水线包含一组 Stage 和 Job 的定义,它们负责执行具体的逻辑。

在 GitLab 中,Pipeline 是通过仓库根目录下的 .gitlab-ci.yml 文件来定义的。

此外,Pipeline 在全局也可以配置运行镜像、全局变量和额外服务镜像。

Stage

Stage 字面上的意思是“阶段”。在 GitLab CI 中,至少需要包含一个 Stage,上面这张图中有三个 Stage,分别是 Stage1、Stage2 和 Stage3,不同的 Stage 是按照定义的顺序依次执行的。如果其中一个 Stage 失败,则整个 Pipeline 都将失败,后续的 Stage 也都不会再继续执行。

Job

Job 字面上的意思是“任务”。实际上,Job 的作用是定义具体需要执行的 Shell 脚本,同时,Job 可以被关联到一个 Stage 上。当 Stage 执行时,它所关联的 Job 也会并行执行。

以自动构建镜像为例,我们可能需要在 1 个 Job 中定义 2 个 Shell 脚本步骤,它们分别是:

费用

和 GitHub Action 一样,GitLab 也不能无限免费使用。对于 GitLab 免费账户,每个月有 400 分钟的 GitLab CI/CD 时长可供使用,超出时长则需要按量付费,你可以在 这里 查看详细的计费策略。

为示例应用创建 GitLab CI Pipeline

创建 .gitlab-ci.yml 文件

首先,将下面的内容保存到 .gitlab-ci.yml 文件内。

stages:
  - build

image: docker:20.10.16

variables:
  DOCKER_TLS_CERTDIR: "/certs"
  DOCKERHUB_USERNAME: "ketitongxue"

services:
  - docker:20.10.16-dind

before_script:
  - docker login -u $DOCKERHUB_USERNAME -p $DOCKERHUB_TOKEN

build_and_push:
  stage: build
  script:
    - docker build -t $DOCKERHUB_USERNAME/frontend:$CI_COMMIT_SHORT_SHA ./frontend
    - docker push $DOCKERHUB_USERNAME/frontend:$CI_COMMIT_SHORT_SHA
    - docker build -t $DOCKERHUB_USERNAME/backend:$CI_COMMIT_SHORT_SHA ./backend
    - docker push $DOCKERHUB_USERNAME/backend:$CI_COMMIT_SHORT_SHA

请注意, 需要将上面的 variables.DOCKERHUB_USERNAME 环境变量替换为你的 Docker Hub 用户名。

接下来,结合上面提到的概念,我简单介绍一下这个 Pipeline。

stages 字段定义了阶段,在这个 Pipeline 中,我们定义了一个 build 阶段。

image 字段定义了运行镜像,也就是说,GitLab CI 将会使用 docker:20.10.16 镜像来启动一个容器,并在容器内运行 Pipeline。

variables 字段定义了全局变量,其中, DOCKER_TLS_CERTDIR 变量是用来共享 Docker 证书的。DOCKERHUB\_USERNAME 变量是 Docker Hub 的用户名。

services 字段定义了一个额外的镜像,你可以把它理解成一个额外的容器,它将和 image 字段定义的容器相互协作,这两个容器可以相互访问。

before_script 定义了 Pipeline 最开始的 Shell 脚本, 它将会在 Job 运行之前执行。在这里,我们运行了 docker login 命令来登录到 Docker Hub,以便获得推送镜像的权限。请注意, $DOCKERHUB_USERNAME 变量的值来源于我们在 variables 定义的值, $DOCKERHUB_TOKEN 是一个在 GitLab UI 界面定义的变量,我们稍后会在 GitLab 平台添加。

build_and_push 字段定义了一个 Job,“build_and_push” 实际上是 Job 的名称,你也可以更改这个名称。build_and_push.stage 字段定义了 Job 所属的 Stage,也就是 build 阶段。build\_and\_push.script 字段定义了执行的具体的 Shell 脚本,它们是按顺序执行的。在这里,我们分别构建了 frontend 和 backend 的镜像,并将它们推送到 Docker Hub 仓库。其中, $CI_COMMIT_SHORT_SHA 是一个内置变量,它可以获取到当前的 short commit id。

创建 GitLab 仓库并推送

创建完 .gitlab-ci.yml 文件后,接下来我们将示例应用推送到 GitLab 上。首先,你需要通过 这个页面 来为你自己创建新的代码仓库,仓库名设置为 kubernetes-example。

创建完成后,将刚才克隆的 kubernetes-example 仓库的 remote url 配置为你刚才创建仓库的 Git 地址。

$ git remote set-url origin YOUR_GITLAB_REPO_URL

然后,将 kubernetes-example 推送到你的 GitLab 仓库中。在这之前,需要配置 SSH Key,可以参考 这个链接 来配置。

$ git add .
$ git commit -a -m 'first commit'
$ git branch -M main
$ git push -u origin main

创建 Docker Hub Secret

参考 GitHubAction 文档中的该部分内容

创建 GitLab CI Variables

创建完 Docker Hub Token 之后,我们就可以创建 GitLab CI Variables 了,也就是要为 Pipeline 提供 DOCKERHUB\_TOKEN 变量值。

进入 kubernetes-example 仓库的 Settings 页面,点击左侧的“CI/CD”,然后点击右侧的“Variables”展开菜单,接着点击“Add variable”来创建新的 Variables。

在弹出的输入框中,将 Key 填写为 DOCKERHUB\_TOKEN。

将 Value 填写为刚才我们复制的 Docker Hub Token,其他选项保持默认,点击“Add variable”创建变量值,如下图所示。

触发 GitLab CI Pipeline

到这里,准备工作已经全部完成了。请注意,如果你使用的是 GitLab SaaS 版, 那么你需要先绑定信用卡才能使用 CI/CD 的免费额度。

接下来我们尝试触发 GitLab CI Pipeline。

首先,向仓库提交一个空 commit。

$ git commit --allow-empty -m "Trigger Build"

然后,使用 git push 来推送到仓库, **这将触发 Pipeline**。

$ git push origin main

接下来,进入 kubernetes-example 仓库的“CI/CD”页面,你会看到我们刚才触发的流水线。

你可以点击流水线的状态(running)进入流水线详情页面。

在流水线的详情页面,我们能看到流水线的每一个 Job 的状态还有运行时输出的日志。

当工作流运行完成后,进入到 Docker Hub frontend 或者 backend 镜像的详情页,你将看到刚才 GitLab CI 自动构建并推送的新版本镜像。

到这里,我们便完成了使用 GitLab CI 自动构建镜像。最终实现的效果是,当我们向仓库推送新的提交时,GitLab 流水线将自动构建 frontend 和 backend 镜像, 并且每一个 commit id 都会对应一个镜像版本。