使用控制台为 Tekton 创建 Delivery Pipeline

配置 Delivery Pipeline 工具集成时，可以选择要创建的管道类型。

1. 如果您没有工具链，请选择模板以 创建工具链。 根据您所使用的模板，可能会有不同的字段可用。 请复查缺省字段值，如果必要，更改那些设置。

2. 如果您有一个工具链并要将此工具集成添加到其中，请从IBM Cloud控制台单击菜单图标>平台自动化>工具链。 在 "工具链 "页面，单击工具链打开其 "概述 "页面。 或者，在应用程序“概述”页面的“持续交付”卡上，单击查看工具链。 然后，单击概述。

3. 将 Delivery Pipeline 集成添加到工具链:

   a. 单击添加工具。

   b. 在“工具集成”部分中，单击 Delivery Pipeline。

4. 指定新管道的名称。

5. 选择 Tekton 以创建 Tekton Delivery Pipeline。 您可以在定义的 Kubernetes 集群上查看 Tekton 管道运行的输出结果，并支持配置管道定义仓库、管道触发器、管道运行位置和简单机密。

6. 如果您计划使用管道来部署用户界面，请选中在“查看应用程序”菜单中显示应用程序复选框。 管道所创建的所有应用程序都会显示在工具链“概述”页面上的查看应用程序列表中。

7. 单击创建集成，以向工具链添加 Delivery Pipeline。

   header['x-github-event'] == 'pull_request' &&
      (body.action == 'opened' || body.action == 'synchronize') &&
      body.pull_request.base.ref == 'main'

   header['x-github-event'] == 'push' && body.ref == 'refs/heads/main'

   header['x-github-event'] == 'push' &&
      body.ref == 'refs/heads/main' &&
      !body.head_commit.message.contains("skip run")

   header['x-github-event'] == 'issue_comment' &&
      body.action == 'created' && has(body.issue.pull_request) &&
      body.comment.body.contains('/lgtm')

   header['x-github-event'] == 'issues' &&
      body.action == 'opened' &&
      body.issue.labels.exists(label, label.name == 'urgent')

   header['x-gitlab-event'] == 'Merge Request Hook' &&
      (body.object_attributes.action == 'open' || body.object_attributes.action == 'update') &&
      body.object_attributes.target_branch == 'main'

   header['x-gitlab-event'] == 'Push Hook' && body.ref == 'refs/heads/main'

   header['x-gitlab-event'] == 'Push Hook' &&
      body.ref == 'refs/heads/main' &&
      !body.object_attributes.last_commit.message("skip run")

   header['x-gitlab-event'] == 'Note Hook' &&
      body.object_attributes.noteable_type == 'MergeRequest' &&
      body.object_attributes.action == 'create' &&
      body.object_attributes.note.contains('/lgtm')

   header['x-gitlab-event'] == 'Issue Hook' &&
      (body.object_attributes.action == 'open') &&
      body.object_attributes.labels.exists(label, label.name == 'urgent')

   (header['x-event-key'] == 'pullrequest:created' || header['x-event-key'] == 'pullrequest:updated') &&
       body.pullrequest.destination.branch.name == 'main'

   header['x-event-key'] == 'repo:push' && body.push.changes[0].new.name == 'main'

   header['x-event-key'] == 'repo:push' &&
      body.push.changes[0].new.name == 'main' &&
      !body.push.changes[0].commits[0].message("skip run")

   header['x-event-key'] == 'pullrequest:comment_created' &&
      body.comment.content.raw.contains('/lgtm')

   header['x-event-key'] == 'issue:created' &&
      body.issue.kind == 'bug'

过滤器

过滤器允许用户根据特定条件完善拉取请求。 过滤器字段目前支持在拉取请求中指定标签，从而根据标签的存在与否控制管道的执行。 不过，它不会在添加或删除标签时触发流水线；相反，它会在允许执行流水线之前验证 PR 的标签。

工作方式：

• 如果 PR 事件发生（如新增提交），管道会检查 PR 上的标签。
• 如果 PR 符合标签条件（例如具有 "已批准 "标签），管道就会运行。
• 如果 PR 不符合标签条件，管道将不会执行。

示例配置

下面的截图显示了一个例子，触发器是为标签“已批准”和“已审核”配置的。

• 只有当两个标签都存在时，才会触发 PR 管道。
• 如果缺少其中一个标签，管道将无法运行。

检查事件有效载荷

在编写用于事件过滤的 CEL 表达式时，您必须了解将对表达式进行评估的 webhook 有效负载的结构和内容。 您可以从管道运行详细信息页面检查现有运行的有效载荷。

要查看事件有效载荷，请转到管道运行详细信息页面并单击 显示上下文。 您可以查看触发管道运行的原始 webhook 有效载荷，并确认 CEL 表达式的相关字段是否与您想要的条件相匹配。

使用 API 为 Tekton 创建 Delivery Pipeline

1. 获取 IAM 不记名令牌。 或者，如果您正在使用 SDK，请 获取 IAM API 密钥，并使用环境变量设置客户机选项。

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. 确定要向其添加 Delivery Pipeline 工具集成的工具链的区域和标识。

3. 将 Delivery Pipeline 工具集成添加到工具链。

   curl -X POST \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools \
     -H 'Authorization: Bearer {iam_token}' \
     -H 'Accept: application/json` \
     -H 'Content-Type: application/json' \
     -d '{
       "tool_type_id": "pipeline",
       "parameters": {
         "name": "{tool_integration_name}",
         "type" : "tekton"
       }
     }'
   

   const CdToolchainV2 = require('@ibm-cloud/continuous-delivery/cd-toolchain/v2');
   ...
   (async () => {
      const toolchainService = CdToolchainV2.newInstance();
      const pipelinePrototypeModel = {
         toolchainId: {toolchain_id},
         toolTypeId: 'pipeline',
         name: {tool_integration_name},
         type: "tekton"
      };
      const pipelineTool = await toolchainService.createTool(pipelinePrototypeModel);
   })();
   

   import (
   	   "github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2"
   )
   ...
   toolchainClientOptions := &cdtoolchainv2.CdToolchainV2Options{}
   toolchainClient, err := cdtoolchainv2.NewCdToolchainV2UsingExternalConfig(toolchainClientOptions)
   createPipelineToolOptions := toolchainClient.NewCreateToolOptions({toolchain_id}, "pipeline")
   createPipelineToolOptions.SetName({tool_integration_name})
   createPipelineToolOptions.SetType("tekton")
   pipelineTool, response, err := toolchainClient.CreateTool(createPipelineToolOptions)
   

   from ibm_continuous_delivery.cd_toolchain_v2 import CdToolchainV2
   ...
   toolchain_service = CdToolchainV2.new_instance()
   pipeline_tool = toolchain_service.create_tool(
      name = {tool_integration_name},
      toolchain_id = {toolchain_id},
      tool_type_id = "pipeline",
      type = "tekton"
   )
   

   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.CdToolchain;
   import com.ibm.cloud.continuous_delivery.cd_toolchain.v2.model.*;
   ...
   CdToolchain toolchainService = CdToolchain.newInstance();
   CreateToolOptions createPipelineToolOptions = new CreateToolOptions.Builder()
      .name({tool_integration_name})
      .toolchainId({toolchain_id})
      .toolTypeId("pipeline")
      .type("tekton")
      .build();
   Response<ToolchainToolPost> response = toolchainService.createTool(createPipelineToolOptions).execute();
   ToolchainToolPost pipelineTool = response.getResult();
   

   下表列出并描述了上一步中使用的每个变量。

   用于将Delivery Pipeline工具与 API 集成的变量

   变量	描述
   {region}	工具链所在的区域，例如 us-south。
   {tool_integration_name}	工具集成的名称，例如 ci-pipeline。
   {toolchain_id}	要向其添加工具集成的工具链的标识。
   {iam_token}	有效的 IAM 不记名令牌。

4. 配置 Delivery Pipeline 以使用指定区域中的公共受管工作程序。

   curl -X POST \
      https://api.{region}.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines \
      -H 'Authorization: Bearer {iam_token}' \
      -H 'Accept: application/json` \
      -H 'Content-Type: application/json' \
      -d '{
         "id": "{pipeline_id}",
         "worker": { "id": "public" }
      }'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const tektonService = CdTektonPipelineV2.newInstance();
      const workerIdentityModel = {
         id: 'public',
      };
      const params = {
         id: {pipeline_id},
         worker: workerIdentityModel,
      };
      const res = await tektonService.createTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   createTektonPipelineOptions := pipelineSvc.NewCreateTektonPipelineOptions(
      {pipeline_id}
   )
   workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{
      ID: core.StringPtr("public"),
   }
   createTektonPipelineOptions.SetWorker(workerIdentityModel)
   tektonPipeline, response, err := pipelineSvc.CreateTektonPipeline(createTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   worker_identity_model = {
      'id': 'public',
   }
   response = pipeline_service.create_tekton_pipeline(
      id = {pipeline_id},
      worker = worker_identity_model
   )
   tekton_pipeline = response.get_result()
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()
      .id("public")
      .build();
   CreateTektonPipelineOptions createTektonPipelineOptions = new CreateTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .worker(workerIdentityModel)
      .build();
   Response<TektonPipeline> response = pipelineSvc.createTektonPipeline(createTektonPipelineOptions).execute();
   TektonPipeline tektonPipeline = response.getResult();
   

   下表列出并描述了上一步中使用的每个变量。

   用于使用 API 配置Delivery Pipeline的变量

   变量	描述
   {region}	工具链所在的区域，例如 us-south。
   {pipeline_id}	从创建管道工具集成的上一步返回的管道的标识。
   {iam_token}	有效的 IAM 不记名令牌。

有关 Delivery Pipeline API 的更多信息，请参阅 API 文档。

使用 Terraform 为 Tekton 创建 Delivery Pipeline

1. 要安装 Terraform CLI 并为 Terraform 配置 IBM Cloud 提供程序插件，请遵循 IBM Cloud® 上的 Terraform 入门 的教程。

2. 创建名为 main.tf 的 Terraform 配置文件。 在此文件中，添加配置以使用 HashiCorp 配置语言创建管道。 有关使用此配置语言的更多信息，请参阅 Terraform 文档。

   管道必须属于工具链。 您还可以通过 使用 Terraform 创建工具链。

   以下示例使用指定的 Terraform 资源创建工具链和管道。

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

   有关 ibm_cd_toolchain_tool_pipeline 和 ibm_cd_tekton_pipeline 资源的更多信息，请参阅 Terraform Registry 文档中的参数参考详细信息。

3. 初始化 Terraform CLI (如果需要)。

   terraform init
   

4. 创建 Terraform 执行计划。 此计划汇总了为创建工具链而必须运行的所有操作。

   terraform plan
   

5. 应用 Terraform 执行计划。 Terraform 将执行所有必需的操作来创建工具链。

   terraform apply
   

使用 API 删除 Delivery Pipeline

1. 获取 IAM 不记名令牌。 或者，如果您正在使用 SDK，请 获取 IAM API 密钥，并使用环境变量设置客户机选项。

   export CD_TEKTON_PIPELINE_APIKEY={api_key}
   

2. 确定要将 DevOps Insights 工具集成添加到的工具链的区域和标识。

3. 删除管道。

   curl -X DELETE \
     https://api.{region}.devops.cloud.ibm.com/toolchain/v2/toolchains/{toolchain_id}/tools/{pipeline_id} \
     -H 'Authorization: Bearer {iam_token}'
   

   const CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');
   ...
   (async () => {
      const pipelineSvc = CdTektonPipelineV2.newInstance();
      const params = {
         id: {pipeline_id},
      };
      const res = await pipelineSvc.deleteTektonPipeline(params);
   })();
   

   import {
      "github.com/IBM/continuous-delivery-go-sdk/cdtektonpipelinev2"
   }
   ...
   cdTektonPipelineOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}
   pipelineSvc, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineOptions)
   deleteTektonPipelineOptions := pipelineSvc.NewDeleteTektonPipelineOptions(
      {pipeline_id}
   )
   response, err := pipelineSvc.DeleteTektonPipeline(deleteTektonPipelineOptions)
   

   from ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2
   ...
   pipeline_service = CdTektonPipelineV2.new_instance()
   response = pipeline_service.delete_tekton_pipeline(
      id={pipeline_id}
   )
   

   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;
   import com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.model.*;
   ...
   CdTektonPipeline pipelineSvc = CdTektonPipeline.newInstance();
   DeleteTektonPipelineOptions deleteTektonPipelineOptions = new DeleteTektonPipelineOptions.Builder()
      .id({pipeline_id})
      .build();
   Response<Void> response = pipelineSvc.deleteTektonPipeline(deleteTektonPipelineOptions).execute();
   

下表列出并描述了上一步中使用的每个变量。

使用 Terraform 删除 Delivery Pipeline

1. 找到包含现有管道的 resource 块的 Terraform 文件 (例如，main.tf)。

   以下示例中的 resource 描述了现有管道。

   data "ibm_resource_group" "group" {
     name = "default"
   }
   
   resource "ibm_cd_toolchain" "my_toolchain" {
     name              = "terraform_toolchain"
     resource_group_id = data.ibm_resource_group.group.id
   }
   
   resource "ibm_cd_toolchain_tool_pipeline" "my_pipeline_tool" {
     parameters {
        name = "terraform-pipeline-integration"
     }
     toolchain_id = ibm_cd_toolchain.my_toolchain.id
   }
   
   resource "ibm_cd_tekton_pipeline" "my_tekton_pipeline" {
    worker {
        id = "public"
    }
    pipeline_id = ibm_cd_toolchain_tool_pipeline.my_pipeline_tool.tool_id
   }
   

2. 从 Terraform 文件中除去 ibm_cd_toolchain_tool_pipeline 和 ibm_cd_tekton_pipeline resource 块。

3. 初始化 Terraform CLI (如果需要)。

   terraform init
   

4. 创建 Terraform 执行计划。 此计划总结了为删除管道而必须运行的所有操作。

   terraform plan
   

5. 应用 Terraform 执行计划。 Terraform 将执行删除管道所需的所有操作。

   terraform apply
   

查看 TaskRun pod 的详细信息

要查看有关特定 TaskRun 的底层 Kubernetes pod 的信息，请单击 Task 名称，然后单击 Pod。

您可以查看 pod 的详细信息以及工作程序报告的任何相关事件。 此信息可帮助您调试特定故障或确定运行期间的耗用时间。