为 Tekton Hub 编写 Pipelines
目录
概述Hub 专属元数据Hub 所需标签Hub 所需注解Hub Task 引用Hub 的 Catalog Task 引用Hub 分类和标签标准 Pipeline 分类有效的 Pipeline 标签策略Hub 参数标准Hub 专用参数要求Hub Pipeline 模板Hub 最佳实践Hub 的 Task 组合Hub 的工作区管理Hub 的 Pipeline 可复用性Hub 测试要求必需的 Pipeline 测试文件Hub Pipeline 验证清单Hub Pipelines 的安全性Hub 安全要求文档要求Hub Pipeline 文档标准Hub 发布清单✅ Hub 合规性✅ 质量标准概述
本指南介绍了创建可与 Tekton Hub catalogs 配合使用的 Pipelines 时的具体要求和最佳实践。重点关注 Hub 专用的元数据、验证和组合标准。
Hub 专属元数据
Hub 所需标签
Hub 所需注解
Hub Task 引用
Hub 的 Catalog Task 引用
Hub 分类和标签
标准 Pipeline 分类
- Integration & Delivery
- Continuous Integration
- Continuous Deployment
- Testing
- Security
- Build & Package
有效的 Pipeline 标签策略
- 使用与工作流相关的标签(
ci、cd、cicd) - 包含技术栈(
nodejs、java、python、golang) - 添加部署目标(
kubernetes、cloud、containers)
Hub 参数标准
Hub 专用参数要求
Hub Pipeline 模板
Hub 最佳实践
Hub 的 Task 组合
- 尽可能使用同一
Hubcatalog 中的Tasks - 为保证稳定性,引用特定的
Task版本 - 提供清晰的参数映射
- 文档化
Task依赖关系
Hub 的工作区管理
- 使用具有描述性的工作区名称和说明
- 将可选工作区标记为
optional: true - 文档化
Task之间的工作区数据流 - 尽可能减少工作区要求
Hub 的 Pipeline 可复用性
- 面向通用用例进行设计
- 提供灵活的参数
- 包含合理的默认值
- 支持多种部署场景
Hub 测试要求
必需的 Pipeline 测试文件
- 提供可工作的
samples/目录和PipelineRun示例 - 包含演示典型用法的
run.yaml - 使用不同的参数组合进行测试
- 验证工作区配置
- 测试错误处理场景
Hub Pipeline 验证清单
- 已提供必需的
Hub元数据 - 示例
PipelineRun可正常工作 - 所有参数都已附带说明
- 工作区已正确描述
-
Task引用使用了Hubcatalogtasks - 已验证平台兼容性
- 已包含用于清理的
finally tasks
Hub Pipelines 的安全性
Hub 安全要求
- 在
Pipeline定义中不要硬编码密钥 - 使用安全的
Task引用 - 文档化所需的 service account 权限
- 遵循最小权限原则
- 验证输入参数
文档要求
Hub Pipeline 文档标准
- 在
pipeline目录中包含完整的README.md - 文档化完整的工作流和用途
- 提供清晰的参数说明
- 包含用法示例和常见配置
- 文档化前提条件和依赖关系
- 解释工作区要求
- 包含故障排除指南
Hub 发布清单
✅ Hub 合规性
- 已提供必需的 Hub 元数据(标签和注解)
- 版本标签与目录结构匹配
- 所有参数都具有清晰说明
- 工作区文档完善
- 使用了 Hub catalog
Task引用 - 已指定平台兼容性
- 已提供可运行的示例
PipelineRun - 提供了包含使用示例的完整
README - 通过 Hub 验证要求
✅ 质量标准
-
Pipeline可跨环境复用 - 已实现错误处理和清理
- 没有硬编码值或密钥
- 遵循安全最佳实践
- 已验证跨平台兼容性
- 文档完整且准确
- 在可能的情况下通过并行执行优化了性能