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 上编辑此页
上一页配置
下一页配置流水线组件的资源配额

#调整子组件的可选配置项

#目录

#功能概述

通过调整 TektonConfig 资源中各组件的 options 配置,可以实现对子组件的自定义配置。

本文档介绍了 options 支持的配置项,以及如何配置这些项。

#使用场景

Tekton 支持通过 TektonConfig 资源部署子组件。该资源在 spec.pipeline、spec.trigger、spec.hub、spec.chain 和 spec.results 字段下均有一个通用配置项 options。

通过 options 配置,可以实现:

  • 组件的点位部署
  • 高可用设置的修改
  • 组件副本数的修改
  • 组件资源配额的修改
  • 默认 ConfigMap 配置项的修改

#详细可配置项

  • 修改组件的 Deployment 配置,如:
    • labels 和 annotations 配置
    • 副本数 replicas
    • 亲和性规则 affinity
    • 优先级类 priorityClassName
    • 节点选择器 nodeSelector
    • 容忍规则 tolerations
    • 拓扑扩散约束 topologySpreadConstraints
    • 运行时类 runtimeClassName
    • 卷 volumes
    • 容器 containers 和 initContainers
      • 资源配额 resources.limits 和 resources.requests
      • 环境变量 env
      • 卷 volumes
      • 执行参数 args
  • 修改组件的 ConfigMap 配置,如:
    • labels 和 annotations 配置
    • 更新或新增 data 配置项
  • 修改组件的 Ingress 配置,如:
    • ingressClassName 用于覆盖默认的 ingressClass 配置
    • rules 用于覆盖默认路由规则
    • tls 用于覆盖默认证书配置
  • 修改组件的 HorizontalPodAutoscaler 自动伸缩配置,如:
    • 添加该配置
    • 修改 minReplicas 和 maxReplicas 配置
    • 修改 targetCPUUtilizationPercentage 配置等
  • 修改组件的 StatefulSet 配置
  • 修改组件的 ValidatingWebhookConfiguration 和 MutatingWebhookConfiguration 配置

#前置条件

使用该功能前,请确保:

  • 已安装 Tekton Operator 组件
  • 环境中已自动创建 TektonConfig 资源
  • 对 TektonConfig 支持的配置项有基本了解

以下是一个典型的 options 配置示例:

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  targetNamespace: tekton-pipelines
  hub: {}
  chain: {}
  trigger: {}
  pipeline:
    options:
      # 是否禁用 options 配置,默认值为 false。设置为 true 时,options 下的所有配置均不生效。
      disabled: false

      # 配置 ConfigMap 的配置项
      configMaps:
        # 要修改或新增的 ConfigMap 名称
        config-defaults:
          data:
            # 要修改或新增的配置项
            default-container-resource-requirements: |
              place-scripts: # 更新 'place-scripts' 容器的资源需求
                requests:
                  memory: "64Mi"
                  cpu: "50m"
                limits:
                  memory: "128Mi"
                  cpu: "100m"

      # 配置 Deployment 的配置项
      deployments:
        # 要修改的 Deployment 名称
        tekton-events-controller:
          metadata:
            # 要修改的 Deployment 的标签配置
            labels:
              key: value
            # 要修改的 Deployment 的注解配置
            annotations:
              key: value
          spec:
            # 要修改的 Deployment 副本数
            replicas: 1
            # 要修改的模板配置
            template:
              metadata:
                # 要修改的标签配置
                labels:
                  key1: value
                # 要修改的注解配置
                annotations:
                  key1: value
              spec:
                # 要修改的亲和性配置
                affinity:
                  nodeAffinity:
                    requiredDuringSchedulingIgnoredDuringExecution:
                      nodeSelectorTerms:
                        - matchExpressions:
                          - key: kubernetes.io/os
                            operator: In
                            values:
                              - linux

                # 要修改的节点选择器配置
                nodeSelector:
                  kubernetes.io/os: linux

                # 要修改的容忍配置
                tolerations:
                  - effect: NoSchedule
                    key: node-role.kubernetes.io/master
                    operator: Exists

                # priorityClassName: ""
                # topologySpreadConstraints: ""
                # runtimeClassName: ""
                # volumes: []
                # initContainers: []

                containers:
                  # 要修改的容器名称
                  - name: tekton-events-controller
                    # 要修改的资源配额
                    resources:
                      limits:
                        cpu: "1"
                        memory: 1Gi
                      requests:
                        cpu: 500m
                        memory: 512Mi

                    # 要修改的环境变量
                    env:
                      - name: key
                        value: value

                    # 要修改的卷配置
                    # volumes: []

                    # 要添加的执行参数
                    # args: []

      # 要修改或新增的 HorizontalPodAutoscalers 配置
      horizontalPodAutoscalers:
        # 要修改的 horizontalPodAutoscaler 名称
        tekton-pipelines-remote-resolvers:
          metadata:
            # 要修改的注解配置
            # 要修改的标签配置
            labels:
              key: value
            annotations:
              key: value
          spec:
            # 要修改的最小副本数配置
            minReplicas: 1
            # 要修改的最大副本数配置
            maxReplicas: 5
            # 要修改的指标配置
            metrics:
              - resource:
                  name: cpu
                  target:
                    averageUtilization: 50
                    type: Utilization
                type: Resource
              - resource:
                  name: memory
                  target:
                    averageUtilization: 50
                    type: Utilization
                type: Resource
            # 要修改的 scaleTargetRef 配置
            scaleTargetRef:
              apiVersion: apps/v1
              kind: Deployment
              name: tekton-pipelines-remote-resolvers

#操作步骤

以 pipeline 组件为例,介绍如何配置资源配额。

#第 1 步

编辑 TektonConfig 资源

$ kubectl edit tektonconfigs.operator.tekton.dev config

#第 2 步

WARNING

修改配置可能会触发组件 Pod 的滚动更新,可能导致服务短暂不可用,请在合适的时间执行。

修改 spec.pipeline.options.deployments 配置,内容如下:

  • 将 Deployment tekton-events-controller 的副本数修改为 2
  • 修改 Deployment tekton-events-controller 的 resources 配置
apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  targetNamespace: tekton-pipelines
  hub: {}
  chain: {}
  trigger: {}
  pipeline:
    options:
      disabled: false
      deployments:
        tekton-events-controller:
          spec:
            replicas: 2
            template:
              spec:
                containers:
                  - name: tekton-events-controller
                    resources:
                      limits:
                        cpu: "1"
                        memory: 1Gi
                      requests:
                        cpu: 500m
                        memory: 512Mi

#第 3 步

提交配置,等待 Pod 更新。

$ kubectl get pods -n tekton-pipelines -l app=tekton-events-controller -w

NAME                                       READY   STATUS    RESTARTS   AGE
tekton-events-controller-fcd56975b-knvzx   1/1     Running   0          20s
tekton-events-controller-fcd56975b-qqprt   1/1     Running   0          31s

#操作结果

可以看到 tekton-events-controller 的副本数为 2,且 resources 配置生效。

$ kubectl get deployments.apps -n tekton-pipelines tekton-events-controller -o yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: tekton-events-controller
  namespace: tekton-pipelines
spec:
  replicas: 2
  template:
    metadata:
    spec:
      containers:
      - name: tekton-events-controller
        resources:
          limits:
            cpu: "1"
            memory: 1Gi
          requests:
            cpu: 500m
            memory: 512Mi

#后续操作

如果需要修改其他组件的配置,可以参考上述步骤修改其他组件的 options 配置。

#参考资料

  • 官方文档:Tekton Config
  • 相关代码