定义可引用的 CI/CD 配置文件中的输入参数

极狐GitLab 是一个一体化的 DevOps 平台,内置 CI/CD 功能。在极狐GitLab 15.11 中,我们引入了一项令人兴奋的新功能,允许用户为可包含的配置文件定义输入参数。 通过在 CI 模板中使用输入参数的功能,您可以将模板中的任何关键字替换为参数,包括阶段、脚本或作业名称。 例如,您可以向所有作业添加前缀,以更好地将它们与您要包含配置的流水线隔离。

学习极狐GitLab 的相关资料:

  1. 极狐GitLab 官网
  2. 极狐GitLab 官网文档
  3. 极狐GitLab 论坛
  4. 极狐GitLab 安装配置

这些输入参数可以针对每个配置文件声明为强制参数或可选参数,从而减少对全局变量的需求,并使 CI/CD 模板更加健壮和隔离。 输入参数的范围仅限于包含的配置,这意味着它们对流水线的其余部分没有影响。 这允许您声明和强制执行约束,例如通过强制模板输入。

这一功能开发是 CI/CD 组件目录长期路线图的第一个里程碑,这是一项新功能,允许用户搜索和重用具有适合其用例的特定参数的单一用途 CI/CD 配置单元。

在这篇技术博客文章中,我们将提供有关如何使用输入参数定义 CI/CD 模板以及如何在包含模板时使用它们的分步说明。

步骤1:创建一个模版YAML文档

第一步是创建一个模板 YAML 文档,该文档描述了模板可以使用哪些输入参数。 模板的第二部分是作业的定义,其中可能包括对使用插值格式 $[[ input-name ]] 的值的引用。 您应该在两个部分之间使用三条虚线。

下面是一个部署模板.yml 的示例:

spec:
  inputs:
    website:
    environment:
      default: test
---
deploy:
  stage: deploy
  script: echo "deploy $[[ inputs.website ]] to $[[ inputs.environment ]]"

在此模板中,我们定义了两个输入参数:网站和环境。 环境参数有默认值。 在内容部分,我们定义了一个插入输入参数的作业。

步骤 2:将模板包含在 CI 配置中

在主 CI 配置文件 .gitlab-ci.yml 中,引用模板并使用 input 关键字添加输入参数。

以下是包含带有输入参数的deploy-template.yml的示例:

include:
  - local: deploy-template.yml
    inputs:
      website: my-website.example.com

在此示例中,我们在项目中包含了本地模板。 注意:您可以将输入与其他包含类型一起使用,例如 include:project、include:template、include:remote。

在下面的示例中,我们使用输入为作业名称添加前缀,并使阶段也变得动态。

spec:
  inputs:
    website:
    environment:
      default: staging
    stage:
      default: test
    job_prefix:
      default: ""
---
"$[[ inputs.job_prefix ]]deploy":
  stage: $[[ inputs.stage ]]
  script: echo "deploy $[[ inputs.website ]] to $[[ inputs.environment ]]"
然后我们可以将其从 .gitlab-ci.yml 中包含到输入参数中:

include:
  - local: deploy-template.yml
    inputs:
      stage: deploy
      website: http://example.com
      environment: production
      job_prefix: "my-app-"

就是这样! 您已成功创建接受输入的 CI 模板并在流水线配置中使用它们。 通过使用带有输入的模板,您可以简化流水线配置并使模板更加模块化和可重用。

相关推荐
心灵彼岸-诗和远方10 小时前
Devops业务价值流:软件研发最佳实践
运维·产品经理·devops
A ?Charis1 天前
Gitlab-runner running on Kubernetes - hostAliases
容器·kubernetes·gitlab
秋说1 天前
开源代码管理平台Gitlab如何本地化部署并实现公网环境远程访问私有仓库
gitlab·源代码管理
大卡尔1 天前
Reviewbot 开源 | 为什么我们要打造自己的代码审查服务?
devops·code review·静态检查·工程效率
极小狐1 天前
驭码上新,AI Code Review、基于代码库的知识问答,让研发起飞
gitlab·devsecops·devops·极狐gitlab·安全合规
蚊子不吸吸2 天前
DevOps开发运维简述
linux·运维·ci/cd·oracle·kubernetes·gitlab·devops
思码逸研发效能2 天前
度量数据是人工凭感觉录入的,产生的偏差如何解决?
研发效能·devops·研发效能度量·研发管理
Databuff4 天前
JVM性能优化实战手册:从监控到调优策略
linux·运维·jvm·性能优化·自动化·devops
花开莫与流年错_5 天前
GitLab代码仓管理安装配置使用
运维·服务器·git·gitlab·配置·代码仓
AshCode5 天前
Docker远程管理和应用容器远程部署
docker·springboot·devops·开发效率·容器部署