教程:创建合规流水线
您可以使用合规流水线,来确保特定的合规相关作业在群组中所有项目的流水线上运行。合规流水线通过合规框架应用于项目。
- 创建新群组
- 创建用于合规流水线配置的新项目
- 配置一个合规框架,应用于其他项目
- 创建一个新项目并应用合规框架
- 结合合规流水线配置和常规流水线配置
先决条件:
- 创建新的顶级群组的权限。
创建新群组
合规框架在顶级群组中配置。在本教程中,您将创建一个顶级群组:
- 包含两个项目:
- 用于存储合规流水线配置的合规流水线项目。
- 另一个项目,必须在其流水线中运行由合规流水线配置定义的作业。
- 具有适用于项目的合规框架。
创建新群组:
- 在左侧边栏中,选择 搜索或转到 > 查看我的所有群组 > 新建群组。
- 选择 创建群组。
- 在 群组名称 字段中,输入
Tutorial group
。 - 选择 创建群组。
创建一个新的合规流水线项目
现在您已准备好创建合规流水线项目。该项目包含合规流水线配置,应用于所有使用合规框架的项目。
创建合规流水线项目:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial group
群组。 - 选择 新建项目。
- 选择 创建空白项目。
- 在 项目名称 字段中,输入
Tutorial compliance project
。 - 选择 创建项目。
将合规流水线配置添加到 Tutorial compliance project
:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial compliance project
项目。 - 在左侧边栏中,选择 构建 > 流水线编辑器。
- 选择 配置流水线。
-
在流水线编辑器中,将默认配置替换为:
--- compliance-job: script: - echo "Running compliance job required for every project in this group..."
- 选择 提交更改。
配置合规框架
合规框架在新群组中配置。
配置合规框架:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial group
群组。 - 在左侧边栏中,选择 设置 > 通用。
- 展开 合规框架。
- 选择 添加框架。
- 在 名称 字段中,输入
Tutorial compliance framework
。 - 在 描述 字段中,输入
Tutorial compliance project
。 - 在 合规流水线配置(可选)字段中,输入
.gitlab-ci.yml@tutorial-group/tutorial-compliance-project
。 - 在 背景颜色 字段中,选择您喜欢的颜色。
- 选择 添加框架。
为方便起见,将新的合规框架设为群组中所有新项目的默认框架:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial group
群组。 - 在左侧边栏中,选择 设置 > 通用。
- 展开 合规框架。
- 在
Tutorial compliance framework
行中,选择 选项 ()。 - 选择 设置默认值。
创建一个新项目并应用合规框架
您的合规框架已准备就绪,因此您现在可以在群组中创建项目,他们会自动在其流水线中运行合规流水线配置。
创建一个新项目来运行合规流水线配置:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial group
群组。 - 选择 新建项目。
- 选择 创建空白项目。
- 在 项目名称 字段中,输入
Tutorial project
。 - 选择 创建项目。
在项目页面上,请注意出现了 Tutorial compliance framework
标记,因为它被设置为该群组的默认合规框架。
在没有任何其他流水线配置的情况下,Tutorial project
可以运行在 Tutorial compliance project
的合规流水线配置中定义的作业。
在 Tutorial project
中运行合规流水线配置:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial project
项目。 - 选择 构建 > 流水线。
- 选择 运行流水线。
- 在 运行流水线 页面上,选择 运行流水线。
请注意,流水线在 test 阶段运行名为 compliance-job
的作业。干得好,您已经运行了第一个合规作业!
结合流水线配置
如果您希望项目运行自己的作业以及合规流水线作业,则必须结合项目的合规流水线配置和常规流水线配置。
要结合流水线配置,您必须定义常规流水线配置,然后更新合规流水线配置来引用它。
要创建常规流水线配置:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial project
项目。 - 在左侧边栏中,选择 构建 > 流水线编辑器。
- 选择 配置流水线。
-
在流水线编辑器中,将默认配置替换为:
--- project-job: script: - echo "Running project job..."
- 选择提交更改。
将新项目流水线配置与合规流水线配置相结合:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial compliance project
项目。 - 在左侧边栏中,选择 构建 > 流水线编辑器。
-
在现有配置中,添加:
include: - project: 'tutorial-group/tutorial-project' file: '.gitlab-ci.yml'
- 选择 提交更改。
确认常规流水线配置与合规流水线配置相结合:
- 在左侧边栏中,选择 搜索或转到 并找到
Tutorial project
项目。 - 选择 构建 > 流水线。
- 选择 运行流水线。
- 在 运行流水线 页面上,选择 运行流水线。
请注意,流水线在 test 阶段运行两个作业:
compliance-job
project-job
恭喜,您已经创建并配置了合规流水线!
查看更多合规流水线配置示例。