本文将演示如何使用极狐GitLab Runer tags 来完成复杂 CI/CD 流水线的构建。
CI 流水线通常在开始的时候都比较简单—— 就是一个简单的作业来构建二进制文件并且将它推送到制品库或者某个生产环境上。变更频繁的软件需求就引入了更多的复杂性,比如添加更多的作业来在最终构建作业被执行之前,执行一些特定的检查或者审查一些输出。
当构建预期针对具有不同系统架构或资源需求的不同系统时,这些复杂性会呈指数级增加。这在支持多个部署平台的操作系统、移动应用程序或软件发行版等项目中很明显。为了满足这些类型环境中构建的不同需求,拥有多个满足所需要求的 Runner 是关键,这就是极狐GitLab Runner tag 的用武之地。如果你使用的是 Atlassian 的 Bamboo,它们被称为“代理功能”。
Runner tag 允许通过支持特定用例的 tag 来对 Runner 进行组织管理;然后使用这些 tag 来确保 CI 作业在满足其要求的 Runner 上运行。一项作业可能需要仅少数运行者可用的 GPU 资源;将作业标记到 Runner 的标签允许将其调度到具有 GPU 的 Runner 上。
Bamboo 上的 Agent 功能用于通过指定必须匹配或可用于在 Bamboo agent上运行的作业的二进制文件或自定义标识符来实现相同的功能。在这篇博文中,我们将研究如何将 Bamboo agent 功能转换为极狐GitLab Runner tag。
Bamboo 有不同的 agent 能力:
极狐GitLab 通过 tag 来识别 Runner 让流程变得更加简单,其中一些可以分配多个 tag 来表示它们可以为作业提供不同的功能。下面来演示如何在极狐GitLab Runner 中使用 tag。
在安装完极狐GitLab 实例以后进行 Runner 注册时,其中一个步骤就是提供一系列用逗号隔开的 tag 的名称。如果在 CI/CD 流水线中的某个 stage 中不提供任何 tag,你通常可以通过编辑 /etc/gitlab-runner/config.toml
文件来添加遗漏的 tag。
你还可以通过访问 Runner 的编辑界面并且更新 tags
字段来管理极狐GitLab Runner tag。你可以选择让 Runner 只执行有适当 tag 的作业,或者当没有标记 tag 的作业在运行时,Runner 可以执行这些没有 tag 标记的作业。Run untagger jobs
需要开启才能完成上面的功能。
.gitlab-ci.yml
文件中使用 tag
为了用特定的 Runner 运行作业,在作业的配置中添加相关的 tag 就行,比如:
build_ios:
image: macos-13-xcode-14
stage: build
script:
- bundle check --path vendor/bundle || bundle install --path vendor/bundle --jobs $(nproc)
- bundle exec fastlane build
tags:
- saas-macos-medium-m1
在上面的例子中,该作业仅在具有 M1 芯片并且标记为 saas-macos-medium-m1
的 macOS 设备上运行的 Runner 来构建 iOS 应用程序。
一个作业可以指定多个 tag 来针对不同范围的 Runner,特别是在软件开发生命周期中运行多个 Fleet Runner 的组织中。仅当找到具有该作业所标记的所有 tag 的 Runner 时,作业才会运行。比如,如果一个作业有 [linux,android,fastlane]
这些标签,一个具有 [android,fastlane]
或 [linux,android]
标签的 Runner 将不会执行该作业,因为没有完整的 tag 能够和 Runner 相匹配。
你可以使用变量来决定 tag 的值,从而来动态影响哪个 Runner 来选择哪个作业。比如:
variables:
KUBERNETES_RUNNER: kubernetes
job:
tags:
- docker
- $KUBERNETES_RUNNER
script:
- echo "Hello runner selector feature"
在这个例子中,只有具有 kubernetes
tag 的 Runner 才会执行作业。你还可以进一步的使用 parallel:matrix
关键字来处理更复杂的流水线。比如:
deploystacks:
stage: deploy
parallel:
matrix:
- PROVIDER: aws
STACK: [monitoring, app1]
- PROVIDER: gcp
STACK: [data]
tags:
- ${PROVIDER}-${STACK}
environment: $PROVIDER/$STACK
这个例子有三个并行执行的作业,每个作业都有不同的 tag,分别是 aws-monitoring
、aws-app1
、gcp-data
,这样就正好匹配到了三个不同的 Runner。
在极狐GitLab CI 配置中使用 tag 给了用户更多的灵活性,来决定何地以及如何正确构建你的应用程序,也让资源的使用更高效,因为这能够将稀缺资源限定到特定的 Runner 上,并且决定如何将 Runenr 分配到不同的作业上。
极狐GitLab 作为 GitLab 的发行版,专门为中国程序员和企业服务,也是一个一体化的 DevOps 平台,同样具有极狐GitLab CI/CD功能,用法和上面所示一样。