Resolvers

Resolver 是 Tekton 中用于远程解析 Task 和 Pipeline 等资源的组件。Resolver 允许您从外部位置引用并获取资源,而无需直接在 Kubernetes 集群中定义这些资源。

为什么需要 Resolver

传统资源管理面临的挑战

在 CI/CD 系统中,跨团队和项目管理及共享资源会带来诸多挑战:

  • 版本控制:难以跟踪和管理 CI/CD 资源的版本
  • 共享:跨团队和组织共享资源的能力有限
  • 维护:难以更新和维护多个 Pipeline 使用的资源
  • 可发现性:难以发现和使用他人创建的资源
  • 一致性:确保不同环境中的资源定义保持一致

Tekton 的解决方案

Tekton Resolvers 通过以下方式应对这些挑战:

  • 远程解析:在运行时从外部位置获取资源
  • 版本管理:支持引用资源的特定版本
  • 集中式存储:支持将资源存储在中央代码库中
  • 动态获取:在需要时获取资源的最新版本
  • 灵活的来源:支持多个资源来源(Git、Bundles、HTTP 等)

优势

  • 可复用性:可以轻松地跨团队和项目共享及复用资源
  • 版本控制:可以对资源进行版本控制,并在源代码管理系统中跟踪
  • 减少重复:无需重复定义资源
  • 简化更新:资源只需在一个位置更新,所有使用者即可自动使用更新后的资源
  • 提高可发现性:可以在中央代码库中组织和发现资源
  • 一致性:确保不同环境中的资源定义保持一致

使用场景

Resolvers 适用于各种场景,包括:

  • 共享 Task 库:维护一个包含常用 Task 的中央代码库
  • CI/CD 模板:为团队提供标准化的 Pipeline 模板
  • 跨环境一致性:确保开发、预发布和生产环境中的资源定义保持一致
  • 组织标准:强制实施组织范围的 CI/CD 流程标准
  • 第三方集成:利用 Community 开发的 Task 和 Pipeline
  • 替代 ClusterTask:提供共享 Task,而无需使用集群范围的资源

约束和限制

  • Resolvers 需要访问外部资源位置的网络连接
  • 解析发生在创建 TaskRun/PipelineRun 时,而不是执行期间
  • 某些 Resolvers 可能需要额外的身份验证配置
  • 网络问题可能会影响远程解析资源的可用性
  • 使用外部资源时必须考虑安全因素

原则

解析过程

解析资源引用时:

  1. Tekton 从资源引用中识别 Resolver 类型
  2. 调用相应的 Resolver 获取资源
  3. Resolver 从外部位置检索资源
  4. 验证资源并将其转换为相应的 Tekton 资源
  5. 在 TaskRun 或 PipelineRun 中使用解析后的资源

资源引用

资源引用指定:

  1. 要使用的 Resolver 类型(git、bundle、hub 等)
  2. 资源的位置
  3. 可选参数,例如版本、分支或路径
  4. 必要时提供身份验证信息

配置示例

Git Resolver 示例

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: git-resolver-example
spec:
  taskRef:
    resolver: git
    params:
      - name: url
        value: https://github.com/tektoncd/catalog.git
      - name: revision
        value: main
      - name: pathInRepo
        value: task/git-clone/0.9/git-clone.yaml

Hub Resolver 示例

当前版本中,Hub Resolver 的目录资源由独立的 ArtifactHub 组件提供。有关目录配置和创作,请参阅 ArtifactHub Shim Catalog。

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: remote-task-reference
spec:
  taskRef:
    resolver: hub
    params:
    - name: catalog # optional
      value: catalog
    - name: type # optional
      value: artifact
    - name: kind
      value: task
    - name: name
      value: git-clone
    - name: version
      value: "0.6"

HTTP Resolver 示例

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: http-resolver-example
spec:
  taskRef:
    resolver: http
    params:
      - name: url
        value: https://raw.githubusercontent.com/tektoncd/catalog/main/task/git-clone/0.9/git-clone.yaml

内置 Resolvers

Git Resolver

Git Resolver 从 Git 仓库获取资源。

使用场景

  • 将 Tasks 和 Pipelines 与应用程序代码存储在同一仓库中
  • 将 CI/CD 资源与应用程序代码一同进行版本控制
  • 通过 Git 仓库跨团队共享资源

原则

Git Resolver:

  • 克隆指定的 Git 仓库
  • 检出指定的修订版本(分支、标签或提交)
  • 从指定路径获取资源
  • 支持通过 Kubernetes secrets 进行身份验证

Hub Resolver

Hub Resolver 从 DevOps Hub 目录获取资源。在 ACP DevOps 4.14 及更高版本中,默认的 Hub 后端是集群内的 artifacthub-shim 服务,该服务使用兼容 Artifact Hub 的 API。

使用场景

  • 在隔离网络集群中发现并使用 Curated Tasks 和 Pipelines
  • 访问由 artifacthub-shim 提供的目录
  • 采用经过充分测试和维护的资源作为标准

原则

Hub Resolver:

  • 连接到配置的 Artifact Hub API 端点
  • 按名称和版本检索指定资源
  • 支持不同的目录和版本
  • 使用 catalog 获取内置 Tasks,使用 catalog-pipelines 获取内置 Pipelines

HTTP Resolver

HTTP Resolver 从远程 HTTP 服务器获取资源。

使用场景

  • 从远程服务器获取资源
  • 访问自定义或私有资源
  • 利用现有 Web 服务进行资源解析

原则

HTTP Resolver:

  • 从远程服务器获取指定资源
  • 提供对自定义或私有资源的访问

查看已解析定义的源

当 PipelineRun 或 TaskRun 通过解析器获取其 Pipeline 或 Task 时,Tekton 会在 status.provenance.refSource 中记录该定义的来源。使用它可以回答“此运行使用了哪个提交或哪个摘要”。Tekton Chains 也可以在其生成的来源证明中捕获此信息。

  • enable-provenance-in-status 功能标志控制运行级别的 status.provenance.refSource,默认值为 true。当其值为 false 时,不会写入运行的 status.provenance。无论此标志的值如何,下面所述的每个步骤的 status.steps[].provenance 都会被记录。
  • 该字段在首次解析引用时写入一次,之后不会更新。
  • 使用内联 pipelineSpec / taskSpec,或使用未通过解析器的 pipelineRef / taskRef 的运行,不包含 refSource。
  • 对于通过解析器引用的 StepAction,源信息会按步骤记录在 TaskRun 中,位于 status.steps[].provenance.refSource 下。
字段描述
uri获取定义的源的标识
digest将摘要算法映射到已解析源摘要的映射
entryPoint定义在源中的位置(解析器提供该位置时)

每个内置解析器记录的信息如下:

解析器uridigestentryPoint
Gitgit+<repository URL>sha1:已解析提交的 SHA存储库中文件的路径
BundlesBundle 的镜像存储库(不含标签或摘要)按算法标识的镜像摘要Bundle 中资源的名称
Cluster/apis/<group>/<version>/namespaces/<namespace>/<kind>/<name>@<uid>sha256:资源内容的校验和未设置
HTTP请求的 URLsha256:下载内容的哈希值未设置
Hub用于从 Hub 获取资源的 URLsha256:下载内容的哈希值未设置

使用 kubectl 读取该字段:

kubectl get pipelinerun <pipelinerun-name> -n <namespace> -o jsonpath='{.status.provenance.refSource}'
kubectl get taskrun <taskrun-name> -n <namespace> -o jsonpath='{.status.provenance.refSource}'

对于通过 Git 解析的定义,该字段的结构如下:

status:
  provenance:
    refSource:
      uri: git+<repository URL>
      digest:
        sha1: <commit SHA>
      entryPoint: <path of the file in the repository>

参考