tekton.dev
group
TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.
v1
versionobject
TaskRunSpec defines the desired state of TaskRun
object
Compute resources to use for this TaskRun
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
TaskRunDebug defines the breakpoint config for a particular TaskRun
object
TaskBreakpoints defines the breakpoint config for a particular Task
[]string
string
if enabled, pause TaskRun on failure of a step failed step will not exit
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredobject
PodTemplate holds pod specific configuration
If specified, the pod's scheduling constraints. See Pod.spec.affinity (API version: v1)
boolean
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.
object
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
[]string
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
[]object
PodDNSConfigOption defines DNS resolver options of a pod.
string
Name is this DNS resolver option's name. Required.
string
Value is this DNS resolver option's value.
[]string
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.
string
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.
boolean
EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
[]object
EnvVar represents an environment variable present in a Container.
string
requiredName of the environment variable. Must be a C_IDENTIFIER.
string
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 "".
object
Source for the environment variable's value. Cannot be used if value is not empty.
object
Selects a key of a ConfigMap.
string
requiredThe key to select.
string
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
boolean
Specify whether the ConfigMap or its key must be defined
object
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.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
object
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.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
Selects a key of a secret in the pod's namespace
string
requiredThe key of the secret to select from. Must be a valid secret key.
string
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
boolean
Specify whether the Secret or its key must be defined
[]object
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
[]string
Hostnames for the above IP address.
string
requiredIP address of the host file entry.
boolean
HostNetwork specifies whether the pod may use the node network namespace
[]object
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
string
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
object
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/
string
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.
string
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.
string
SchedulerName specifies the scheduler to be used to dispatch the Pod
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)
[]object
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
string
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
[]object
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
object
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.
[]object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
string
requiredkey is the label key that the selector applies to.
string
requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
[]string
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.
object
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.
[]string
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).
integer
requiredMaxSkew 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 |
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.integer
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.
string
NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are:
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.
string
NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are:
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.
string
requiredTopologyKey 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.
string
requiredWhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
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)
integer
Retries represents how many times this TaskRun should be retried in the event of task failure.
string
[]object
TaskRunSidecarSpec is used to override the values of a Sidecar in the corresponding Task.
object
requiredThe resource requirements to apply to the Sidecar.
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
string
requiredThe name of the Sidecar to override.
string
Used for cancelling a TaskRun (and maybe more later on)
string
Status message for cancellation.
[]object
TaskRunStepSpec is used to override the values of a Step in the corresponding Task.
object
requiredThe resource requirements to apply to the Step.
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
string
requiredThe name of the Step to override.
object
no more than one of the TaskRef and TaskSpec may be specified.
string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
string
TaskKind indicates the Kind of the Task:
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredstring
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
Specifying TaskSpec can be disabled by setting
disable-inline-spec
feature flag.
See Task.spec (API version: tekton.dev/v1)
string
Time after which one retry attempt times out. Defaults to 1 hour. Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
[]object
WorkspaceBinding maps a Task's declared workspace to a Volume.
object
ConfigMap represents a configMap that should populate this workspace.
integer
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.
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional specify whether the ConfigMap or its keys must be defined
object
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
string
requireddriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
string
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.
object
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.
string
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
boolean
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
object
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
object
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.
string
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 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
string
requiredName is the name of the workspace populated by the volume.
object
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
string
requiredclaimName 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
boolean
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
object
Projected represents a projected volume that should populate this workspace.
integer
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.
[]object
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
object
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.
object
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".
[]object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
string
requiredkey is the label key that the selector applies to.
string
requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
[]string
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.
object
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.
string
Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
boolean
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.
string
requiredRelative path from the volume root to write the bundle.
string
Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
object
configMap information about the configMap data to project
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional specify whether the ConfigMap or its keys must be defined
object
downwardAPI information about the downwardAPI data to project
[]object
DownwardAPIVolumeFile represents information to create the file containing the pod field
object
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
integer
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.
string
requiredRequired: 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 '..'
object
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
secret information about the secret data to project
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional field specify whether the Secret or its key must be defined
object
serviceAccountToken is information about the serviceAccountToken data to project
string
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.
integer
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.
string
requiredpath is the path relative to the mount point of the file to project the token into.
object
Secret represents a secret that should populate this workspace.
integer
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.
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
boolean
optional field specify whether the Secret or its keys must be defined
string
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
string
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 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)
object
TaskRunStatus defines the observed state of TaskRun
object
Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
object
Artifacts are the list of artifacts written out by the task's containers
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
string
CompletionTime is the time the build completed.
[]object
Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
string
LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).
string
A human readable message indicating details about the transition.
string
The reason for the condition's last transition.
string
Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.
string
requiredStatus of the condition, one of True, False, Unknown.
string
requiredType of condition.
integer
ObservedGeneration is the 'Generation' of the Service that was last processed by the controller.
string
requiredPodName is the name of the pod responsible for executing this task's steps.
object
Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
object
FeatureFlags identifies the feature flags that were used during the task/pipeline run
boolean
string
boolean
string
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
EnableStepActions is a no-op flag since StepActions are stable
string
integer
boolean
string
boolean
boolean
boolean
boolean
string
VerificationNoMatchPolicy is the feature flag for "trusted-resources-verification-no-match-policy" VerificationNoMatchPolicy can be set to "ignore", "warn" and "fail" values. ignore: skip trusted resources verification when no matching verification policies found warn: skip trusted resources verification when no matching verification policies found and log a warning fail: fail the taskrun or pipelines run if no matching verification policies found
object
RefSource identifies the source where a remote task/pipeline came from.
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
[]object
TaskRunResult used to describe the results of a task
string
requiredName the given name
string
Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.
Value the given value of the result
RetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant.
[]object
SidecarState reports the results of running a sidecar in a Task.
string
string
string
object
Details about a running container
string
Time at which the container was last (re-)started
object
Details about a terminated container
string
Container's ID in the format '://<container_id>'
integer
requiredExit status from the last termination of the container
string
Time at which the container last terminated
string
Message regarding the last termination of the container
string
(brief) reason from the last termination of the container
integer
Signal from the last termination of the container
string
Time at which previous execution of the container started
object
Details about a waiting container
string
Message regarding why the container is not yet running.
string
(brief) reason the container is not yet running.
object
SpanContext contains tracing span context fields
string
StartTime is the time the build is actually started.
[]object
StepState reports the results of running a step in a Task.
string
string
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
string
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
object
Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched. This field aims to carry minimum amoumt of metadata in *Run status so that Tekton Chains can capture them in the provenance.
object
FeatureFlags identifies the feature flags that were used during the task/pipeline run
boolean
string
boolean
string
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
EnableStepActions is a no-op flag since StepActions are stable
string
integer
boolean
string
boolean
boolean
boolean
boolean
string
VerificationNoMatchPolicy is the feature flag for "trusted-resources-verification-no-match-policy" VerificationNoMatchPolicy can be set to "ignore", "warn" and "fail" values. ignore: skip trusted resources verification when no matching verification policies found warn: skip trusted resources verification when no matching verification policies found and log a warning fail: fail the taskrun or pipelines run if no matching verification policies found
object
RefSource identifies the source where a remote task/pipeline came from.
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
[]object
TaskRunResult used to describe the results of a task
string
requiredName the given name
string
Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.
Value the given value of the result
object
Details about a running container
string
Time at which the container was last (re-)started
object
Details about a terminated container
string
Container's ID in the format '://<container_id>'
integer
requiredExit status from the last termination of the container
string
Time at which the container last terminated
string
Message regarding the last termination of the container
string
(brief) reason from the last termination of the container
integer
Signal from the last termination of the container
string
Time at which previous execution of the container started
string
object
Details about a waiting container
string
Message regarding why the container is not yet running.
string
(brief) reason the container is not yet running.
object
TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun.
string
Description is a user-facing description of the task that may be used to populate a UI.
string
DisplayName is a user-facing name of the task that may be used to populate a UI.
[]object
ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.
Default is the value a parameter takes if no input value is supplied. If default is set, a Task may be executed without a supplied value for the parameter.
string
Description is a user-facing description of the parameter that may be used to populate a UI.
[]string
Enum declares a set of allowed param input values for tasks/pipelines that can be validated. If Enum is not set, no input validation is performed for the param.
string
requiredName declares the name by which a parameter is referenced.
object
Properties is the JSON Schema properties to support key-value pairs parameter.
string
Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.
[]object
TaskResult used to describe the results of a task
string
Description is a human-readable description of the result
string
requiredName the given name
object
Properties is the JSON Schema properties to support key-value pairs results.
string
Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.
Value the expression used to retrieve the value of the result from an underlying Step.
[]object
Sidecar has nearly the same data structure as Step but does not have the ability to timeout.
[]string
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
[]string
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Sidecar's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
object
ComputeResources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
EnvVar represents an environment variable present in a Container.
string
requiredName of the environment variable. Must be a C_IDENTIFIER.
string
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 "".
object
Source for the environment variable's value. Cannot be used if value is not empty.
object
Selects a key of a ConfigMap.
string
requiredThe key to select.
string
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
boolean
Specify whether the ConfigMap or its key must be defined
object
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.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
object
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.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
Selects a key of a secret in the pod's namespace
string
requiredThe key of the secret to select from. Must be a valid secret key.
string
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
boolean
Specify whether the Secret or its key must be defined
[]object
EnvFromSource represents the source of a set of ConfigMaps
object
The ConfigMap to select from
string
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
boolean
Specify whether the ConfigMap must be defined
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
object
The Secret to select from
string
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
boolean
Specify whether the Secret must be defined
string
Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images
string
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
object
Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.
object
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Exec specifies a command to execute in the container.
[]string
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
object
HTTPGet specifies an HTTP GET request to perform.
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
[]object
HTTPHeader describes a custom header to be used in HTTP probes
string
requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string
requiredThe header field value
string
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
string
Scheme to use for connecting to the host. Defaults to HTTP.
object
Sleep represents a duration that the container should sleep.
integer
requiredSeconds is the number of seconds to sleep.
object
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
object
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Exec specifies a command to execute in the container.
[]string
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
object
HTTPGet specifies an HTTP GET request to perform.
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
[]object
HTTPHeader describes a custom header to be used in HTTP probes
string
requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string
requiredThe header field value
string
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
string
Scheme to use for connecting to the host. Defaults to HTTP.
object
Sleep represents a duration that the container should sleep.
integer
requiredSeconds is the number of seconds to sleep.
object
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
string
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
object
Periodic probe of Sidecar liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Exec specifies a command to execute in the container.
[]string
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
integer
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
object
GRPC specifies a GRPC HealthCheckRequest.
integer
requiredPort number of the gRPC service. Number must be in the range 1 to 65535.
string
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
object
HTTPGet specifies an HTTP GET request to perform.
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
[]object
HTTPHeader describes a custom header to be used in HTTP probes
string
requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string
requiredThe header field value
string
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
string
Scheme to use for connecting to the host. Defaults to HTTP.
integer
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
integer
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
integer
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
object
TCPSocket specifies a connection to a TCP port.
string
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
integer
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
integer
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
string
requiredName of the Sidecar specified as a DNS_LABEL. Each Sidecar in a Task must have a unique name (DNS_LABEL). Cannot be updated.
[]object
ContainerPort represents a network port in a single container.
integer
requiredNumber of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
string
What host IP to bind the external port to.
integer
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
string
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
string
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
object
Periodic probe of Sidecar service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Exec specifies a command to execute in the container.
[]string
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
integer
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
object
GRPC specifies a GRPC HealthCheckRequest.
integer
requiredPort number of the gRPC service. Number must be in the range 1 to 65535.
string
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
object
HTTPGet specifies an HTTP GET request to perform.
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
[]object
HTTPHeader describes a custom header to be used in HTTP probes
string
requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string
requiredThe header field value
string
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
string
Scheme to use for connecting to the host. Defaults to HTTP.
integer
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
integer
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
integer
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
object
TCPSocket specifies a connection to a TCP port.
string
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
integer
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
integer
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
string
RestartPolicy refers to kubernetes RestartPolicy. It can only be set for an initContainer and must have it's policy set to "Always". It is currently left optional to help support Kubernetes versions prior to 1.29 when this feature was introduced.
string
Script is the contents of an executable file to execute.
If Script is not empty, the Step cannot have an Command or Args.
object
SecurityContext defines the security options the Sidecar should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
boolean
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is:
object
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
string
requiredtype indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
object
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
[]string
Added capabilities
[]string
Removed capabilities
boolean
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
string
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
boolean
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
integer
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
boolean
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
integer
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
object
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
string
Level is SELinux level label that applies to the container.
string
Role is a SELinux role label that applies to the container.
string
Type is a SELinux type label that applies to the container.
string
User is a SELinux user label that applies to the container.
object
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
string
requiredtype indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
object
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
string
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
string
GMSACredentialSpecName is the name of the GMSA credential spec to use.
boolean
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
string
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
object
StartupProbe indicates that the Pod the Sidecar is running in has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Exec specifies a command to execute in the container.
[]string
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
integer
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
object
GRPC specifies a GRPC HealthCheckRequest.
integer
requiredPort number of the gRPC service. Number must be in the range 1 to 65535.
string
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
object
HTTPGet specifies an HTTP GET request to perform.
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
[]object
HTTPHeader describes a custom header to be used in HTTP probes
string
requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
string
requiredThe header field value
string
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
string
Scheme to use for connecting to the host. Defaults to HTTP.
integer
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
integer
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
integer
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
object
TCPSocket specifies a connection to a TCP port.
string
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
integer
Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
integer
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
boolean
Whether this Sidecar should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the Sidecar will always result in EOF. Default is false.
boolean
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on Sidecar start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the Sidecar is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
string
Optional: Path at which the file to which the Sidecar's termination message will be written is mounted into the Sidecar's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
string
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the Sidecar status message on both success and failure. FallbackToLogsOnError will use the last chunk of Sidecar log output if the termination message file is empty and the Sidecar exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
boolean
Whether this Sidecar should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
[]object
volumeDevice describes a mapping of a raw block device within a container.
string
requireddevicePath is the path inside of the container that the device will be mapped to.
string
requiredname must match the name of a persistentVolumeClaim in the pod
[]object
VolumeMount describes a mounting of a Volume within a container.
string
requiredPath within the container at which the volume should be mounted. Must not contain ':'.
string
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string
requiredThis must match the Name of a Volume.
boolean
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
string
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
string
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
string
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
string
Sidecar's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
[]object
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
string
requiredMountPath is the path that the workspace should be mounted to inside the Step or Sidecar, overriding any MountPath specified in the Task's WorkspaceDeclaration.
string
requiredName is the name of the workspace this Step or Sidecar wants access to.
object
StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.
[]string
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
[]string
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the Step's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
object
ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
EnvVar represents an environment variable present in a Container.
string
requiredName of the environment variable. Must be a C_IDENTIFIER.
string
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 "".
object
Source for the environment variable's value. Cannot be used if value is not empty.
object
Selects a key of a ConfigMap.
string
requiredThe key to select.
string
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
boolean
Specify whether the ConfigMap or its key must be defined
object
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.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
object
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.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
Selects a key of a secret in the pod's namespace
string
requiredThe key of the secret to select from. Must be a valid secret key.
string
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
boolean
Specify whether the Secret or its key must be defined
[]object
EnvFromSource represents the source of a set of ConfigMaps
object
The ConfigMap to select from
string
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
boolean
Specify whether the ConfigMap must be defined
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
object
The Secret to select from
string
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
boolean
Specify whether the Secret must be defined
string
Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images
string
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
object
SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
boolean
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is:
object
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
string
requiredtype indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
object
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
[]string
Added capabilities
[]string
Removed capabilities
boolean
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
string
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
boolean
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
integer
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
boolean
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
integer
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
object
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
string
Level is SELinux level label that applies to the container.
string
Role is a SELinux role label that applies to the container.
string
Type is a SELinux type label that applies to the container.
string
User is a SELinux user label that applies to the container.
object
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
string
requiredtype indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
object
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
string
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
string
GMSACredentialSpecName is the name of the GMSA credential spec to use.
boolean
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
string
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
[]object
volumeDevice describes a mapping of a raw block device within a container.
string
requireddevicePath is the path inside of the container that the device will be mapped to.
string
requiredname must match the name of a persistentVolumeClaim in the pod
[]object
VolumeMount describes a mounting of a Volume within a container.
string
requiredPath within the container at which the volume should be mounted. Must not contain ':'.
string
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string
requiredThis must match the Name of a Volume.
boolean
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
string
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
string
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
string
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
string
Step's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
[]object
Step runs a subcomponent of a Task
[]string
Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
[]string
Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. 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. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
object
ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
[]object
EnvVar represents an environment variable present in a Container.
string
requiredName of the environment variable. Must be a C_IDENTIFIER.
string
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 "".
object
Source for the environment variable's value. Cannot be used if value is not empty.
object
Selects a key of a ConfigMap.
string
requiredThe key to select.
string
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
boolean
Specify whether the ConfigMap or its key must be defined
object
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.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
object
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.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
Selects a key of a secret in the pod's namespace
string
requiredThe key of the secret to select from. Must be a valid secret key.
string
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
boolean
Specify whether the Secret or its key must be defined
[]object
EnvFromSource represents the source of a set of ConfigMaps
object
The ConfigMap to select from
string
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
boolean
Specify whether the ConfigMap must be defined
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
object
The Secret to select from
string
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
boolean
Specify whether the Secret must be defined
string
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
string
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
string
requiredName of the Step specified as a DNS_LABEL. Each Step in a Task must have a unique name.
string
OnError defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredobject
Contains the reference to an existing StepAction.
string
Name of the referenced step
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredstring
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
[]object
StepResult used to describe the Results of a Step.
string
Description is a human-readable description of the result
string
requiredName the given name
object
Properties is the JSON Schema properties to support key-value pairs results.
string
The possible types are 'string', 'array', and 'object', with 'string' as the default.
string
Script is the contents of an executable file to execute.
If Script is not empty, the Step cannot have an Command and the Args will be passed to the Script.
object
SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
boolean
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is:
object
appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
string
requiredtype indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
object
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
[]string
Added capabilities
[]string
Removed capabilities
boolean
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
string
procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
boolean
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
integer
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
boolean
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
integer
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
object
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
string
Level is SELinux level label that applies to the container.
string
Role is a SELinux role label that applies to the container.
string
Type is a SELinux type label that applies to the container.
string
User is a SELinux user label that applies to the container.
object
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
string
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
string
requiredtype indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
object
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
string
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
string
GMSACredentialSpecName is the name of the GMSA credential spec to use.
boolean
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
string
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
object
Stores configuration for the stderr stream of the step.
string
Path to duplicate stdout stream to on container's local filesystem.
object
Stores configuration for the stdout stream of the step.
string
Path to duplicate stdout stream to on container's local filesystem.
string
Timeout is the time after which the step times out. Defaults to never. Refer to Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
[]object
volumeDevice describes a mapping of a raw block device within a container.
string
requireddevicePath is the path inside of the container that the device will be mapped to.
string
requiredname must match the name of a persistentVolumeClaim in the pod
[]object
VolumeMount describes a mounting of a Volume within a container.
string
requiredPath within the container at which the volume should be mounted. Must not contain ':'.
string
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
string
requiredThis must match the Name of a Volume.
boolean
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
string
RecursiveReadOnly specifies whether read-only mounts should be handled recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
string
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
string
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
[]object
WhenExpression allows a PipelineTask to declare expressions to be evaluated before the Task is run to determine whether the Task should be executed or skipped
string
CEL is a string of Common Language Expression, which can be used to conditionally execute the task based on the result of the expression evaluation More info about CEL syntax: https://github.com/google/cel-spec/blob/master/doc/langdef.md
string
Input is the string for guard checking which can be a static input or an output from a parent Task
string
Operator that represents an Input's relationship to the values
[]string
Values is an array of strings, which is compared against the input, for guard checking It must be non-empty
string
Step's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
[]object
WorkspaceUsage is used by a Step or Sidecar to declare that it wants isolated access to a Workspace defined in a Task.
string
requiredMountPath is the path that the workspace should be mounted to inside the Step or Sidecar, overriding any MountPath specified in the Task's WorkspaceDeclaration.
string
requiredName is the name of the workspace this Step or Sidecar wants access to.
Volumes is a collection of volumes that are available to mount into the steps of the build. See Pod.spec.volumes (API version: v1)
[]object
WorkspaceDeclaration is a declaration of a volume that a Task requires.
string
Description is an optional human readable description of this volume.
string
MountPath overrides the directory that the volume will be made available at.
string
requiredName is the name by which you can bind the volume at runtime.
boolean
Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.
boolean
ReadOnly dictates whether a mounted volume is writable. By default this field is false and so mounted volumes are writable.
TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.
Deprecated: Please use v1.TaskRun instead.
v1beta1
versionobject
TaskRunSpec defines the desired state of TaskRun
object
Compute resources to use for this TaskRun
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
TaskRunDebug defines the breakpoint config for a particular TaskRun
object
TaskBreakpoints defines the breakpoint config for a particular Task
[]string
string
if enabled, pause TaskRun on failure of a step failed step will not exit
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredobject
PodTemplate holds pod specific configuration
If specified, the pod's scheduling constraints. See Pod.spec.affinity (API version: v1)
boolean
AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.
object
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
[]string
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
[]object
PodDNSConfigOption defines DNS resolver options of a pod.
string
Name is this DNS resolver option's name. Required.
string
Value is this DNS resolver option's value.
[]string
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.
string
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.
boolean
EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
[]object
EnvVar represents an environment variable present in a Container.
string
requiredName of the environment variable. Must be a C_IDENTIFIER.
string
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 "".
object
Source for the environment variable's value. Cannot be used if value is not empty.
object
Selects a key of a ConfigMap.
string
requiredThe key to select.
string
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
boolean
Specify whether the ConfigMap or its key must be defined
object
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.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
object
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.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
Selects a key of a secret in the pod's namespace
string
requiredThe key of the secret to select from. Must be a valid secret key.
string
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
boolean
Specify whether the Secret or its key must be defined
[]object
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
[]string
Hostnames for the above IP address.
string
requiredIP address of the host file entry.
boolean
HostNetwork specifies whether the pod may use the node network namespace
[]object
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
string
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
object
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/
string
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.
string
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.
string
SchedulerName specifies the scheduler to be used to dispatch the Pod
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)
[]object
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
string
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
[]object
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
object
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.
[]object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
string
requiredkey is the label key that the selector applies to.
string
requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
[]string
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.
object
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.
[]string
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).
integer
requiredMaxSkew 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 |
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.integer
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.
string
NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are:
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.
string
NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are:
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.
string
requiredTopologyKey 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.
string
requiredWhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
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)
object
Deprecated: Unused, preserved only for backwards compatibility
[]object
TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name.
Deprecated: Unused, preserved only for backwards compatibility
string
Name is the name of the PipelineResource in the Pipeline's declaration
[]string
Paths will probably be removed in #1284, and then PipelineResourceBinding can be used instead. The optional Path field corresponds to a path on disk at which the Resource can be found (used when providing the resource via mounted volume, overriding the default logic to fetch the Resource).
object
ResourceRef is a reference to the instance of the actual PipelineResource that should be used
string
API version of the referent
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
object
ResourceSpec is specification of a resource that should be created and consumed by the task
string
Description is a user-facing description of the resource that may be used to populate a UI.
[]object
requiredResourceParam declares a string value to use for the parameter called Name, and is used in the specific context of PipelineResources.
Deprecated: Unused, preserved only for backwards compatibility
string
requiredstring
required[]object
SecretParam indicates which secret can be used to populate a field of the resource
Deprecated: Unused, preserved only for backwards compatibility
string
requiredstring
requiredstring
requiredstring
requiredPipelineResourceType represents the type of endpoint the pipelineResource is, so that the controller will know this pipelineResource shouldx be fetched and optionally what additional metatdata should be provided for it.
Deprecated: Unused, preserved only for backwards compatibility
[]object
TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name.
Deprecated: Unused, preserved only for backwards compatibility
string
Name is the name of the PipelineResource in the Pipeline's declaration
[]string
Paths will probably be removed in #1284, and then PipelineResourceBinding can be used instead. The optional Path field corresponds to a path on disk at which the Resource can be found (used when providing the resource via mounted volume, overriding the default logic to fetch the Resource).
object
ResourceRef is a reference to the instance of the actual PipelineResource that should be used
string
API version of the referent
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
object
ResourceSpec is specification of a resource that should be created and consumed by the task
string
Description is a user-facing description of the resource that may be used to populate a UI.
[]object
requiredResourceParam declares a string value to use for the parameter called Name, and is used in the specific context of PipelineResources.
Deprecated: Unused, preserved only for backwards compatibility
string
requiredstring
required[]object
SecretParam indicates which secret can be used to populate a field of the resource
Deprecated: Unused, preserved only for backwards compatibility
string
requiredstring
requiredstring
requiredstring
requiredPipelineResourceType represents the type of endpoint the pipelineResource is, so that the controller will know this pipelineResource shouldx be fetched and optionally what additional metatdata should be provided for it.
Deprecated: Unused, preserved only for backwards compatibility
integer
Retries represents how many times this TaskRun should be retried in the event of Task failure.
string
[]object
TaskRunSidecarOverride is used to override the values of a Sidecar in the corresponding Task.
string
requiredThe name of the Sidecar to override.
object
requiredThe resource requirements to apply to the Sidecar.
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
string
Used for cancelling a TaskRun (and maybe more later on)
string
Status message for cancellation.
[]object
TaskRunStepOverride is used to override the values of a Step in the corresponding Task.
string
requiredThe name of the Step to override.
object
requiredThe resource requirements to apply to the Step.
[]object
ResourceClaim references one entry in PodSpec.ResourceClaims.
string
requiredName must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
string
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
no more than one of the TaskRef and TaskSpec may be specified.
string
API version of the referent Note: A Task with non-empty APIVersion and Kind is considered a Custom Task
string
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.
string
TaskKind indicates the Kind of the Task:
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
[]object
Param declares an ParamValues to use for the parameter called name.
string
requiredstring
Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git".
Specifying TaskSpec can be disabled by setting
disable-inline-spec
feature flag.
See Task.spec (API version: tekton.dev/v1beta1)
string
Time after which one retry attempt times out. Defaults to 1 hour. Refer Go's ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration
[]object
WorkspaceBinding maps a Task's declared workspace to a Volume.
object
ConfigMap represents a configMap that should populate this workspace.
integer
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.
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional specify whether the ConfigMap or its keys must be defined
object
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
string
requireddriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
string
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.
object
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.
string
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
boolean
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
object
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
object
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.
string
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 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
string
requiredName is the name of the workspace populated by the volume.
object
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
string
requiredclaimName 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
boolean
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
object
Projected represents a projected volume that should populate this workspace.
integer
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.
[]object
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
object
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.
object
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".
[]object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
string
requiredkey is the label key that the selector applies to.
string
requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
[]string
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.
object
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.
string
Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
boolean
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.
string
requiredRelative path from the volume root to write the bundle.
string
Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
object
configMap information about the configMap data to project
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional specify whether the ConfigMap or its keys must be defined
object
downwardAPI information about the downwardAPI data to project
[]object
DownwardAPIVolumeFile represents information to create the file containing the pod field
object
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
string
requiredPath of the field to select in the specified API version.
integer
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.
string
requiredRequired: 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 '..'
object
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
string
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
string
requiredRequired: resource to select
object
secret information about the secret data to project
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
string
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
boolean
optional field specify whether the Secret or its key must be defined
object
serviceAccountToken is information about the serviceAccountToken data to project
string
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.
integer
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.
string
requiredpath is the path relative to the mount point of the file to project the token into.
object
Secret represents a secret that should populate this workspace.
integer
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.
[]object
Maps a string key to a path within a volume.
string
requiredkey is the key to project.
integer
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.
string
requiredpath 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 '..'.
boolean
optional field specify whether the Secret or its keys must be defined
string
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
string
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 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)
object
TaskRunStatus defines the observed state of TaskRun
object
Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
[]object
CloudEventDelivery is the target of a cloud event along with the state of delivery.
object
CloudEventDeliveryState reports the state of a cloud event to be sent.
string
Current status
string
requiredError is the text of error (if any)
integer
requiredRetryCount is the number of attempts of sending the cloud event
string
SentAt is the time at which the last attempt to send the event was made
string
Target points to an addressable
string
CompletionTime is the time the build completed.
[]object
Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
string
LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).
string
A human readable message indicating details about the transition.
string
The reason for the condition's last transition.
string
Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.
string
requiredStatus of the condition, one of True, False, Unknown.
string
requiredType of condition.
integer
ObservedGeneration is the 'Generation' of the Service that was last processed by the controller.
string
requiredPodName is the name of the pod responsible for executing this task's steps.
object
Provenance contains some key authenticated metadata about how a software artifact was built (what sources, what inputs/outputs, etc.).
object
Deprecated: Use RefSource instead
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
object
FeatureFlags identifies the feature flags that were used during the task/pipeline run
boolean
string
boolean
string
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
EnableStepActions is a no-op flag since StepActions are stable
string
integer
boolean
string
boolean
boolean
boolean
boolean
string
VerificationNoMatchPolicy is the feature flag for "trusted-resources-verification-no-match-policy" VerificationNoMatchPolicy can be set to "ignore", "warn" and "fail" values. ignore: skip trusted resources verification when no matching verification policies found warn: skip trusted resources verification when no matching verification policies found and log a warning fail: fail the taskrun or pipelines run if no matching verification policies found
object
RefSource identifies the source where a remote task/pipeline came from.
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
[]object
RunResult is used to write key/value pairs to TaskRun pod termination messages. The key/value pairs may come from the entrypoint binary, or represent a TaskRunResult. If they represent a TaskRunResult, the key is the name of the result and the value is the JSON-serialized value of the result.
string
requiredstring
ResourceName may be used in tests, but it is not populated in termination messages. It is preserved here for backwards compatibility and will not be ported to v1.
integer
ResultType used to find out whether a RunResult is from a task result or not Note that ResultsType is another type which is used to define the data type (e.g. string, array, etc) we used for Results
string
requiredRetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant. See TaskRun.status (API version: tekton.dev/v1beta1)
[]object
SidecarState reports the results of running a sidecar in a Task.
string
string
string
object
Details about a running container
string
Time at which the container was last (re-)started
object
Details about a terminated container
string
Container's ID in the format '://<container_id>'
integer
requiredExit status from the last termination of the container
string
Time at which the container last terminated
string
Message regarding the last termination of the container
string
(brief) reason from the last termination of the container
integer
Signal from the last termination of the container
string
Time at which previous execution of the container started
object
Details about a waiting container
string
Message regarding why the container is not yet running.
string
(brief) reason the container is not yet running.
object
SpanContext contains tracing span context fields
string
StartTime is the time the build is actually started.
[]object
StepState reports the results of running a step in a Task.
string
string
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
string
[]object
Artifact represents an artifact within a system, potentially containing multiple values associated with it.
boolean
Indicate if the artifact is a build output or a by-product
string
The artifact's identifying category name
[]object
ArtifactValue represents a specific value or data element within an Artifact.
object
string
object
Provenance contains metadata about resources used in the TaskRun/PipelineRun such as the source from where a remote build definition was fetched. This field aims to carry minimum amoumt of metadata in *Run status so that Tekton Chains can capture them in the provenance.
object
Deprecated: Use RefSource instead
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
object
FeatureFlags identifies the feature flags that were used during the task/pipeline run
boolean
string
boolean
string
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
EnableStepActions is a no-op flag since StepActions are stable
string
integer
boolean
string
boolean
boolean
boolean
boolean
string
VerificationNoMatchPolicy is the feature flag for "trusted-resources-verification-no-match-policy" VerificationNoMatchPolicy can be set to "ignore", "warn" and "fail" values. ignore: skip trusted resources verification when no matching verification policies found warn: skip trusted resources verification when no matching verification policies found and log a warning fail: fail the taskrun or pipelines run if no matching verification policies found
object
RefSource identifies the source where a remote task/pipeline came from.
object
Digest is a collection of cryptographic digests for the contents of the artifact specified by URI. Example: {"sha1": "f99d13e554ffcb696dee719fa85b695cb5b0f428"}
string
EntryPoint identifies the entry point into the build. This is often a path to a build definition file and/or a target label within that file. Example: "task/git-clone/0.10/git-clone.yaml"
string
URI indicates the identity of the source of the build definition. Example: "https://github.com/tektoncd/catalog"
[]object
TaskRunResult used to describe the results of a task
string
requiredName the given name
string
Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.
Value the given value of the result
object
Details about a running container
string
Time at which the container was last (re-)started
object
Details about a terminated container
string
Container's ID in the format '://<container_id>'
integer
requiredExit status from the last termination of the container
string
Time at which the container last terminated
string
Message regarding the last termination of the container
string
(brief) reason from the last termination of the container
integer
Signal from the last termination of the container
string
Time at which previous execution of the container started
object
Details about a waiting container
string
Message regarding why the container is not yet running.
string
(brief) reason the container is not yet running.
[]object
TaskRunResult used to describe the results of a task
string
requiredName the given name
string
Type is the user-specified type of the result. The possible type is currently "string" and will support "array" in following work.
Value the given value of the result
TaskSpec contains the Spec from the dereferenced Task definition used to instantiate this TaskRun. See Task.spec (API version tekton.dev/v1beta1)