logo
Alauda DevOps Pipelines Docs
logo
Alauda DevOps Pipelines Docs
Navigation

Overview

Introduction
Architecture
Feature Overview
Lifecycle Policy
Quick Start
Release Notes

Concepts

TektonConfig
TektonPipeline
Install
Upgrade

Configure

Adjusting Optional Configuration Items of Subcomponents
Configuring Resource Quotas for Pipeline Components
Pod Template Configuration Guide
Regular Cleanup of TaskRun and PipelineRun Resources

How To

Deploying tekton-pipelines in a global cluster through TektonConfig

Pipelines

Introduction
Architecture

Concepts

Tasks
TaskRuns
Pipelines
PipelineRuns
StepActions
Resolvers
Workspaces
Pod Templates
Quick Start
permissions

how_to

Adjust Dockerfile for Building Task-Compatible Custom Images

trouble_shooting

Failed to create pod due to config error when using custom images in Tekton

Triggers

Introduction
Architecture

Core Concepts

Core Concepts
EventListener
Trigger
Interceptor
TriggerBinding
TriggerTemplate
Quick Start

How To

Setup EventListener
Use GitLab Event Triggers
Create TriggerTemplate

Troubleshooting

The Pipeline is not automatically triggered
Permission Description

Hub

Introduction
Architecture

Core Concepts

Concepts
Understanding Tekton Hub
Permission Description

Configure

Tekton Hub Configuration
Adding Custom Catalogs

Tutorials

Creating a Custom Catalog
Writing Tasks for Tekton Hub
Writing Pipelines for Tekton Hub

Results

Introduction
Architecture

Concepts

Core Concepts
Tekton Results
Quick Start
permissions

Configure

Database Configuration

Supply Chain Security

Introduction
Architecture

Concepts

Core Concepts
Understanding Tekton Chains
Quick Start

API Reference

Introduction

Kubernetes APIs

Pipelines

Pipeline [tekton.dev/v1]
Task [tekton.dev/v1]
PipelineRun [tekton.dev/v1]
TaskRun [tekton.dev/v1]
ClusterTask [tekton.dev/v1]
Run [tekton.dev/v1]
CustomRun [tekton.dev/v1]
StepAction [tekton.dev/v1]
VerificationPolicy [tekton.dev/v1alpha1]
ResolutionRequest [resolution.tekton.dev/v1beta1]

Triggers

Trigger [triggers.tekton.dev/v1beta1]
TriggerTemplate [triggers.tekton.dev/v1beta1]
EventListener [triggers.tekton.dev/v1beta1]
TriggerBinding [triggers.tekton.dev/v1beta1]
Interceptor [triggers.tekton.dev/v1alpha1]
ClusterTriggerBinding [triggers.tekton.dev/v1beta1]
ClusterInterceptor [triggers.tekton.dev/v1alpha1]

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]

Advanced APIs

Results

Introduction to API Usage
Results List
Results Details
Result records List
Result logs List
📝 Edit this page on GitHub
Previous PageTektonInstallerSet [operator.tekton.dev/v1alpha1]
Next PageTektonTrigger [operator.tekton.dev/v1alpha1]

#TektonPipeline [operator.tekton.dev/v1alpha1]

operator.tekton.dev group

TektonPipeline is the Schema for the tektonpipelines API

v1alpha1 version
spec object

TektonPipelineSpec defines the desired state of TektonPipeline

await-sidecar-readiness boolean
bundles-resolver-config object
cluster-resolver-config object
config object

Config holds the configuration for resources created by TektonPipeline

nodeSelector object
priorityClassName string

PriorityClassName holds the priority class to be set to pod template

tolerations []object

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

effect string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

operator string

Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

tolerationSeconds integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

value string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

coschedule string
default-affinity-assistant-pod-template string
default-cloud-events-sink string
default-forbidden-env string
default-managed-by-label-value string
default-max-matrix-combinations-count string
default-pod-template string
default-resolver-type string
default-service-account string
default-task-run-workspace-binding string
default-timeout-minutes integer
disable-affinity-assistant boolean
disable-creds-init boolean
disable-inline-spec string
embedded-status string
enable-api-fields string
enable-bundles-resolver boolean
enable-cel-in-whenexpression boolean
enable-cluster-resolver boolean
enable-custom-tasks boolean
enable-git-resolver boolean
enable-hub-resolver boolean
enable-param-enum boolean
enable-provenance-in-status boolean
enable-step-actions boolean
enable-tekton-oci-bundles boolean

not in use, see: https://github.com/tektoncd/pipeline/pull/7789 this field is removed from pipeline component keeping here to maintain the API compatibility

enforce-nonfalsifiability string
git-resolver-config object
hub-resolver-config object
keep-pod-on-cancel boolean
max-result-size integer
metrics.count.enable-reason boolean
metrics.pipelinerun.duration-type string
metrics.pipelinerun.level string
metrics.taskrun.duration-type string
metrics.taskrun.level string
options object required

options holds additions fields and these fields will be updated on the manifests

configMaps object
deployments object
disabled boolean
horizontalPodAutoscalers object
statefulSets object
webhookConfigurationOptions object
params []object

Param declares an string value to use for the parameter called name.

name string
value string
performance object

PipelinePerformanceProperties defines the fields which are configurable to tune the performance of pipelines controller

buckets integer
disable-ha boolean required

if it is true, disables the HA feature

kube-api-burst integer
kube-api-qps number

queries per second (QPS) and burst to the master from rest API client actually the number multiplied by 2 https://github.com/pierretasci/pipeline/blob/05d67e427c722a2a57e58328d7097e21429b7524/cmd/controller/main.go#L85-L87 defaults: https://github.com/tektoncd/pipeline/blob/34618964300620dca44d10a595e4af84e9903a55/vendor/k8s.io/client-go/rest/config.go#L45-L46

replicas integer
statefulset-ordinals boolean

if is true, enable StatefulsetOrdinals mode

threads-per-controller integer

The number of workers to use when processing the pipelines controller's work queue

require-git-ssh-secret-known-hosts boolean
results-from string
running-in-environment-with-injected-sidecars boolean
scope-when-expressions-to-task boolean

ScopeWhenExpressionsToTask is deprecated and never used.

send-cloudevents-for-runs boolean
set-security-context boolean
targetNamespace string

TargetNamespace is where resources will be installed

trusted-resources-verification-no-match-policy string
verification-mode string
status object

TektonPipelineStatus defines the observed state of TektonPipeline

annotations object

Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.

conditions []object

Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties

lastTransitionTime string

LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).

message string

A human readable message indicating details about the transition.

reason string

The reason for the condition's last transition.

severity string

Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.

status string required

Status of the condition, one of True, False, Unknown.

type string required

Type of condition.

extTektonInstallerSets object

The installer sets created for extension components

observedGeneration integer

ObservedGeneration is the 'Generation' of the Service that was last processed by the controller.

tektonInstallerSet string

The current installer set name for TektonPipeline

version string

The version of the installed release