Tekton Hub 配置

概述

本指南介绍 Tekton Hub 实例的基本配置,包括安装和核心系统设置。了解如何配置 Tekton Hub 部署的基础方面。

前提条件:从 v4.12.0 开始,内置 Tekton Hub 不再默认部署。本指南假设已先启用它;请参阅 启用内置 Tekton Hub。

重要:如果你通过 TektonConfig 部署了 Tekton Hub,请在 TektonConfig 资源中修改 catalog 配置,而不是直接编辑 ConfigMap。直接修改 ConfigMap 会被 Tekton Operator 控制器覆盖。

命名空间说明:在本指南中,<tekton-pipelines> 用作 Tekton Hub 命名空间的占位符。请将其替换为实际的命名空间名称。默认安装使用 tekton-pipelines 命名空间。

核心配置区域

本指南涵盖 Tekton Hub 配置的关键主题:

  • Catalog 刷新:自动资源同步
  • Categories:资源分类与组织
  • Hub Resolver:与 Tekton Pipelines 集成

Catalog 刷新配置

默认刷新间隔

默认情况下,Tekton Hub 每 30 分钟刷新一次 catalog,以从已配置的仓库中获取最新资源。

修改刷新间隔

可以通过修改 tekton-hub-api ConfigMap 中的 CATALOG_REFRESH_INTERVAL 设置来配置刷新间隔。

支持的时间单位:

  • s(秒):30s、60s
  • m(分钟):15m、30m、45m
  • h(小时):1h、2h、12h
  • d(天):1d、2d
  • w(周):1w、2w

示例配置:

apiVersion: v1
kind: ConfigMap
metadata:
  name: tekton-hub-api
  namespace: <tekton-pipelines>
data:
  CATALOG_REFRESH_INTERVAL: 30m

禁用自动刷新

如果要完全跳过自动刷新,请将间隔设置为空或 "0":

data:
  CATALOG_REFRESH_INTERVAL: "0"

Categories 配置

默认 Categories

Tekton Hub 提供以下标准 categories 用于资源组织:

  • Automation
  • Build Tools
  • CLI
  • Cloud
  • Code Quality
  • Continuous Integration
  • Deployment
  • Developer Tools
  • Image Build
  • Integration & Delivery
  • Git
  • Kubernetes
  • Messaging
  • Monitoring
  • Networking
  • Openshift
  • Publishing
  • Security
  • Storage
  • Testing
  • Script

添加自定义 Categories

你可以通过修改 tekton-hub-api ConfigMap 中的 CATEGORIES 部分来添加自定义 categories:

apiVersion: v1
kind: ConfigMap
metadata:
  name: tekton-hub-api
  namespace: <tekton-pipelines>
data:
  CATEGORIES: |
    - Automation
    - Build Tools
    - CLI
    - Cloud
    - Code Quality
    - Continuous Integration
    - Deployment
    - Developer Tools
    - Image Build
    - Integration & Delivery
    - Git
    - Kubernetes
    - Messaging
    - Monitoring
    - Networking
    - Publishing
    - Security
    - Storage
    - Testing
    - My Custom Category
    - Data Processing
    - Machine Learning

Categories 指南:

  • 使用清晰、具有描述性的名称
  • 遵循标题式大小写格式
  • 避免与现有 categories 重复
  • 保持名称简洁但有意义

应用 Categories 更改

更新 categories 后:

  1. 应用更新后的 ConfigMap:

    $ kubectl apply -f tekton-hub-api-configmap.yaml
  2. 刷新 Hub 配置:

    # Restart the API pod
    $ kubectl delete pod app=tekton-hub-api -n <tekton-pipelines>

在资源中使用 Categories

catalog 中的资源可以通过注解引用这些 categories:

metadata:
  annotations:
    tekton.dev/categories: "Build Tools,Continuous Integration"

Hub Resolver 配置

Hub resolver 使用户能够在 TaskRuns 和 PipelineRuns 中引用 Hub 资源。正确配置对于 catalog 资源解析至关重要。

前提条件

  • Tekton Pipelines v0.41.0 或更高版本
  • 已安装内置远程 resolvers
  • 已启用 Beta 功能(如果使用 beta resolver 功能)

启用 Hub Resolver

通过在 feature-flags ConfigMap 中设置 feature flag 来启用 Hub resolver:

apiVersion: v1
kind: ConfigMap
metadata:
  name: feature-flags
  namespace: <tekton-pipelines>
data:
  enable-hub-resolver: "true"

Hub Resolver 配置

通过 hubresolver-config ConfigMap 配置 Hub resolver 默认值:

apiVersion: v1
kind: ConfigMap
metadata:
  name: hubresolver-config
  namespace: <tekton-pipelines>
data:
  # Default catalog for tasks
  default-tekton-hub-catalog: "tekton-catalog-tasks"

  # Default catalog for pipelines
  default-tekton-hub-pipeline-catalog: "tekton-catalog-pipelines"

  # Default artifact hub catalogs
  default-artifact-hub-task-catalog: "tekton-catalog-tasks"
  default-artifact-hub-pipeline-catalog: "tekton-catalog-pipelines"

  # Default resource kind (task or pipeline)
  default-kind: "task"

  # Default hub type (artifact or tekton)
  default-type: "artifact"

自定义 Hub 端点

在大多数情况下,应保持默认的 TEKTON_HUB_API endpoint(http://tekton-hub-api.tekton-pipelines:8000/)不变。 仅当你明确需要与外部 hub API 集成时,才修改此 endpoint。

对于自定义 Tekton Hub 实例,请通过 resolver 部署中的环境变量配置 API endpoints:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: tekton-pipelines-remote-resolvers
  namespace: <tekton-pipelines>
spec:
  template:
    spec:
      containers:
      - name: controller
        env:
        # Custom Tekton Hub API endpoint
        - name: TEKTON_HUB_API
          value: "https://your-tekton-hub-api.example.com"

        # Custom Artifact Hub API endpoint (if using artifact type)
        - name: ARTIFACT_HUB_API
          value: "https://your-artifact-hub-api.example.com"

应用配置

更新 resolver 配置后:

  1. 应用 ConfigMap 更改:

    $ kubectl apply -f hubresolver-config.yaml
  2. 重启 resolver 部署:

    $ kubectl delete pod app=tekton-pipelines-resolvers -n <tekton-pipelines>

测试 Hub Resolver

使用一个简单的 TaskRun 测试 resolver 配置:

apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
  name: test-hub-resolver
spec:
  taskRef:
    resolver: hub
    params:
    - name: catalog
      value: "your-custom-catalog"  # Must match catalog name in Hub
    - name: type
      value: tekton
    - name: kind
      value: task
    - name: name
      value: echo-hello
    - name: version
      value: "0.1"

常见配置问题

Hub Resolver 问题

问题:无法通过 Hub resolver 解析资源

解决方案:

  1. 验证 Hub resolver 已启用:kubectl get cm feature-flags -n <tekton-pipelines> -o yaml
  2. 检查 resolver 配置:kubectl get cm hubresolver-config -n <tekton-pipelines>
  3. 确保 Hub 配置与 resolver 参数中的 catalog 名称一致

Catalog 刷新问题

问题:catalog 未自动更新

解决方案:

  1. 检查刷新间隔设置:CATALOG_REFRESH_INTERVAL
  2. 验证 catalog 仓库是否可访问
  3. 查看 API pod 日志中的同步错误
  4. 手动重启 API pod:kubectl delete pod app=tekton-hub-api -n <tekton-pipelines>

Categories 配置问题

问题:资源未出现在预期的 categories 中

解决方案:

  1. 验证 Hub 配置中是否存在该 category
  2. 检查资源注解是否与已配置的 categories 匹配
  3. 在更改 categories 后重启 API pod