logo
Alauda DevOps Pipelines Docs
English
简体中文
English
简体中文
logo
Alauda DevOps Pipelines Docs
导航

概览

介绍
架构
快速开始
生命周期策略
发版日志
特性概述

触发器

介绍
架构

核心概念

Tekton Triggers 核心概念
EventListener
触发器
Interceptor
TriggerBinding
TriggerTemplate
快速开始

实用指南

设置事件监听器
使用 GitLab 事件触发器
创建 TriggerTemplate

问题处理

Pipeline 未被自动触发
permissions

概念

TektonConfig
TektonPipeline
安装

升级

升级路径
升级 Alauda DevOps Pipelines Operator

配置

调整子组件的可选配置项
配置流水线组件的资源配额
Pod 模板配置指南
定期清理 TaskRun 和 PipelineRun 资源

How To

通过 TektonConfig 在 global 集群中部署 tekton-pipelines

管道

介绍
架构

概念

任务
TaskRuns
流水线
PipelineRuns
StepActions
解析器
工作空间
Pod 模板
快速开始

实用指南

调整 Dockerfile 构建适用于 Task 的自定义镜像
Specifying remote pipelines using hub resolvers
Specifying remote tasks using hub resolvers
使用 java-image-build-scan-deploy 管道

故障排查

在 Tekton 中使用自定义镜像时遇到容器创建失败的问题
在 run-script Task 中使用自定义镜像时遇到权限不够的问题
在 Tekton 中遇到无法使用多个基于 PVC 的工作区的问题
权限

结果

介绍
架构

核心概念

核心概念
深入理解 Tekton Results
快速开始
permissions

配置

数据库配置

供应链安全

介绍
架构

概念

核心概念
了解 Tekton Chains

快速开始

Getting Started
签名证明

实用指南

生成镜像签名并验证镜像完整性
构建系统溯源验证
源代码仓库验证
漏洞扫描和验证
Base Image and SBOM Verification
License Compliance Verification
Keyless Signing Verification

配置

链配置
链配置
Authentication for Chains
签名密钥配置

Hub

引言
架构

核心概念

概念
理解 Tekton Hub
权限描述

API Reference

介绍

Kubernetes APIs

Operator

TektonConfig [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
TektonPipeline [operator.tekton.dev/v1alpha1]
TektonTrigger [operator.tekton.dev/v1alpha1]
TektonChain [operator.tekton.dev/v1alpha1]
TektonHub [operator.tekton.dev/v1alpha1]
TektonResult [operator.tekton.dev/v1alpha1]
TektonInstallerSet [operator.tekton.dev/v1alpha1]
OpenShift Pipelines as Code [operator.tekton.dev/v1alpha1]

管道

Pipeline [tekton.dev/v1]
任务 [tekton.dev/v1]
PipelineRun [tekton.dev/v1]
TaskRun [tekton.dev/v1]
集群任务 [tekton.dev/v1]
运行 [tekton.dev/v1]
CustomRun [tekton.dev/v1]
StepAction [tekton.dev/v1]
VerificationPolicy [tekton.dev/v1alpha1]
ResolutionRequest [resolution.tekton.dev/v1beta1]

Triggers

触发器 [triggers.tekton.dev/v1beta1]
TriggerTemplate [triggers.tekton.dev/v1beta1]
EventListener [triggers.tekton.dev/v1beta1]
触发绑定 [triggers.tekton.dev/v1beta1]
拦截器 [triggers.tekton.dev/v1alpha1]
集群触发器绑定 [triggers.tekton.dev/v1beta1]
集群拦截器 [triggers.tekton.dev/v1alpha1]

高级 API

Results

Introduction to API Usage
Results 列表
结果详情
结果记录列表
Result logs 列表
📝 在 GitHub 上编辑此页
上一页Specifying remote tasks using hub resolvers
下一页故障排查

#Use java-image-build-scan-deploy Pipeline

此管道旨在自动化 Java 应用程序的完整 CI/CD 工作流。
它具有可重用性和灵活性,支持自定义构建参数、多工作区以及步骤的条件执行。

主要特性:

  • ✅ 灵活的代码来源
  • ⚙️ 可定制的 Maven 配置
  • 🚀 支持 Maven 本地仓库缓存
  • 🔌 通过参数支持可插拔任务
  • 🛠️ 动态镜像构建与推送
  • ☁️ 通过 kubectl 更新工作负载镜像

#目录

#使用 hub 解析器指定

以下示例 PipelineRun 引用了目录中的管道:

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  name: java-pipeline-run
spec:
  pipelineRef:
    resolver: hub
    params:
    - name: catalog
      value: catalog
    - name: kind
      value: pipeline
    - name: name
      value: java-image-build-scan-deploy
    - name: version
      value: "0.1"

#参数

#Git Clone

  • git-url

    • type: string
    • default: ""
    • description: 要克隆的仓库 URL。
  • git-revision

    • type: string
    • default: ""
    • description: 要检出的版本(分支、标签、sha、ref 等)。
  • skip-git-clone

    • type: string
    • default: "false"
    • description: 跳过执行 git clone 任务。仅当对应代码仓库已存在于工作区时可启用。
  • git-crt-file-name

    • type: string
    • default: "ca-bundle.crt"
    • description: 使用 ssl-ca-directory 工作区挂载的 crt 文件名,默认值为 ca-bundle.crt。

#Maven

  • maven-subdirectory

    • type: string
    • default: .
    • description: Maven 项目的上下文目录。
  • maven-goals

    • type: array
    • default: ["package"]
    • description: 要执行的 Maven 目标。
  • maven-mirror-url

    • type: string
    • default: ""
    • description: Maven 仓库镜像 URL。

#SonarQube Scanner

  • sonar-url

    • type: string
    • default: ""
    • description: SonarQube 服务器实例的 URL。未指定时将跳过 sonarqube scanner 任务。
  • sonar-project-key

    • type: string
    • default: ""
    • description: SonarQube 项目的唯一键。
  • sonar-properties

    • type: array
    • default: ["sonar.sources=.", "sonar.java.binaries=target/classes"]
    • description: 传递给 SonarQube 的附加属性。详情请参见 Configuration of SonarQube properties。

#构建镜像

  • images

    • type: array
    • description: buildah 将构建的镜像引用。可包含多个以逗号分隔的镜像地址。例如:
      • busybox:latest
      • busybox:v1 .30.1
  • dockerfile-path

    • type: string
    • default: ./Dockerfile
    • description: 用于构建的 Dockerfile 路径。
  • build-extra-args

    • type: string
    • default: ""
    • description: 构建镜像时传递给构建命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --build-arg key=value --label key=value)。
  • build-args

    • type: array
    • default: [""]
    • description: 指定构建参数及其值,这些参数会在 Dockerfile 指令中进行插值,但不会添加到最终镜像配置的环境变量列表中。例如 HTTP_PROXY=http://10.10.10.10:8080。
  • build-context

    • type: string
    • default: .
    • description: 用作构建上下文的目录路径。
  • push-extra-args

    • type: string
    • default: ""
    • description: 推送镜像时传递给 push 命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --creds=username:password )。

#Trivy Scanner

  • skip-trivy-scan

    • type: string
    • default: "false"
    • description: 设置为跳过构建后 Trivy 镜像扫描。
  • trivy-extra-args

    • type: string
    • default: ""
    • description: 扫描镜像时传递给 trivy 命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --insecure)。可使用 --skip-db-update 和 --skip-java-db-update 跳过漏洞数据库更新。

#部署或升级工作负载

  • workload-name

    • type: string
    • default: ""
    • description: 要部署或升级的工作负载名称。未指定时将跳过 deploy-or-upgrade 任务。
  • workload-kind

    • type: string
    • default: Deployment
    • description: 要部署或升级的工作负载类型,如 Deployment、StatefulSet 等。
  • workload-namespace

    • type: string
    • default: ""
    • description: 工作负载所在的命名空间。未指定时使用当前 TaskRun 的命名空间。
  • workload-container

    • type: string
    • default: []
    • description: 指定需要更新镜像的工作负载内容器。默认更新工作负载中所有容器的镜像。
  • workload-rollout-timeout

    • type: string
    • default: "0"
    • description: 等待工作负载就绪的超时时长,0 表示永不超时。其他值应包含时间单位(例如 1s、2m、3h)。
  • workload-manifests-dir

    • type: string
    • default: ""
    • description: 部署工作负载的清单目录。未指定时仅更新集群中已有工作负载的镜像。可使用 source 工作区中清单目录的相对路径,例如 "manifests"。

#工作区

  • source:用于任务间共享信息的工作区。
  • git-basic-auth:一个可选工作区,包含 .gitconfig 和 .git-credentials 文件。执行任何 git 命令前,这些文件会被复制到用户主目录。工作区中的其他文件会被忽略。强烈建议尽可能使用 git-ssh-directory 替代 basic-auth,并优先绑定 Secret 到此工作区而非其他卷类型。
  • git-ssh-directory:一个可选工作区,包含私钥、known_hosts、config 等。执行 git 命令前会复制到用户主目录,用于 git 远程认证。强烈建议绑定 Secret 到此工作区,优先于其他卷类型。
  • git-ssl-ca-directory:一个可选工作区,包含 CA 证书,Git 在通过 HTTPS 拉取或推送时用于验证对端。
  • maven-settings:一个可选工作区,包含自定义 Maven 配置。
  • maven-local-repo:一个可选工作区,用于 Maven 本地仓库。
  • maven-server-secret:一个可选工作区,包含服务器凭据。
  • sonar-settings:一个可选工作区,用于挂载 SonarQube 属性。
  • sonar-credentials:一个可选工作区,包含 SonarQube 使用的凭据。
  • dockerconfig:一个可选工作区,用于 Docker 配置文件,如 config.json 或 .dockerconfigjson。用于推送镜像时的认证。
  • kubeconfig:一个可选工作区,包含 kubeconfig 文件。kubeconfig 文件名应为 kubeconfig。若无此文件,工作区将被忽略。

#平台

该 Task 可在 linux/amd64 和 linux/arm64 平台上运行。

#使用方法

#最小配置:使用最少参数运行端到端流程

未设置或省略的可选任务(如 sonarqube-scanner、deploy-or-upgrade 等)将被优雅地跳过。

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  generateName: java-build-run-
spec:
  pipelineRef:
    name: java-image-build-scan-deploy
  params:
    - name: git-url
      value: https://github.com/example/java-app
    - name: git-revision
      value: refs/heads/main
    - name: images
      value: ["registry.example.com/java-app:latest"]
  workspaces:
    - name: source
      persistentVolumeClaim:
        claimName: source
    - name: git-basic-auth
      secret:
        secretName: gitconfig
    - name: dockerconfig
      secret:
        secretName: dockerconfig

#使用 Maven Settings.xml

你可以挂载 maven-settings 工作区来应用 Maven 构建的 settings.xml。

workspaces:
  - name: maven-settings
    configMap:
      name: maven-settings
apiVersion: v1
kind: ConfigMap
metadata:
  name: maven-settings
data:
  settings.xml: |
    <!--# your maven settings.xml ...-->

你也可以使用 maven-mirror-url 参数设置 Maven 仓库镜像,它会作为 settings.xml 中的 <mirror> 使用。

<mirror>
  <id>mirror.default</id>
  <url>$(params.maven-mirror-url)</url>
  <mirrorOf>central</mirrorOf>
</mirror>

#使用构建缓存加速 CI

挂载持久化的 maven-local-repo 工作区以缓存 .m2/repository 内容,跨管道运行复用依赖,大幅减少 Maven 依赖解析时间,显著缩短构建时间。

workspaces:
  - name: maven-local-repo
    persistentVolumeClaim:
      claimName: maven-repo-cache

#SonarQube 属性配置

你可以挂载 sonar-settings 工作区或使用 sonar-properties 参数来应用 sonar-project.properties 文件的属性。

默认属性为:sonar.sources=.,sonar.java.binaries=target/classes。

SonarQube 属性的用法请参考 analysis parameters 和 Java 语言属性。

以下是部分可设置的属性:

属性描述
sonar.java.binaries (必填)用逗号分隔的目录路径,包含与源文件对应的已编译字节码文件。
sonar.java.libraries用逗号分隔的文件路径,包含项目使用的第三方库(JAR 或 Zip 文件)。支持通配符:sonar.java.libraries=path/to/Library.jar,directory/**/*.jar
sonar.java.test.binaries用逗号分隔的目录路径,包含与测试文件对应的已编译字节码文件。
sonar.java.test.libraries用逗号分隔的文件路径,包含测试使用的第三方库(JAR 或 Zip 文件),例如应包含 junit jar。支持通配符:sonar.java.test.libraries=directory/**/*.jar
sonar.qualitygate.wait强制分析步骤轮询服务器实例,等待质量门状态。
sonar.qualitygate.timeout扫描器等待报告处理的秒数。
sonar.projectVersion项目版本。用于基于前一版本的新代码定义的分支分析。
sonar.sources用逗号分隔的目录路径,包含主源文件。
sonar.organizationSonarQube 中项目所属的组织。

#部署或升级工作负载

你可以使用此管道中 build-image 任务构建的镜像来部署或升级工作负载。

通过设置 workload-manifests-dir 参数,可以从指定目录应用 Kubernetes 清单以创建或更新工作负载。

支持 JSON 和 YAML 格式。指定目录下的所有清单将使用 kubectl apply 处理。注意 kubectl apply 不会递归子目录。

如果目录包含 Kustomize 配置文件(如 kustomization.yaml、kustomization.yml 或 Kustomization),将使用 kubectl kustomize 处理。

以下是 workload-manifests-dir 的示例结构:

manifests
├── deployment.yaml
├── kustomization.yaml
└── service.yaml

你可以配置以下参数:

spec:
  params:
    # ...
    - name: images
      value:
        - foo/bar:latest
    - name: workload-name
      value: bar
    - name: workload-namespace
      value: default
    - name: workload-kind
      value: Deployment
    - name: workload-manifests-dir
      value: manifests
    # ...

如果不想使用清单部署工作负载,只需将 workload-manifests-dir 参数留空。此时任务仅更新集群中已有工作负载的镜像。

你需要管理工作负载的镜像拉取密钥。如果新镜像托管在不同的镜像仓库,请确保为工作负载创建并配置相应的拉取密钥。

#使用参数跳过任务

管道支持通过参数跳过任务:

任务参数默认值描述
git-cloneskip-git-clone"false"如果代码已存在于 source 工作区,可设置为 "true" 跳过克隆。
sonarqube-scannersonar-url""未设置 sonar-url 时跳过扫描。
trivy-scannerskip-trivy-scan"false"设置为 "true" 时跳过扫描。
deploy-or-upgradeworkload-name""不想部署或升级工作负载时,可将 workload-name 留空。

#包含所有任务的完整示例

此示例演示如何使用管道中的所有任务,包括:

  • 克隆源代码
  • 使用 Maven 构建代码
  • 构建镜像并推送到镜像仓库
  • 使用 Trivy 扫描镜像
  • 使用 SonarQube 扫描代码
  • 部署或升级工作负载
apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
  generateName: java-build-run-
spec:
  pipelineRef:
    name: java-image-build-scan-deploy
  params:
    - name: git-url
      value: https://github.com/example/java-app
    - name: git-revision
      value: refs/heads/main
    - name: sonar-url
      value: https://sonar.example.com
    - name: sonar-project-key
      value: java-pipeline-example-key
    - name: images
      value: ["registry.example.com/java-app:latest"]
    - name: workload-name
      value: java-app
    - name: workload-namespace
      value: default
  workspaces:
    - name: source
      persistentVolumeClaim:
        claimName: source
    - name: git-basic-auth
      secret:
        secretName: gitconfig
    - name: sonar-credentials
      secret:
        secretName: sonar-credentials
    - name: dockerconfig
      secret:
        secretName: docker-credentials
    - name: kubeconfig
      configMap:
        name: kubeconfig