使用控制台为 Tekton 配置 Delivery Pipeline

1. 从工具链的“概述”页面，在 交付管道 卡上，单击 Delivery Pipeline 以打开 Tekton Delivery Pipeline“概述”页面。

2. 单击设置。 在 “定义”部分，完成以下任务：

   a. 指定包含 Tekton 管道定义和相关工件的 Git 存储库和 URL。 如果存储库不可用，请返回到“工具链概述”页面并添加存储库。

   b. 请在您的 Git 仓库中选择要使用的分支，或输入一个标签。

   c. 指定 Git 存储库中管道定义的路径。 可以引用同一存储库中的特定定义。 如果多个定义存储库与工具链集成，那么还可以添加这些存储库。

   d. 保存更改。

   将自动更新管道定义。

   计算的管道定义大小限制为 1 MB。 如果在保存或运行管道时迂到错误，那么可能需要减小管道定义的大小，或者将其拆分为多个管道。

3. 在 工作程序 部分中，选择要用于运行 Tekton 管道的 IBM 管理的共享工作程序或专用工作程序。 有关专用工作程序的更多信息，请参阅使用 Delivery Pipeline Private Worker。

   专用工作程序必须在 Tekton 管道所在的工具链中进行定义。

4. 在“环境属性”部分中，单击 添加 并选择属性类型以定义您自己的环境属性。 例如，可以定义 API_KEY 属性，该属性传递管道中所有脚本用于访问 IBM Cloud 资源的 API 密钥。 可以添加以下类型的属性：

   • 枚举: 具有可从用户定义的选项列表中选择的值的属性键。
   • 安全值：一个属性键，其单行值经过 AES-128 加密保护。 此值使用星号字符显示。 或者，如果工具链中提供了此类工具，那么可以单击密钥图标以从保险库集成 (例如 IBM Key Protect) 中选择密钥。
   • 文本值: 具有文本值的属性键，可以是单行或多行。 先前，单独的 文本区域 属性类型支持多行值。
   • 工具集成: 具有在运行时从工具链工具集成解析的值的属性键。 缺省情况下，该值是工具集成的 JSON 字符串表示。 可以通过为可选 JSON 过滤器提供值来检索对象的特定字段或子集。 例如，如果选择了 GitHub 集成，并指定了 JSON 过滤器 parameters.repo_url，当 PipelineRun 资源运行时，该值将反映工具集成中配置的 Git repo 的 URL。

   可以在 Tekton 管道资源中访问这些属性。 有关这些属性的更多信息，请参阅 Tekton Pipeline 环境和资源。

   可以锁定属性以防止其被覆盖。 尝试在运行时覆盖锁定的属性将导致运行请求被拒绝。 缺省情况下，锁定的属性不会显示在运行侧面板中，但可以通过启用“显示所有属性”选项以只读方式显示。

5. 单击保存。

6. 在“管道概述”页面上，单击 添加 以创建触发器，选择要添加的触发器类型，并使触发器与事件侦听器相关联。 可用事件监听器列表包含在管道代码仓库中定义的监听器。

   触发器基于 Tekton 触发器定义。 Git repo 触发器会使用与其映射的事件监听器，从传入的事件负载中提取信息，并创建 Kubernetes 资源。 这些资源将应用于 Tekton PipelineRun 资源。

   触发式管道运行将并行运行，除非您配置触发器以使用 Limit concurrent runs 选项对运行进行序列化。 启用此选项后，您可以限制此触发器可启动的同时运行次数。 例如，如果最大限制设置为 1，则一次只能运行一个用于此触发器的流水线，其他流水线将处于“等待”状态。 最多可排队20个运行任务（若使用 IBM 托管工作者则为5个），处于等待状态后后续请求将自动取消。 默认情况下，在使用 IBM 托管工作进程时，所有定时触发器均限制为仅允许一个并发执行实例

   当触发器超过其并发运行限制时，新的管道运行将处于“等待”状态，直到容量可用。 如果需要，可以修改这种行为，使只有最近的运行处于“等待”状态，而其他运行将自动取消。 例如，当短时间内触发多次构建时，若仅需构建最新提交，此功能 Git 对触发器而言颇具实用价值。 要启用此功能，可在触发器配置面板中使用“限制一次等待运行”切换按钮，也可通过 API 使用 limit_waiting_runs 属性进行设置 （请参阅 API 文档 ）。 请注意，此设置只适用于处于“等待”状态的运行，不影响正在运行的运行。

   手动触发器会在您单击 “运行管道”按钮并选择该触发器时运行。

   Git 仓库触发器 当指定的 Git 事件类型在指定的 Git 仓库和分支上发生时执行。

   您可以从 Tekton 管道资源中访问发送到触发 Git 器的 webhook 有效负载。 虽然确切的字段特定于 repo-specific，但 Webhook 有效内容的一般语法为 $(event.payloadFieldName)。 在创建 webhook 之前，您必须为对应的 Git 集成授权 Git 管理员访问权限。 要授权 Git 管理员访问权限，请 重新配置并保存集成 Git 设置。

   定时触发器 在 CRON 值定义的调度时间运行。 定时触发器 的 CRON 表达式基于 UNIX crontab 语法，并且是由五个时间和日期字段组成的序列: minute，hour，day of the month，month 和 day of the week。 这些字段由格式为 X X X X X 的空格分隔。 定时触发器的最大频率为每 5 分钟一次。 以下示例显示使用各种定时频率的字符串。

   • */5 * * * *-触发器每 5 分钟运行一次。
   • 0 * * * *- 该触发器在每整点开始时运行。
   • 0 9 * 1 MON-FRI-触发器在 1 月的每个工作日上午 9:00 运行。
   • 0 * * NOV,DEC 1-触发器在 11 月和 12 月的星期一每小时运行一次。

当配置了秘密设置的 POST 请求发送到通用网络钩子 URL 时，通用网络钩子触发器就会运行。 通用网络钩子触发器为 POST 请求提供唯一的网络钩子 URL。

由于用户界面 PipelineRun 不会在事件有效负载部分隐藏通用 webhook 有效负载值，请勿在有效负载中包含敏感数据。 而是通过使用触发器属性 (例如，密码或 API 密钥) 来保护通用 Webhook 所需的任何数据。

您可以使用以下任何方法来保护通用 Webhook 触发器，以使用 Git，Slack 传出 Webhook，Artifactory Webhook 等:

• 令牌匹配以比较已保存的令牌和 POST 请求中传递的令牌。 受支持的令牌源包括头，查询或有效内容。 令牌匹配由 GitLab Webhook 和 Slack 传出 Webhook 使用。
• 有效内容摘要匹配以通过将 HMAC 十六进制摘要与保存的令牌配合使用来比较从摘要有效内容生成的签名和散列。 受支持的签名源可能包含头，查询或有效内容。 用户必须指定摘要算法。 有效内容摘要匹配由 GitHub Webhook 使用。
• Tekton 任务验证要求用户在其 Tekton 任务中验证 Webhook 请求。

指定以下值以将通用 Webhook 触发器与 GitHub Webhook 配合使用:

• 保护: Payload Digest Matches
• 签名源: Header
• 头键名称: X-Hub-Signature
• 摘要算法: sha1。

指定以下值以将通用 Webhook 触发器与 GitLab Webhook 配合使用:

• 保护: Token Matches
• 令牌源: Header
• 头键名称: X-Gitlab-Token

指定以下值以将通用 Webhook 触发器与 Slack 传出 Webhook 配合使用:

• 保护: Token Matches
• 令牌源: Payload
• JSON 属性名称/表单键: token

以下示例显示如何将 curl 命令与使用 Token Matches 规则保护的通用 Webhook 配合使用:

  ![通用网络钩子示例](images/pipeline_tekton_generic_webhook.png){: caption="通用网络钩子" caption-side="bottom"}*

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
"somekey": "somevalue"
}'

要获取管道定义中的有效内容值，请使用派生自事件的值指定 Triggerbinding 参数:

apiVersion: tekton.dev/v1beta1
kind: TriggerBinding
metadata:
name: binding
spec:
params:
- name: somekey
value: $(event.somekey)

保存更改。

此外，通用网络钩子触发器还支持在网络钩子请求正文中传递属性。 这样就可以覆盖 PipelineRun 的属性（由 webhook 触发），或传递附加属性以补充 PipelineRun 中使用的管道/触发器属性。

如果需要在有效载荷属性中传递敏感数据（如密码或 API 密钥秘密），则应为此类属性使用属性类型 SECURE，这样它们就不会以纯文本形式显示在用户界面中。

此外，还可以在请求体中传递一个可选的描述，描述所触发的 PipelineRun，并在浏览器中查看 PipelineRun 详细信息时显示在用户界面中。

下面的示例展示了如何在通用网络钩子中使用 curl 命令，同时传递文本属性、安全属性和说明：

curl -X POST \
https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/588236be-749b-4c67-ae57-a561abbbc9a8/run/7e82880e-4223-4c98-8ca9-ef6df36bb6dc \
-H 'Content-Type: application/json' \
-H 'token: 48a0f92c0932890048596906a22ae189c48c5619fbcf9600' \
-d '{
  "description":"This text can be used to describe the PipelineRun that will be triggered by this request.",
  "properties":[
    {"name":"mytextprop","type":"TEXT","value":"my text value"},
    {"name":"mysecureprop","type":"SECURE","value":"mysecret"}
  ]
}'

为 Tekton 管道配置 Delivery Pipeline 触发器

您可以根据 Git repo 中的各种事件为 Tekton 管道配置触发器。 使用以下选项过滤 Git 触发器：

• 分支：当指定事件发生时，触发所选软件包特定分支的管道。
• 模式：当指定事件发生时，根据所选软件包中标签和分支名称的全局匹配触发管道。
• CEL 过滤器：当事件与提供的通用表达式语言（CEL）过滤器匹配时触发管道。

使用分支和模式选项指定事件，如 "commit push、"pull request opened"、"updated“或”closed。 此外，你还可以通过切换“包含草稿拉取请求事件”选项来指定拉取请求事件，以允许或跳过草稿拉取请求的管道触发器。 同样，你也可以使用 "包括来自分叉的拉取请求事件切换来指定是否允许管道触发来自分叉版本库的拉取请求。 此外，您还可以选择“标签筛选器”选项，根据筛选器表中用户定义的标准，启用基于拉取请求标签的筛选。

CEL 过滤器选项支持更高级的用例，例如与事件有效载荷中的其他字段进行匹配。 此选项支持推送事件、所有拉取请求事件、问题事件、问题评论事件、发布事件以及 GitHub 合并队列事件。 该选项也是通用网络钩子触发器的可选功能，可根据网络钩子有效载荷提供事件过滤功能。

   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'

使用控制台用户界面删除工具链

1. 从 IBM Cloud 控制台，单击菜单图标 > 平台自动化 > 工具链。
2. 在“工具链”页面上，单击某个工具链以打开其“概述”页面。 或者，在您应用的“应用详情”页面上，点击工具链名称。
3. 在“交付管道”部分，找到要删除的管道。
4. 单击该管道的菜单图标，然后单击删除选项。
5. 单击对话框中的删除，确认删除。

使用 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
   

通过命令行或应用程序接口触发管道

您可以使用 IBM Cloud CLI 或 curl 直接调用 API，从命令行触发管道。