Alauda DevOps Artifact Hub Shim Docs
  • 简体中文

    • 向 Selector 添加自定义 Task 镜像

    本指南介绍如何为 UI 中 Task 表单里的 image 参数配置 selector 选项，涵盖以下两种场景：

    • 为 Hub Tasks 添加镜像
    • 为 你自己的 namespace 中的 Tasks 添加镜像

    目录

    功能概述使用场景前提条件场景 A：为 Hub Task selector 添加镜像1. 从 Task 描述符中查找 label selector2. 在 kube-public 中创建 ConfigMap3. 应用并验证场景 B：为你自己的 Task selector 添加镜像1. 在 Task 上配置 style.tekton.dev/descriptors2. 在 kube-public 中创建匹配的 ConfigMap3. 应用并验证维护建议

    功能概述

    • 每个 selector 选项都来自一个 ConfigMap，其中 data.name 作为标签，data.image 作为值。
    • 特定于 Task 的标签（例如 catalog.tekton.dev/tool-image-python）可让 UI 将 ConfigMap 匹配到正确的 Task 参数。
    • UI 会使用 Task 注解中指定的 namespace（例如 kube-public），并通过 Task 描述符中定义的 label selector 进行查询，然后根据结果渲染 selector。

    使用场景

    • 为某个 Task selector 添加自定义 registry mirror 镜像。
    • 在现有 selector 选项之外引入新的运行时 minor 版本。
    • 为自定义 Task 提供一个加固过的镜像选项。

    前提条件

    • 已安装 Tekton Pipelines。
    • 你可以在 kube-public 中创建 ConfigMap。
    • 你可以在目标 Task 上设置 style.tekton.dev/descriptors（Hub Tasks 已经提供；自定义 Tasks 需要你自行添加）。

    场景 A：为 Hub Task selector 添加镜像

    当你要扩展一个 Hub Task 的 selector 时，请使用此路径。

    1. 从 Task 描述符中查找 label selector

    在 Task 上找到 style.tekton.dev/descriptors 注解，并查找其 path 指向 image 参数的条目。

    以 urn:alm:descriptor:expression:props.options:api 结尾的描述符包含一个 labelSelector=... 查询；其中的 label key 必须存在于你的 ConfigMap 上。

    在下面的示例中，你需要在 kube-public 命名空间中创建一个带有 catalog.tekton.dev/tool-image-python 标签的 ConfigMap。

    kind: Task
metadata:
  name: python
  labels:
    app.kubernetes.io/version: "0.1"
  annotations:
    style.tekton.dev/descriptors: |
      - path: params.PYTHON_IMAGE
        x-descriptors:
          ...
          - urn:alm:descriptor:expression:props.options:api:/kubernetes/${context.cluster}/api/v1/namespaces/kube-public/configmaps?labelSelector=catalog.tekton.dev%2Ftool-image-python
          ...

    下面的示例展示了 image selector 使用的描述符字段。

    2. 在 kube-public 中创建 ConfigMap

    使用该 label key 创建一个 ConfigMap。

    默认 Task 会随附带标有 catalog.tekton.dev/source: system 的 ConfigMap，用于表示平台提供的条目。请勿修改或删除这些条目，你的自定义 ConfigMap 也不应包含此标签。

    apiVersion: v1
kind: ConfigMap
metadata:
  name: tekton-task-python-custom
  namespace: kube-public
  labels:
    catalog.tekton.dev/tool-image-python: "3.10"
data:
  name: "Python 3.10"
  image: "registry.example.com/tekton/python:3.10"

    3. 应用并验证

    kubectl apply -f tekton-task-python-custom.yaml
# configmap/tekton-task-python-custom created

kubectl -n kube-public get configmap -l catalog.tekton.dev/tool-image-python=3.10
# NAME                             DATA   AGE
# tekton-task-python-custom        2      15s

    打开 Task 表单；此时 selector 应包含 Python 3.10，并将 image 设置为 registry.example.com/tekton/python:3.10。

    场景 B：为你自己的 Task selector 添加镜像

    当你可以控制 Task 定义，并且需要同时配置描述符和 ConfigMap 时，请使用此路径。

    1. 在 Task 上配置 style.tekton.dev/descriptors

    image selector 的示例 Task 描述符如下：

    apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: python
  labels:
    app.kubernetes.io/version: "0.1"
  annotations:
    style.tekton.dev/descriptors: |
      - path: params.PYTHON_IMAGE
        x-descriptors:
          - urn:alm:descriptor:label:en:PYTHON_IMAGE
          - urn:alm:descriptor:description:en:The used Python image.
          - urn:alm:descriptor:com.tectonic.ui:select:image
          - urn:alm:descriptor:expression:props.options:api:/kubernetes/${context.cluster}/api/v1/namespaces/kube-public/configmaps?labelSelector=catalog.tekton.dev%2Ftool-image-python-custom
          - urn:alm:descriptor:props:select:allowCreate
          - urn:alm:descriptor:expression:props.options:path:items
          - urn:alm:descriptor:expression:props.options:label:path:data.name
          - urn:alm:descriptor:expression:props.options:value:path:data.image
          - urn:alm:descriptor:com.tectonic.ui:validation:required
spec:
  params:
    - name: PYTHON_IMAGE
      description: Image used for Python steps.
      type: string
  steps:
    - name: python-script
      image: $(params.PYTHON_IMAGE)
      script: |
        #!/bin/sh
        # Define your task script

    描述符条目及其含义：

    Descriptor entry用途示例备注
    path指向将被渲染为 selector 的参数。params.PYTHON_IMAGE
    urn:alm:descriptor:label:en表单中显示的英文字段标签。PYTHON_IMAGE
    urn:alm:descriptor:description:en该字段的英文帮助文本。The used Python image.
    urn:alm:descriptor:com.tectonic.ui:select:image将该字段渲染为 image selector。无需更改。
    urn:alm:descriptor:expression:props.options:api用于获取 selector 选项的 API（namespace + label selector）。/kubernetes/${context.cluster}/api/v1/namespaces/kube-public/configmaps?labelSelector=catalog.tekton.dev%2Ftool-image-python-custom在此示例中，会获取 kube-public 中带有 catalog.tekton.dev/tool-image-python-custom 标签的 ConfigMap。
    urn:alm:descriptor:props:select:allowCreate除 selector 选项外，还允许手动输入。
    urn:alm:descriptor:expression:props.options:path指向 API 响应中的列表路径。urn:alm:descriptor:expression:props.options:path:items在此示例中使用的是 List API，因此值取自 items。
    urn:alm:descriptor:expression:props.options:label:path从条目中读取 selector 显示文本。urn:alm:descriptor:expression:props.options:label:path:data.name在此示例中，值取自 ConfigMap 的 data.name。
    urn:alm:descriptor:expression:props.options:value:path从条目中读取 selector 值（image）。urn:alm:descriptor:expression:props.options:value:path:data.image在此示例中，值取自 ConfigMap 的 data.image。
    urn:alm:descriptor:com.tectonic.ui:validation:required将该字段标记为必填。

    上面的描述符表列出了 image selector 使用的字段。

    2. 在 kube-public 中创建匹配的 ConfigMap

    使用与你的描述符查询相同的 label key。对于自定义 Tasks，建议使用一个不会与默认 Task selector 冲突的 label key，以避免在 Hub Tasks 中意外显示。

    默认 Task 会随附带标有 catalog.tekton.dev/source: system 的 ConfigMap，用于表示平台提供的条目。请勿修改或删除这些条目，你的自定义 ConfigMap 也不应包含此标签。

    apiVersion: v1
kind: ConfigMap
metadata:
  name: custom-task-python-3-13
  namespace: kube-public
  labels:
    catalog.tekton.dev/tool-image-python-custom: "3.13-team"
data:
  name: "Python 3.13 (Team Edition)"
  image: "registry.example.com/internal/python:3.13"

    你也可以将 ConfigMap 放在你选择的其他任意 namespace 中；你只需要确保 ConfigMap 的 namespace 与 Task 的 style.tekton.dev/descriptors 注解中指定的 namespace 相同。 例如，你可以按如下示例设置 Task 的注解，请将 <NAMESPACE> 替换为你的 namespace。

    kind: Task
metadata:
  name: python
  labels:
    app.kubernetes.io/version: "0.1"
  annotations:
    # replace <NAMESPACE> with your namespace
    style.tekton.dev/descriptors: |
      - path: params.PYTHON_IMAGE
        x-descriptors:
          ...
          - urn:alm:descriptor:expression:props.options:api:/kubernetes/${context.cluster}/api/v1/namespaces/<NAMESPACE>/configmaps?labelSelector=catalog.tekton.dev%2Ftool-image-python-custom
          ...

    3. 应用并验证

    kubectl apply -f custom-task-python-3-13.yaml
# configmap/custom-task-python-3-13 created

kubectl -n kube-public get configmap -l catalog.tekton.dev/tool-image-python-custom=3.13-team
# NAME                             DATA   AGE
# custom-task-python-3-13          2      15s

    打开你的 Task 表单；selector 应列出 Python 3.13 (Team Edition)，并将 image 设置为 registry.example.com/internal/python:3.13。

    维护建议

    • 通过编辑并重新应用其 ConfigMap 来更新自定义选项。
    • 通过仅删除你的自定义 ConfigMap 来弃用某个选项；保留所有带有 catalog.tekton.dev/source: system 标签的 ConfigMap 不变。