为 Tekton Hub 编写 Tasks
目录
概述Tekton Hub 要求Task 与 ClusterTask从 ClusterTask 迁移Hub 特定元数据必需标签Hub 所需注解Hub 参数标准参数类型Hub 特定参数要求Hub 最佳实践容器镜像要求Hub 的 Results 和 WorkspacesHub 分类和标签标准分类有效的标签使用Hub 验证要求错误处理标准Hub Tasks 的安全性Hub 安全要求Hub 测试要求必需的测试文件Hub 验证检查清单Hub Task 模板文档要求Hub 文档标准Hub 发布检查清单✅ Hub 合规性✅ 质量标准概述
本指南介绍了为 Tekton Hub 目录创建可用 Tasks 的具体要求和最佳实践。内容重点涵盖 Hub 特有的元数据、验证和标准。
Tekton Hub 要求
Task 与 ClusterTask
⚠️ 重要:在
Tekton Pipelinesv1.0+ 中,ClusterTask已弃用并移除。请不要使用ClusterTask。
Task:Hub目录中唯一支持的资源类型ClusterTask:在Tektonv1.0+ 中已❌ 移除 - 不会工作
从 ClusterTask 迁移
Hub 特定元数据
必需标签
Hub 所需注解
Hub 参数标准
参数类型
Tekton Hub 支持三种参数类型:
- string:单个文本值(默认)
- array:字符串值列表
- object:包含键值对的 JSON 对象
Hub 特定参数要求
- 清晰的描述:所有参数都必须提供有意义的描述,以便用于
HubUI - 合理的默认值:尽可能提供默认值,以改善用户体验
- 类型安全:使用适当的类型以防止运行时错误
Hub 最佳实践
容器镜像要求
- 使用官方且可信的容器镜像
- 固定特定版本,而不是使用
latest标签 - 确保镜像可在受支持的平台上运行(
linux/amd64、linux/arm64) - 定期更新基础镜像以增强安全性
Hub 的 Results 和 Workspaces
- Results:必须提供清晰的描述,以便用于
Hub文档 - Workspaces:将可选工作区标记为
optional: true - 描述:所有 Workspaces 和 Results 都必须提供描述
Hub 分类和标签
标准分类
- Build Tools
- Testing
- Deployment
- Security
- Integration & Delivery
- Developer Tools
- Code Quality
有效的标签使用
- 使用具体且可搜索的标签
- 包含技术名称(
podman、kubernetes、npm等) - 添加用例标签(ci、cd、build、test、deploy)
Hub 验证要求
错误处理标准
- 使用正确的退出码(0 表示成功,非 0 表示失败)
- 为
Hub用户提供清晰的错误消息 - 包含结构化日志以便更好地调试
Hub Tasks 的安全性
Hub 安全要求
- 在
Task定义中不要硬编码密钥 - 使用可信、官方的容器镜像
- 固定特定镜像版本(不要使用
latest标签) - 遵循最小权限原则
- 记录任何特殊的安全要求
Hub 测试要求
必需的测试文件
- 提供可运行的
samples/目录以及TaskRun示例 - 包含展示典型用法的
run.yaml - 测试所有参数组合
- 验证错误处理场景
Hub 验证检查清单
- 已提供必需的 Hub 元数据
- 示例
TaskRun可正常工作 - 所有参数都已使用描述进行文档化
- Results 和 Workspaces 已正确描述
- 已遵循安全最佳实践
- 已验证平台兼容性
Hub Task 模板
文档要求
Hub 文档标准
- 在任务目录中包含完整的
README.md - 文档化所有参数、Workspaces 和 Results
- 提供使用示例和常见用例
- 包含故障排查信息
Hub 发布检查清单
✅ Hub 合规性
- 已提供必需的 Hub 元数据(labels 和 annotations)
- Task 使用的是
Task资源类型(不是 ClusterTask) - 版本标签与目录结构匹配
- 所有参数和 Results 都已提供描述
- 容器镜像使用了固定版本
- 已指定平台兼容性
- 提供了可运行的示例 TaskRun
- 提供了包含使用示例的完整 README
- 满足 Hub 验证要求
✅ 质量标准
- Task 具备幂等性且可复用
- 错误处理使用正确的退出码
- 不包含硬编码的密钥或凭据
- 已遵循安全最佳实践
- 已验证跨平台兼容性
- 文档完整且准确