TektonConfig [operator.tekton.dev/v1alpha1]

Description
TektonConfig is the Schema for the TektonConfigs API
Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

TektonConfigSpec defines the desired state of TektonConfig

statusobject

TektonConfigStatus defines the observed state of TektonConfig

.spec

Description
TektonConfigSpec defines the desired state of TektonConfig
Type
object
PropertyTypeDescription
addonobject

Addon holds the addons config

chainobject

Chain holds the customizable option for chains component

configobject

Config holds the configuration for resources created by TektonConfig

dashboardobject

Dashboard holds the customizable options for dashboards component

hubobject

Hub holds the hub config

multiclusterProxyAAEobject

MulticlusterProxyAAE holds the customizable options for the multicluster-proxy-aae component

paramsarray

Params is the list of params passed for all platforms

pipelineobject

Pipeline holds the customizable option for pipeline component

platformsobject

Platforms allows configuring platform specific configurations

profilestring
prunerobject

Pruner holds the prune config

resultobject

Result holds the customize option for results component

schedulerobject

To enable Pipeline Scheduling on Single Cluster or Multiple Clusters

targetNamespacestring

TargetNamespace is where resources will be installed

targetNamespaceMetadataobject

holds target namespace metadata

tektonprunerobject

New EventBasedPruner which provides more granular control over TaskRun and PipelineRuns

triggerobject

Trigger holds the customizable option for triggers component

.spec.addon

Description
Addon holds the addons config
Type
object
PropertyTypeDescription
enablePipelinesAsCodeboolean

Deprecated, will be removed in further release EnablePAC field defines whether to install PAC

paramsarray

Params is the list of params passed for Addon customization

.spec.addon.params

Description
Params is the list of params passed for Addon customization
Type
array

.spec.addon.params[]

Description
Param declares an string value to use for the parameter called name.
Type
object
PropertyTypeDescription
namestring
valuestring

.spec.chain

Description
Chain holds the customizable option for chains component
Type
object
Required
disabled
PropertyTypeDescription
artifacts.oci.formatstring

oci artifacts config

artifacts.oci.signerstring
artifacts.oci.storagestring
artifacts.pipelinerun.enable-deep-inspectionstring
artifacts.pipelinerun.formatstring

pipelinerun artifacts config

artifacts.pipelinerun.signerstring
artifacts.pipelinerun.storagestring
artifacts.taskrun.formatstring

taskrun artifacts config

artifacts.taskrun.signerstring
artifacts.taskrun.storagestring
builddefinition.buildtypestring
builder.idstring

builder config

controllerEnvsarray
disabledboolean

enable or disable chains feature

generateSigningSecretboolean

generate signing key

optionsobject

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

performanceobject

PerformanceProperties defines the fields which are configurable to tune the performance of component controller

signers.kms.auth.addressstring
signers.kms.auth.oidc.pathstring
signers.kms.auth.oidc.rolestring
signers.kms.auth.spire.audiencestring
signers.kms.auth.spire.sockstring
signers.kms.auth.tokenstring
signers.kms.auth.token-pathstring
signers.kms.kmsrefstring

kms signer config

signers.x509.fulcio.addressstring
signers.x509.fulcio.enabledboolean

x509 signer config

signers.x509.fulcio.issuerstring
signers.x509.fulcio.providerstring
signers.x509.identity.token.filestring
signers.x509.tuf.mirror.urlstring
storage.docdb.mongo-server-urlstring
storage.docdb.mongo-server-url-dirstring
storage.docdb.urlstring
storage.gcs.bucketstring

storage configs

storage.grafeas.notehintstring
storage.grafeas.noteidstring
storage.grafeas.projectidstring
storage.oci.repositorystring
storage.oci.repository.insecureboolean
transparency.enabledstring
transparency.urlstring

.spec.chain.controllerEnvs

Type
array

.spec.chain.controllerEnvs[]

Description
EnvVar represents an environment variable present in a Container.
Type
object
Required
name
PropertyTypeDescription
namestring

Name of the environment variable. May consist of any printable ASCII characters except '='.

valuestring

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

valueFromobject

Source for the environment variable's value. Cannot be used if value is not empty.

.spec.chain.controllerEnvs[].valueFrom

Description
Source for the environment variable's value. Cannot be used if value is not empty.
Type
object
PropertyTypeDescription
configMapKeyRefobject

Selects a key of a ConfigMap.

fieldRefobject

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

fileKeyRefobject

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

resourceFieldRefobject

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

secretKeyRefobject

Selects a key of a secret in the pod's namespace

.spec.chain.controllerEnvs[].valueFrom.configMapKeyRef

Description
Selects a key of a ConfigMap.
Type
object
Required
key
PropertyTypeDescription
keystring

The key to select.

namestring

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optionalboolean

Specify whether the ConfigMap or its key must be defined

.spec.chain.controllerEnvs[].valueFrom.fieldRef

Description
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring

Version of the schema the FieldPath is written in terms of, defaults to "v1".

fieldPathstring

Path of the field to select in the specified API version.

.spec.chain.controllerEnvs[].valueFrom.fileKeyRef

Description
FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.
Type
object
Required
keypathvolumeName
PropertyTypeDescription
keystring

The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

optionalboolean

Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers.

If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.

pathstring

The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.

volumeNamestring

The name of the volume mount containing the env file.

.spec.chain.controllerEnvs[].valueFrom.resourceFieldRef

Description
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
Type
object
Required
resource
PropertyTypeDescription
containerNamestring

Container name: required for volumes, optional for env vars

divisor

Specifies the output format of the exposed resources, defaults to "1"

resourcestring

Required: resource to select

.spec.chain.controllerEnvs[].valueFrom.secretKeyRef

Description
Selects a key of a secret in the pod's namespace
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optionalboolean

Specify whether the Secret or its key must be defined

.spec.chain.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.chain.options.configMaps

Type
object

.spec.chain.options.deployments

Type
object

.spec.chain.options.horizontalPodAutoscalers

Type
object

.spec.chain.options.ingress

Type
object

.spec.chain.options.statefulSets

Type
object

.spec.chain.options.webhookConfigurationOptions

Type
object

.spec.chain.performance

Description
PerformanceProperties defines the fields which are configurable to tune the performance of component controller
Type
object
Required
disable-ha
PropertyTypeDescription
bucketsinteger
disable-haboolean

if it is true, disables the HA feature

kube-api-burstinteger
kube-api-qpsnumber

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

replicasinteger
statefulset-ordinalsboolean

if is true, enable StatefulsetOrdinals mode

threads-per-controllerinteger

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

.spec.config

Description
Config holds the configuration for resources created by TektonConfig
Type
object
PropertyTypeDescription
nodeSelectorobject
priorityClassNamestring

PriorityClassName holds the priority class to be set to pod template

tolerationsarray

.spec.config.nodeSelector

Type
object

.spec.config.tolerations

Type
array

.spec.config.tolerations[]

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

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

keystring

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.

operatorstring

Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).

tolerationSecondsinteger

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.

valuestring

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

.spec.dashboard

Description
Dashboard holds the customizable options for dashboards component
Type
object
Required
readonly
PropertyTypeDescription
external-logsstring
optionsobject

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

readonlyboolean

Readonly when set to true configures the Tekton dashboard in read-only mode

.spec.dashboard.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.dashboard.options.configMaps

Type
object

.spec.dashboard.options.deployments

Type
object

.spec.dashboard.options.horizontalPodAutoscalers

Type
object

.spec.dashboard.options.ingress

Type
object

.spec.dashboard.options.statefulSets

Type
object

.spec.dashboard.options.webhookConfigurationOptions

Type
object

.spec.hub

Description
Hub holds the hub config
Type
object
PropertyTypeDescription
optionsobject

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

paramsarray

Params is the list of params passed for Hub customization

.spec.hub.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.hub.options.configMaps

Type
object

.spec.hub.options.deployments

Type
object

.spec.hub.options.horizontalPodAutoscalers

Type
object

.spec.hub.options.ingress

Type
object

.spec.hub.options.statefulSets

Type
object

.spec.hub.options.webhookConfigurationOptions

Type
object

.spec.hub.params

Description
Params is the list of params passed for Hub customization
Type
array

.spec.hub.params[]

Description
Param declares an string value to use for the parameter called name.
Type
object
PropertyTypeDescription
namestring
valuestring

.spec.multiclusterProxyAAE

Description
MulticlusterProxyAAE holds the customizable options for the multicluster-proxy-aae component
Type
object
PropertyTypeDescription
optionsobject

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

.spec.multiclusterProxyAAE.options

Description
options holds additional fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.multiclusterProxyAAE.options.configMaps

Type
object

.spec.multiclusterProxyAAE.options.deployments

Type
object

.spec.multiclusterProxyAAE.options.horizontalPodAutoscalers

Type
object

.spec.multiclusterProxyAAE.options.ingress

Type
object

.spec.multiclusterProxyAAE.options.statefulSets

Type
object

.spec.multiclusterProxyAAE.options.webhookConfigurationOptions

Type
object

.spec.params

Description
Params is the list of params passed for all platforms
Type
array

.spec.params[]

Description
Param declares an string value to use for the parameter called name.
Type
object
PropertyTypeDescription
namestring
valuestring

.spec.pipeline

Description
Pipeline holds the customizable option for pipeline component
Type
object
PropertyTypeDescription
await-sidecar-readinessboolean
bundles-resolver-configobject
cluster-resolver-configobject
coschedulestring
default-affinity-assistant-pod-templatestring
default-cloud-events-sinkstring
default-forbidden-envstring
default-managed-by-label-valuestring
default-max-matrix-combinations-countstring
default-pod-templatestring
default-resolver-typestring
default-service-accountstring
default-task-run-workspace-bindingstring
default-timeout-minutesinteger
disable-affinity-assistantboolean

Deprecated: DisableAffinityAssistant is deprecated and no longer used. This field is removed from pipeline component. Keeping here to maintain API compatibility during upgrades.

disable-creds-initboolean
disable-inline-specstring
embedded-statusstring
enable-api-fieldsstring
enable-bundles-resolverboolean
enable-cel-in-whenexpressionboolean
enable-cluster-resolverboolean
enable-custom-tasksboolean
enable-git-resolverboolean
enable-hub-resolverboolean
enable-param-enumboolean
enable-provenance-in-statusboolean
enable-step-actionsboolean
enable-tekton-oci-bundlesboolean

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-nonfalsifiabilitystring
git-resolver-configobject
hub-resolver-configobject
keep-pod-on-cancelboolean
max-result-sizeinteger
metrics.count.enable-reasonboolean
metrics.pipelinerun.duration-typestring
metrics.pipelinerun.levelstring
metrics.taskrun.duration-typestring
metrics.taskrun.levelstring
optionsobject

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

paramsarray

The params to customize different components of Pipelines

performanceobject

PerformanceProperties defines the fields which are configurable to tune the performance of component controller

require-git-ssh-secret-known-hostsboolean
results-fromstring
running-in-environment-with-injected-sidecarsboolean
scope-when-expressions-to-taskboolean

ScopeWhenExpressionsToTask is deprecated and never used.

send-cloudevents-for-runsboolean

Deprecated: send-cloudevents-for-runs is deprecated in tektoncd/pipeline v1.12.0 (https://github.com/tektoncd/pipeline/pull/9774) and will be removed in a future release. CloudEvents for CustomRuns are now enabled by default when a sink is configured in the config-events ConfigMap. This field only affects CustomRun objects; it has no effect on TaskRuns or PipelineRuns. Set to false only to suppress duplicate events when a custom task controller already sends its own CloudEvents.

set-security-contextboolean
traces.credentialsSecretstring

CredentialsSecret is the name of the secret containing credentials for the tracing endpoint

traces.enabledboolean

Enabled controls whether tracing is enabled or not

traces.endpointstring

Endpoint is the URL for the OpenTelemetry trace collector

trusted-resources-verification-no-match-policystring
verification-modestring

.spec.pipeline.bundles-resolver-config

Type
object

.spec.pipeline.cluster-resolver-config

Type
object

.spec.pipeline.git-resolver-config

Type
object

.spec.pipeline.hub-resolver-config

Type
object

.spec.pipeline.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.pipeline.options.configMaps

Type
object

.spec.pipeline.options.deployments

Type
object

.spec.pipeline.options.horizontalPodAutoscalers

Type
object

.spec.pipeline.options.ingress

Type
object

.spec.pipeline.options.statefulSets

Type
object

.spec.pipeline.options.webhookConfigurationOptions

Type
object

.spec.pipeline.params

Description
The params to customize different components of Pipelines
Type
array

.spec.pipeline.params[]

Description
Param declares an string value to use for the parameter called name.
Type
object
PropertyTypeDescription
namestring
valuestring

.spec.pipeline.performance

Description
PerformanceProperties defines the fields which are configurable to tune the performance of component controller
Type
object
Required
disable-ha
PropertyTypeDescription
bucketsinteger
disable-haboolean

if it is true, disables the HA feature

kube-api-burstinteger
kube-api-qpsnumber

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

replicasinteger
statefulset-ordinalsboolean

if is true, enable StatefulsetOrdinals mode

threads-per-controllerinteger

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

.spec.platforms

Description
Platforms allows configuring platform specific configurations
Type
object
PropertyTypeDescription
kubernetesobject

Kubernetes allows configuring kubernetes specific components and configurations

openshiftobject

OpenShift allows configuring openshift specific components and configurations

.spec.platforms.kubernetes

Description
Kubernetes allows configuring kubernetes specific components and configurations
Type
object
PropertyTypeDescription
pipelinesAsCodeobject

PipelinesAsCode allows configuring PipelinesAsCode configurations

.spec.platforms.kubernetes.pipelinesAsCode

Description
PipelinesAsCode allows configuring PipelinesAsCode configurations
Type
object
PropertyTypeDescription
additionalPACControllersobject

AdditionalPACControllers allows to deploy additional PAC controller

enableboolean

Enable or disable pipelines as code by changing this bool

optionsobject

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

settingsobject

.spec.platforms.kubernetes.pipelinesAsCode.additionalPACControllers

Description
AdditionalPACControllers allows to deploy additional PAC controller
Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.platforms.kubernetes.pipelinesAsCode.options.configMaps

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options.deployments

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options.horizontalPodAutoscalers

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options.ingress

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options.statefulSets

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.options.webhookConfigurationOptions

Type
object

.spec.platforms.kubernetes.pipelinesAsCode.settings

Type
object

.spec.platforms.openshift

Description
OpenShift allows configuring openshift specific components and configurations
Type
object
PropertyTypeDescription
enableCentralTLSConfigboolean

EnableCentralTLSConfig controls TLS configuration inheritance from the cluster's APIServer TLS security profile. When enabled (the default), TLS settings (minimum version, cipher suites, curve preferences) are automatically derived from the cluster-wide security policy and injected into Tekton component containers that support TLS configuration. Set to false to opt out and manage TLS settings manually. Default: true (opt-out)

pipelinesAsCodeobject

PipelinesAsCode allows configuring PipelinesAsCode configurations

sccobject

SCC allows configuring security context constraints used by workloads

.spec.platforms.openshift.pipelinesAsCode

Description
PipelinesAsCode allows configuring PipelinesAsCode configurations
Type
object
PropertyTypeDescription
additionalPACControllersobject

AdditionalPACControllers allows to deploy additional PAC controller

enableboolean

Enable or disable pipelines as code by changing this bool

optionsobject

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

settingsobject

.spec.platforms.openshift.pipelinesAsCode.additionalPACControllers

Description
AdditionalPACControllers allows to deploy additional PAC controller
Type
object

.spec.platforms.openshift.pipelinesAsCode.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.platforms.openshift.pipelinesAsCode.options.configMaps

Type
object

.spec.platforms.openshift.pipelinesAsCode.options.deployments

Type
object

.spec.platforms.openshift.pipelinesAsCode.options.horizontalPodAutoscalers

Type
object

.spec.platforms.openshift.pipelinesAsCode.options.ingress

Type
object

.spec.platforms.openshift.pipelinesAsCode.options.statefulSets

Type
object

.spec.platforms.openshift.pipelinesAsCode.options.webhookConfigurationOptions

Type
object

.spec.platforms.openshift.pipelinesAsCode.settings

Type
object

.spec.platforms.openshift.scc

Description
SCC allows configuring security context constraints used by workloads
Type
object
PropertyTypeDescription
defaultstring

Default contains the default SCC that will be attached to the service account used for workloads (pipeline SA by default) and defined in PipelineProperties.OptionalPipelineProperties.DefaultServiceAccount

maxAllowedstring

MaxAllowed specifies the highest SCC that can be requested for in a namespace or in the Default field.

.spec.pruner

Description
Pruner holds the prune config
Type
object
Required
disabled
PropertyTypeDescription
disabledboolean

enable or disable pruner feature

keepinteger

The number of resource to keep You dont want to delete all the pipelinerun/taskrun's by a cron

keep-sinceinteger

KeepSince keeps the resources younger than the specified value Its value is taken in minutes

prune-per-resourceboolean

apply the prune job to the individual resources

resourcesarray

The resources which need to be pruned

schedulestring

How frequent pruning should happen

startingDeadlineSecondsinteger

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

.spec.pruner.resources

Description
The resources which need to be pruned
Type
array

.spec.pruner.resources[]

Type
string

.spec.result

Description
Result holds the customize option for results component
Type
object
Required
disabledis_external_db
PropertyTypeDescription
auth_disableboolean
auth_impersonateboolean
db_enable_auto_migrationboolean
db_hoststring
db_namestring
db_portinteger
db_secret_namestring
db_secret_password_keystring
db_secret_user_keystring
db_sslmodestring
db_sslrootcertstring
disabledboolean

enable or disable Result Component

gcs_bucket_namestring
gcs_creds_secret_keystring
gcs_creds_secret_namestring
is_external_dbboolean
log_levelstring
logging_plugin_api_urlstring
logging_plugin_ca_certstring
logging_plugin_forwarder_delay_durationinteger
logging_plugin_multipart_regexstring
logging_plugin_namespace_keystring
logging_plugin_proxy_pathstring
logging_plugin_query_limitinteger
logging_plugin_query_paramsstring
logging_plugin_static_labelsstring
logging_plugin_tls_verification_disableboolean
logging_plugin_token_pathstring
logging_pvc_namestring
logs_apiboolean
logs_buffer_sizeinteger
logs_pathstring
logs_typestring
loki_stack_namestring
loki_stack_namespacestring
optionsobject

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

performanceobject

PerformanceProperties defines the fields which are configurable to tune the performance of component controller

prometheus_histogramboolean
prometheus_portinteger
route_enabledboolean

Route configuration for Results API service exposure

route_hoststring
route_pathstring
route_tls_terminationstring
secret_namestring

name of the secret used to get S3 credentials and pass it as environment variables to the "tekton-results-api" deployment under "api" container

server_portinteger
storage_emulator_hoststring
tls_hostname_overridestring

.spec.result.options

Description
Options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.result.options.configMaps

Type
object

.spec.result.options.deployments

Type
object

.spec.result.options.horizontalPodAutoscalers

Type
object

.spec.result.options.ingress

Type
object

.spec.result.options.statefulSets

Type
object

.spec.result.options.webhookConfigurationOptions

Type
object

.spec.result.performance

Description
PerformanceProperties defines the fields which are configurable to tune the performance of component controller
Type
object
Required
disable-ha
PropertyTypeDescription
bucketsinteger
disable-haboolean

if it is true, disables the HA feature

kube-api-burstinteger
kube-api-qpsnumber

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

replicasinteger
statefulset-ordinalsboolean

if is true, enable StatefulsetOrdinals mode

threads-per-controllerinteger

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

.spec.scheduler

Description
To enable Pipeline Scheduling on Single Cluster or Multiple Clusters
Type
object
Required
config.yamldisabledmulti-cluster-disabledmulti-cluster-role
PropertyTypeDescription
config.yaml

This hold the config data from tekton-kueue. ConfigMap in tekton kueue is loaded as config.yaml so we need to match the key here

disabledboolean

enable or disable TektonScheduler Component

multi-cluster-disabledboolean
multi-cluster-rolestring

MultiClusterRole Define the role of current cluster in multi-cluster environment. The MultiClusterRole can be one of Hub or Spoke

optionsobject

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

.spec.scheduler.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.scheduler.options.configMaps

Type
object

.spec.scheduler.options.deployments

Type
object

.spec.scheduler.options.horizontalPodAutoscalers

Type
object

.spec.scheduler.options.ingress

Type
object

.spec.scheduler.options.statefulSets

Type
object

.spec.scheduler.options.webhookConfigurationOptions

Type
object

.spec.targetNamespaceMetadata

Description
holds target namespace metadata
Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.targetNamespaceMetadata.annotations

Type
object

.spec.targetNamespaceMetadata.labels

Type
object

.spec.tektonpruner

Description
New EventBasedPruner which provides more granular control over TaskRun and PipelineRuns
Type
object
Required
disabledglobal-config
PropertyTypeDescription
disabledboolean

enable or disable TektonPruner Component

global-config
optionsobject

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

.spec.tektonpruner.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.tektonpruner.options.configMaps

Type
object

.spec.tektonpruner.options.deployments

Type
object

.spec.tektonpruner.options.horizontalPodAutoscalers

Type
object

.spec.tektonpruner.options.ingress

Type
object

.spec.tektonpruner.options.statefulSets

Type
object

.spec.tektonpruner.options.webhookConfigurationOptions

Type
object

.spec.trigger

Description
Trigger holds the customizable option for triggers component
Type
object
Required
disabled
PropertyTypeDescription
default-service-accountstring
disabledboolean

enable or disable Trigger Component

enable-api-fieldsstring
optionsobject

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

.spec.trigger.options

Description
options holds additions fields and these fields will be updated on the manifests
Type
object
PropertyTypeDescription
configMapsobject
deploymentsobject
disabledboolean
horizontalPodAutoscalersobject
ingressobject
statefulSetsobject
webhookConfigurationOptionsobject

.spec.trigger.options.configMaps

Type
object

.spec.trigger.options.deployments

Type
object

.spec.trigger.options.horizontalPodAutoscalers

Type
object

.spec.trigger.options.ingress

Type
object

.spec.trigger.options.statefulSets

Type
object

.spec.trigger.options.webhookConfigurationOptions

Type
object

.status

Description
TektonConfigStatus defines the observed state of TektonConfig
Type
object
PropertyTypeDescription
annotationsobject

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.

conditionsarray

Conditions the latest available observations of a resource's current state.

observedGenerationinteger

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

profilestring

The profile installed

tektonInstallerSetsobject

The current installer set name

versionstring

The version of the installed release

.status.annotations

Description
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.
Type
object

.status.conditions

Description
Conditions the latest available observations of a resource's current state.
Type
array

.status.conditions[]

Description
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
Type
object
Required
statustype
PropertyTypeDescription
lastTransitionTimestring

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).

messagestring

A human readable message indicating details about the transition.

reasonstring

The reason for the condition's last transition.

severitystring

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

statusstring

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

typestring

Type of condition.

.status.tektonInstallerSets

Description
The current installer set name
Type
object

API Endpoints

The following API endpoints are available:

  • /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs
    • DELETE: delete collection of TektonConfig
    • GET: list objects of kind TektonConfig
    • POST: create a new TektonConfig
  • /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs/{name}
    • DELETE: delete the specified TektonConfig
    • GET: read the specified TektonConfig
    • PATCH: partially update the specified TektonConfig
    • PUT: replace the specified TektonConfig
  • /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs/{name}/status
    • GET: read status of the specified TektonConfig
    • PATCH: partially update status of the specified TektonConfig
    • PUT: replace status of the specified TektonConfig

/apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs

HTTP method
DELETE
Description
delete collection of TektonConfig
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind TektonConfig
HTTP responses
HTTP codeResponse body
200 - OKTektonConfigList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyTektonConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
201 - CreatedTektonConfig schema
202 - AcceptedTektonConfig schema
401 - UnauthorizedEmpty

/apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs/{name}

HTTP method
DELETE
Description
delete the specified TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified TektonConfig
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyTektonConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
201 - CreatedTektonConfig schema
401 - UnauthorizedEmpty

/apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonconfigs/{name}/status

HTTP method
GET
Description
read status of the specified TektonConfig
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified TektonConfig
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyTektonConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKTektonConfig schema
201 - CreatedTektonConfig schema
401 - UnauthorizedEmpty