• Русский
  • Run [tekton.dev/v1]

    Description
    Run represents a single execution of a Custom Task.
    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

    RunSpec defines the desired state of Run

    statusobject

    RunStatus defines the observed state of Run

    .spec

    Description
    RunSpec defines the desired state of Run
    Type
    object
    PropertyTypeDescription
    paramsarray

    Params is a list of Param

    podTemplateobject

    PodTemplate holds pod specific configuration

    refobject

    TaskRef can be used to refer to a specific instance of a task.

    retriesinteger

    Used for propagating retries count to custom tasks

    serviceAccountNamestring
    specobject

    Spec is a specification of a custom task

    statusstring

    Used for cancelling a run (and maybe more later on)

    statusMessagestring

    Status message for cancellation.

    timeoutstring

    Time after which the custom-task times out. Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

    workspacesarray

    Workspaces is a list of WorkspaceBindings from volumes to workspaces.

    .spec.params

    Description
    Params is a list of Param
    Type
    array

    .spec.params[]

    Description
    Param declares an ParamValues to use for the parameter called name.
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring
    value

    .spec.podTemplate

    Description
    PodTemplate holds pod specific configuration
    Type
    object
    PropertyTypeDescription
    affinity

    If specified, the pod's scheduling constraints. See Pod.spec.affinity (API version: v1)

    automountServiceAccountTokenboolean

    AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.

    dnsConfigobject

    Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

    dnsPolicystring

    Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.

    enableServiceLinksboolean

    EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

    envarray

    List of environment variables that can be provided to the containers belonging to the pod.

    hostAliasesarray

    HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.

    hostNetworkboolean

    HostNetwork specifies whether the pod may use the node network namespace

    imagePullSecretsarray

    ImagePullSecrets gives the name of the secret used by the pod to pull the image if specified

    nodeSelectorobject

    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

    priorityClassNamestring

    If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.

    runtimeClassNamestring

    RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.

    schedulerNamestring

    SchedulerName specifies the scheduler to be used to dispatch the Pod

    securityContext

    SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. See Pod.spec.securityContext (API version: v1)

    tolerationsarray

    If specified, the pod's tolerations.

    topologySpreadConstraintsarray

    TopologySpreadConstraints controls how Pods are spread across your cluster among failure-domains such as regions, zones, nodes, and other user-defined topology domains.

    volumes

    List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes See Pod.spec.volumes (API version: v1)

    .spec.podTemplate.dnsConfig

    Description
    Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
    Type
    object
    PropertyTypeDescription
    nameserversarray

    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

    optionsarray

    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

    searchesarray

    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

    .spec.podTemplate.dnsConfig.nameservers

    Description
    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
    Type
    array

    .spec.podTemplate.dnsConfig.nameservers[]

    Type
    string

    .spec.podTemplate.dnsConfig.options

    Description
    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
    Type
    array

    .spec.podTemplate.dnsConfig.options[]

    Description
    PodDNSConfigOption defines DNS resolver options of a pod.
    Type
    object
    PropertyTypeDescription
    namestring

    Name is this DNS resolver option's name. Required.

    valuestring

    Value is this DNS resolver option's value.

    .spec.podTemplate.dnsConfig.searches

    Description
    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
    Type
    array

    .spec.podTemplate.dnsConfig.searches[]

    Type
    string

    .spec.podTemplate.env

    Description
    List of environment variables that can be provided to the containers belonging to the pod.
    Type
    array

    .spec.podTemplate.env[]

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

    Name of the environment variable. Must be a C_IDENTIFIER.

    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.podTemplate.env[].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.

    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.podTemplate.env[].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.podTemplate.env[].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.podTemplate.env[].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.podTemplate.env[].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.podTemplate.hostAliases

    Description
    HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
    Type
    array

    .spec.podTemplate.hostAliases[]

    Description
    HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
    Type
    object
    Required
    ip
    PropertyTypeDescription
    hostnamesarray

    Hostnames for the above IP address.

    ipstring

    IP address of the host file entry.

    .spec.podTemplate.hostAliases[].hostnames

    Description
    Hostnames for the above IP address.
    Type
    array

    .spec.podTemplate.hostAliases[].hostnames[]

    Type
    string

    .spec.podTemplate.imagePullSecrets

    Description
    ImagePullSecrets gives the name of the secret used by the pod to pull the image if specified
    Type
    array

    .spec.podTemplate.imagePullSecrets[]

    Description
    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
    Type
    object
    PropertyTypeDescription
    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

    .spec.podTemplate.nodeSelector

    Description
    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
    Type
    object

    .spec.podTemplate.tolerations

    Description
    If specified, the pod's tolerations.
    Type
    array

    .spec.podTemplate.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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    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.podTemplate.topologySpreadConstraints

    Description
    TopologySpreadConstraints controls how Pods are spread across your cluster among failure-domains such as regions, zones, nodes, and other user-defined topology domains.
    Type
    array

    .spec.podTemplate.topologySpreadConstraints[]

    Description
    TopologySpreadConstraint specifies how to spread matching pods among the given topology.
    Type
    object
    Required
    maxSkewtopologyKeywhenUnsatisfiable
    PropertyTypeDescription
    labelSelectorobject

    LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.

    This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).

    maxSkewinteger

    MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P |

    • if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1).
    • if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
    minDomainsinteger

    MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

    For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

    nodeAffinityPolicystring

    NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are:

    • Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
    • Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

    If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

    nodeTaintsPolicystring

    NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are:

    • Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included.
    • Ignore: node taints are ignored. All nodes are included.

    If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

    topologyKeystring

    TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.

    whenUnsatisfiablestring

    WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.

    • DoNotSchedule (default) tells the scheduler not to schedule it.
    • ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

    .spec.podTemplate.topologySpreadConstraints[].labelSelector

    Description
    LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.podTemplate.topologySpreadConstraints[].labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.podTemplate.topologySpreadConstraints[].labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.podTemplate.topologySpreadConstraints[].labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.podTemplate.topologySpreadConstraints[].labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.podTemplate.topologySpreadConstraints[].labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.podTemplate.topologySpreadConstraints[].matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
    Type
    array

    .spec.podTemplate.topologySpreadConstraints[].matchLabelKeys[]

    Type
    string

    .spec.ref

    Description
    TaskRef can be used to refer to a specific instance of a task.
    Type
    object
    PropertyTypeDescription
    apiVersionstring

    API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task

    bundlestring

    Bundle url reference to a Tekton Bundle.

    Deprecated: Please use ResolverRef with the bundles resolver instead. The field is staying there for go client backward compatibility, but is not used/allowed anymore.

    kindstring

    TaskKind indicates the Kind of the Task:

    1. Namespaced Task when Kind is set to "Task". If Kind is "", it defaults to "Task".
    2. Custom Task when Kind is non-empty and APIVersion is non-empty
    namestring

    Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

    paramsarray

    Params contains the parameters used to identify the referenced Tekton resource. Example entries might include "repo" or "path" but the set of params ultimately depends on the chosen resolver.

    resolverstring

    Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".

    .spec.ref.params

    Description
    Params contains the parameters used to identify the referenced Tekton resource. Example entries might include "repo" or "path" but the set of params ultimately depends on the chosen resolver.
    Type
    array

    .spec.ref.params[]

    Description
    Param declares an ParamValues to use for the parameter called name.
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring
    value

    .spec.spec

    Description
    Spec is a specification of a custom task
    Type
    object
    PropertyTypeDescription
    apiVersionstring
    kindstring
    metadataObjectMeta

    PipelineTaskMetadata contains the labels or annotations for an EmbeddedTask

    specobject

    Spec is a specification of a custom task

    .spec.spec.spec

    Description
    Spec is a specification of a custom task
    Type
    object

    .spec.workspaces

    Description
    Workspaces is a list of WorkspaceBindings from volumes to workspaces.
    Type
    array

    .spec.workspaces[]

    Description
    WorkspaceBinding maps a Task's declared workspace to a Volume.
    Type
    object
    Required
    name
    PropertyTypeDescription
    configMapobject

    ConfigMap represents a configMap that should populate this workspace.

    csiobject

    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

    emptyDirobject

    EmptyDir represents a temporary directory that shares a Task's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.

    namestring

    Name is the name of the workspace populated by the volume.

    persistentVolumeClaimobject

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.

    projectedobject

    Projected represents a projected volume that should populate this workspace.

    secretobject

    Secret represents a secret that should populate this workspace.

    subPathstring

    SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).

    volumeClaimTemplate

    VolumeClaimTemplate is a template for a claim that will be created in the same namespace. The PipelineRun controller is responsible for creating a unique claim for each instance of PipelineRun. See PersistentVolumeClaim (API version: v1)

    .spec.workspaces[].configMap

    Description
    ConfigMap represents a configMap that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    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

    optional specify whether the ConfigMap or its keys must be defined

    .spec.workspaces[].configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].csi

    Description
    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

    driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

    fsTypestring

    fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

    nodePublishSecretRefobject

    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

    readOnlyboolean

    readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

    volumeAttributesobject

    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

    .spec.workspaces[].csi.nodePublishSecretRef

    Description
    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
    Type
    object
    PropertyTypeDescription
    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

    .spec.workspaces[].csi.volumeAttributes

    Description
    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
    Type
    object

    .spec.workspaces[].emptyDir

    Description
    EmptyDir represents a temporary directory that shares a Task's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.
    Type
    object
    PropertyTypeDescription
    mediumstring

    medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    sizeLimit

    sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    .spec.workspaces[].persistentVolumeClaim

    Description
    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
    Type
    object
    Required
    claimName
    PropertyTypeDescription
    claimNamestring

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    readOnlyboolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

    .spec.workspaces[].projected

    Description
    Projected represents a projected volume that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    sourcesarray

    sources is the list of volume projections. Each entry in this list handles one source.

    .spec.workspaces[].projected.sources

    Description
    sources is the list of volume projections. Each entry in this list handles one source.
    Type
    array

    .spec.workspaces[].projected.sources[]

    Description
    Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
    Type
    object
    PropertyTypeDescription
    clusterTrustBundleobject

    ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

    Alpha, gated by the ClusterTrustBundleProjection feature gate.

    ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

    Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

    configMapobject

    configMap information about the configMap data to project

    downwardAPIobject

    downwardAPI information about the downwardAPI data to project

    secretobject

    secret information about the secret data to project

    serviceAccountTokenobject

    serviceAccountToken is information about the serviceAccountToken data to project

    .spec.workspaces[].projected.sources[].clusterTrustBundle

    Description
    ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
    Type
    object
    Required
    path
    PropertyTypeDescription
    labelSelectorobject

    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

    namestring

    Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

    optionalboolean

    If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.

    pathstring

    Relative path from the volume root to write the bundle.

    signerNamestring

    Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector

    Description
    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.workspaces[].projected.sources[].clusterTrustBundle.labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.workspaces[].projected.sources[].configMap

    Description
    configMap information about the configMap data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    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

    optional specify whether the ConfigMap or its keys must be defined

    .spec.workspaces[].projected.sources[].configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].projected.sources[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].projected.sources[].downwardAPI

    Description
    downwardAPI information about the downwardAPI data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    Items is a list of DownwardAPIVolume file

    .spec.workspaces[].projected.sources[].downwardAPI.items

    Description
    Items is a list of DownwardAPIVolume file
    Type
    array

    .spec.workspaces[].projected.sources[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

    modeinteger

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

    resourceFieldRefobject

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

    .spec.workspaces[].projected.sources[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
    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.workspaces[].projected.sources[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) 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.workspaces[].projected.sources[].secret

    Description
    secret information about the secret data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    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

    optional field specify whether the Secret or its key must be defined

    .spec.workspaces[].projected.sources[].secret.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].projected.sources[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].projected.sources[].serviceAccountToken

    Description
    serviceAccountToken is information about the serviceAccountToken data to project
    Type
    object
    Required
    path
    PropertyTypeDescription
    audiencestring

    audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

    expirationSecondsinteger

    expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

    pathstring

    path is the path relative to the mount point of the file to project the token into.

    .spec.workspaces[].secret

    Description
    Secret represents a secret that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    optionalboolean

    optional field specify whether the Secret or its keys must be defined

    secretNamestring

    secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    .spec.workspaces[].secret.items

    Description
    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .status

    Description
    RunStatus defines the observed state of Run
    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.

    completionTimestring

    CompletionTime is the time the build completed.

    conditionsarray

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

    extraFieldsobject

    ExtraFields holds arbitrary fields provided by the custom task controller.

    observedGenerationinteger

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

    resultsarray

    Results reports any output result values to be consumed by later tasks in a pipeline.

    retriesStatusarray

    RetriesStatus contains the history of RunStatus, in case of a retry.

    startTimestring

    StartTime is the time the build is actually started.

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

    Description
    ExtraFields holds arbitrary fields provided by the custom task controller.
    Type
    object

    .status.results

    Description
    Results reports any output result values to be consumed by later tasks in a pipeline.
    Type
    array

    .status.results[]

    Description
    RunResult used to describe the results of a task
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    Name the given name

    valuestring

    Value the given value of the result

    .status.retriesStatus

    Description
    RetriesStatus contains the history of RunStatus, in case of a retry.
    Type
    array

    .status.retriesStatus[]

    Type

    API Endpoints

    The following API endpoints are available:

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

    /apis/tekton.dev/v1alpha1/namespaces/{namespace}/runs

    HTTP method
    DELETE
    Description
    delete collection of Run
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind Run
    HTTP responses
    HTTP codeResponse body
    200 - OKRunList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new Run
    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
    bodyRun schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKRun schema
    201 - CreatedRun schema
    202 - AcceptedRun schema
    401 - UnauthorizedEmpty

    /apis/tekton.dev/v1alpha1/namespaces/{namespace}/runs/{name}

    HTTP method
    DELETE
    Description
    delete the specified Run
    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 Run
    HTTP responses
    HTTP codeResponse body
    200 - OKRun schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified Run
    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 - OKRun schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified Run
    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
    bodyRun schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKRun schema
    201 - CreatedRun schema
    401 - UnauthorizedEmpty

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

    HTTP method
    GET
    Description
    read status of the specified Run
    HTTP responses
    HTTP codeResponse body
    200 - OKRun schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update status of the specified Run
    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 - OKRun schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace status of the specified Run
    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
    bodyRun schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKRun schema
    201 - CreatedRun schema
    401 - UnauthorizedEmpty