epamedp/tekton-custom-task

Tekton Custom Task

概述

https://github.com/KubeRocketCI/tekton-custom-task 扩展了Kubernetes和Tekton的能力，提供自定义任务实现。这些自定义任务旨在简化标准Tekton任务可能无法覆盖的复杂工作流，是DevOps团队通过自定义逻辑扩展CI/CD流水线的强大工具。

项目结构

• api/v1alpha1/：包含自定义任务的API定义，包括自定义资源定义（CRD）的结构和验证。
• cmd/：包含主应用程序入口点和命令行界面设置。
• config/：包含用于部署自定义任务的Kubernetes配置文件，如CRD、RBAC规则和示例配置。
• docs/：提供API和使用示例的详细文档。
• deploy-templates/：包含用于部署自定义任务控制器的Helm图表模板。

快速开始

要开始使用Tekton Custom Task，请确保环境中已安装Kubernetes和Tekton Pipelines。按照以下步骤部署自定义任务：

1. 将仓库克隆到本地环境。

2. 导航至config/目录。

3. 向Kubernetes集群应用CRD：

   bash
   kubectl apply -f config/crd/bases/
   

4. 使用以下命令部署自定义任务：

   bash
   kubectl apply -f config/samples/
   

以下是在Tekton流水线中定义自定义任务的示例：

yaml
apiVersion: edp.epam.com/v1alpha1
kind: ApprovalTask
metadata:
  name: approvaltask-sample
  labels:
    app.kubernetes.io/name: tekton-custom-task
    app.kubernetes.io/managed-by: kustomize
spec:
  action: Pending
  description: "流水线下一步需要审批。"

此示例演示了如何在Tekton流水线中运行名为example-custom-task的CustomTask。

使用方法

本指南将引导您创建自定义ApprovalTask并将其集成到Tekton流水线中作为审批步骤。

要将ApprovalTask集成到CI/CD流水线中，请按照以下步骤定义自定义任务并在Tekton流水线中使用它。

定义ApprovalTask

通过准备名为approvaltask.yaml的YAML文件创建ApprovalTask定义，内容如下：

yaml
apiVersion: edp.epam.com/v1alpha1
kind: ApprovalTask
metadata:
  name: approvaltask-example
spec:
  action: Pending
  description: "下一部署阶段需要审批。"

此YAML片段创建名为approvaltask-example的ApprovalTask资源。该任务初始设置为Pending状态，表示等待审批，并包含提供审批上下文的描述。

在Tekton流水线中使用ApprovalTask

通过定义Pipeline和PipelineRun将ApprovalTask整合到Tekton流水线中。

定义流水线

创建名为pipeline.yaml的文件，内容如下：

yaml
apiVersion: tekton.dev/v1beta1
kind: Pipeline
metadata:
  name: example-pipeline
spec:
  tasks:
    - name: approval-task
      taskRef:
        apiVersion: edp.epam.com/v1alpha1
        kind: ApprovalTask
        name: approvaltask-example

此名为example-pipeline的流水线包含一个名为approval-task的任务。该任务引用先前定义的ApprovalTask（approvaltask-example）。

定义PipelineRun

要启动流水线执行，请在名为pipeline-run.yaml的文件中定义PipelineRun，内容如下：

yaml
apiVersion: tekton.dev/v1beta1
kind: PipelineRun
metadata:
  name: example-pipeline-run
spec:
  pipelineRef:
    name: example-pipeline

此名为example-pipeline-run的PipelineRun触发example-pipeline的执行。

应用定义

通过将YAML文件应用到Kubernetes集群来部署ApprovalTask、流水线并启动流水线运行：

sh
kubectl apply -f approvaltask.yaml
kubectl apply -f pipeline.yaml
kubectl apply -f pipeline-run.yaml

核心功能与特性

• 自定义任务定义：定义扩展Tekton流水线模型的任务。
• 灵活配置：利用Kubernetes CRD进行任务定义，支持动态和灵活的配置。
• 与Tekton流水线集成：无缝集成到现有Tekton流水线中。

集成与通知

Tekton Custom Task支持与Kubernetes仪表板和通知系统集成，提升自定义任务的监控和告警能力。

路线图

未来发展计划包括：

• 增强自定义任务管理的UI。
• 更多常见用例的示例和模板。
• 改进与外部工具和平台的集成。

贡献

我们欢迎通过issues和pull requests形式的贡献。请遵循仓库中概述的贡献指南。

许可

本项目采用Apache License 2.0许可。