tekton.dev / v1 / Task

• string

  .apiVersion

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

• string

  .kind

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

• object

  .metadata

• object

  .spec

  Spec holds the desired state of the Task from the client

• string

  .spec .description

  Description is a user-facing description of the task that may be used to populate a UI.

• string

  .spec .displayName

  DisplayName is a user-facing name of the task that may be used to populate a UI.

• array

  .spec .params

  Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value.

• undefined

  .spec .params[] .default

  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

  .spec .params[] .description

  Description is a user-facing description of the parameter that may be used to populate a UI.

• array

  .spec .params[] .enum

  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 required

  .spec .params[] .name

  Name declares the name by which a parameter is referenced.

• object

  .spec .params[] .properties

  Properties is the JSON Schema properties to support key-value pairs parameter.

• string

  .spec .params[] .type

  Type is the user-specified type of the parameter. The possible types are currently “string”, “array” and “object”, and “string” is the default.

• array

  .spec .results

  Results are values that this Task can output

• string

  .spec .results[] .description

  Description is a human-readable description of the result

• string required

  .spec .results[] .name

  Name the given name

• object

  .spec .results[] .properties

  Properties is the JSON Schema properties to support key-value pairs results.

• string

  .spec .results[] .type

  Type is the user-specified type of the result. The possible type is currently “string” and will support “array” in following work.

• undefined

  .spec .results[] .value

  Value the expression used to retrieve the value of the result from an underlying Step.

• array

  .spec .sidecars

  Sidecars are run alongside the Task’s step containers. They begin before the steps start and end after the steps complete.

• array

  .spec .sidecars[] .args

  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

• array

  .spec .sidecars[] .command

  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

  .spec .sidecars[] .computeResources

  ComputeResources required by this Sidecar. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• array

  .spec .sidecars[] .computeResources .claims

  Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

  This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

  This field is immutable. It can only be set for containers.

• string required

  .spec .sidecars[] .computeResources .claims[] .name

  Name 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

  .spec .sidecars[] .computeResources .claims[] .request

  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

  .spec .sidecars[] .computeResources .limits

  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object

  .spec .sidecars[] .computeResources .requests

  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/

• array

  .spec .sidecars[] .env

  List of environment variables to set in the Sidecar. Cannot be updated.

• string required

  .spec .sidecars[] .env[] .name

  Name of the environment variable. Must be a C_IDENTIFIER.

• string

  .spec .sidecars[] .env[] .value

  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

  .spec .sidecars[] .env[] .valueFrom

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

• object

  .spec .sidecars[] .env[] .valueFrom .configMapKeyRef

  Selects a key of a ConfigMap.

• string required

  .spec .sidecars[] .env[] .valueFrom .configMapKeyRef .key

  The key to select.

• string

  .spec .sidecars[] .env[] .valueFrom .configMapKeyRef .name

  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

  .spec .sidecars[] .env[] .valueFrom .configMapKeyRef .optional

  Specify whether the ConfigMap or its key must be defined

• object

  .spec .sidecars[] .env[] .valueFrom .fieldRef

  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

  .spec .sidecars[] .env[] .valueFrom .fieldRef .apiVersion

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

• string required

  .spec .sidecars[] .env[] .valueFrom .fieldRef .fieldPath

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

• object

  .spec .sidecars[] .env[] .valueFrom .resourceFieldRef

  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

  .spec .sidecars[] .env[] .valueFrom .resourceFieldRef .containerName

  Container name: required for volumes, optional for env vars

• integer | string

  .spec .sidecars[] .env[] .valueFrom .resourceFieldRef .divisor

  Specifies the output format of the exposed resources, defaults to “1”

• string required

  .spec .sidecars[] .env[] .valueFrom .resourceFieldRef .resource

  Required: resource to select

• object

  .spec .sidecars[] .env[] .valueFrom .secretKeyRef

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

• string required

  .spec .sidecars[] .env[] .valueFrom .secretKeyRef .key

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

• string

  .spec .sidecars[] .env[] .valueFrom .secretKeyRef .name

  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

  .spec .sidecars[] .env[] .valueFrom .secretKeyRef .optional

  Specify whether the Secret or its key must be defined

• array

  .spec .sidecars[] .envFrom

  List of sources to populate environment variables in the Sidecar. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

• object

  .spec .sidecars[] .envFrom[] .configMapRef

  The ConfigMap to select from

• string

  .spec .sidecars[] .envFrom[] .configMapRef .name

  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

  .spec .sidecars[] .envFrom[] .configMapRef .optional

  Specify whether the ConfigMap must be defined

• string

  .spec .sidecars[] .envFrom[] .prefix

  An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

• object

  .spec .sidecars[] .envFrom[] .secretRef

  The Secret to select from

• string

  .spec .sidecars[] .envFrom[] .secretRef .name

  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

  .spec .sidecars[] .envFrom[] .secretRef .optional

  Specify whether the Secret must be defined

• string

  .spec .sidecars[] .image

  Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images

• string

  .spec .sidecars[] .imagePullPolicy

  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

  .spec .sidecars[] .lifecycle

  Actions that the management system should take in response to Sidecar lifecycle events. Cannot be updated.

• object

  .spec .sidecars[] .lifecycle .postStart

  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

  .spec .sidecars[] .lifecycle .postStart .exec

  Exec specifies a command to execute in the container.

• array

  .spec .sidecars[] .lifecycle .postStart .exec .command

  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

  .spec .sidecars[] .lifecycle .postStart .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .sidecars[] .lifecycle .postStart .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .sidecars[] .lifecycle .postStart .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .sidecars[] .lifecycle .postStart .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .sidecars[] .lifecycle .postStart .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .sidecars[] .lifecycle .postStart .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .sidecars[] .lifecycle .postStart .httpGet .port

  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

  .spec .sidecars[] .lifecycle .postStart .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• object

  .spec .sidecars[] .lifecycle .postStart .sleep

  Sleep represents a duration that the container should sleep.

• integer required

  .spec .sidecars[] .lifecycle .postStart .sleep .seconds

  Seconds is the number of seconds to sleep.

• object

  .spec .sidecars[] .lifecycle .postStart .tcpSocket

  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

  .spec .sidecars[] .lifecycle .postStart .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .sidecars[] .lifecycle .postStart .tcpSocket .port

  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

  .spec .sidecars[] .lifecycle .preStop

  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

  .spec .sidecars[] .lifecycle .preStop .exec

  Exec specifies a command to execute in the container.

• array

  .spec .sidecars[] .lifecycle .preStop .exec .command

  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

  .spec .sidecars[] .lifecycle .preStop .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .sidecars[] .lifecycle .preStop .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .sidecars[] .lifecycle .preStop .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .sidecars[] .lifecycle .preStop .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .sidecars[] .lifecycle .preStop .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .sidecars[] .lifecycle .preStop .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .sidecars[] .lifecycle .preStop .httpGet .port

  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

  .spec .sidecars[] .lifecycle .preStop .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• object

  .spec .sidecars[] .lifecycle .preStop .sleep

  Sleep represents a duration that the container should sleep.

• integer required

  .spec .sidecars[] .lifecycle .preStop .sleep .seconds

  Seconds is the number of seconds to sleep.

• object

  .spec .sidecars[] .lifecycle .preStop .tcpSocket

  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

  .spec .sidecars[] .lifecycle .preStop .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .sidecars[] .lifecycle .preStop .tcpSocket .port

  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

  .spec .sidecars[] .livenessProbe

  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

  .spec .sidecars[] .livenessProbe .exec

  Exec specifies a command to execute in the container.

• array

  .spec .sidecars[] .livenessProbe .exec .command

  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

  .spec .sidecars[] .livenessProbe .failureThreshold

  Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

• object

  .spec .sidecars[] .livenessProbe .grpc

  GRPC specifies a GRPC HealthCheckRequest.

• integer required

  .spec .sidecars[] .livenessProbe .grpc .port

  Port number of the gRPC service. Number must be in the range 1 to 65535.

• string

  .spec .sidecars[] .livenessProbe .grpc .service

  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

  .spec .sidecars[] .livenessProbe .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .sidecars[] .livenessProbe .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .sidecars[] .livenessProbe .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .sidecars[] .livenessProbe .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .sidecars[] .livenessProbe .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .sidecars[] .livenessProbe .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .sidecars[] .livenessProbe .httpGet .port

  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

  .spec .sidecars[] .livenessProbe .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• integer

  .spec .sidecars[] .livenessProbe .initialDelaySeconds

  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

  .spec .sidecars[] .livenessProbe .periodSeconds

  How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

• integer

  .spec .sidecars[] .livenessProbe .successThreshold

  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

  .spec .sidecars[] .livenessProbe .tcpSocket

  TCPSocket specifies a connection to a TCP port.

• string

  .spec .sidecars[] .livenessProbe .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .sidecars[] .livenessProbe .tcpSocket .port

  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

  .spec .sidecars[] .livenessProbe .terminationGracePeriodSeconds

  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

  .spec .sidecars[] .livenessProbe .timeoutSeconds

  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 required

  .spec .sidecars[] .name

  Name of the Sidecar specified as a DNS_LABEL. Each Sidecar in a Task must have a unique name (DNS_LABEL). Cannot be updated.

• array

  .spec .sidecars[] .ports

  List of ports to expose from the Sidecar. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated.

• integer required

  .spec .sidecars[] .ports[] .containerPort

  Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

• string

  .spec .sidecars[] .ports[] .hostIP

  What host IP to bind the external port to.

• integer

  .spec .sidecars[] .ports[] .hostPort

  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

  .spec .sidecars[] .ports[] .name

  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

  .spec .sidecars[] .ports[] .protocol

  Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”.

• object

  .spec .sidecars[] .readinessProbe

  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

  .spec .sidecars[] .readinessProbe .exec

  Exec specifies a command to execute in the container.

• array

  .spec .sidecars[] .readinessProbe .exec .command

  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

  .spec .sidecars[] .readinessProbe .failureThreshold

  Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

• object

  .spec .sidecars[] .readinessProbe .grpc

  GRPC specifies a GRPC HealthCheckRequest.

• integer required

  .spec .sidecars[] .readinessProbe .grpc .port

  Port number of the gRPC service. Number must be in the range 1 to 65535.

• string

  .spec .sidecars[] .readinessProbe .grpc .service

  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

  .spec .sidecars[] .readinessProbe .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .sidecars[] .readinessProbe .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .sidecars[] .readinessProbe .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .sidecars[] .readinessProbe .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .sidecars[] .readinessProbe .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .sidecars[] .readinessProbe .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .sidecars[] .readinessProbe .httpGet .port

  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

  .spec .sidecars[] .readinessProbe .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• integer

  .spec .sidecars[] .readinessProbe .initialDelaySeconds

  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

  .spec .sidecars[] .readinessProbe .periodSeconds

  How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

• integer

  .spec .sidecars[] .readinessProbe .successThreshold

  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

  .spec .sidecars[] .readinessProbe .tcpSocket

  TCPSocket specifies a connection to a TCP port.

• string

  .spec .sidecars[] .readinessProbe .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .sidecars[] .readinessProbe .tcpSocket .port

  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

  .spec .sidecars[] .readinessProbe .terminationGracePeriodSeconds

  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

  .spec .sidecars[] .readinessProbe .timeoutSeconds

  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

  .spec .sidecars[] .restartPolicy

  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

  .spec .sidecars[] .script

  Script is the contents of an executable file to execute.

  If Script is not empty, the Step cannot have an Command or Args.

• object

  .spec .sidecars[] .securityContext

  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

  .spec .sidecars[] .securityContext .allowPrivilegeEscalation

  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:

  1. run as Privileged
  2. has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
• object

  .spec .sidecars[] .securityContext .appArmorProfile

  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

  .spec .sidecars[] .securityContext .appArmorProfile .localhostProfile

  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 required

  .spec .sidecars[] .securityContext .appArmorProfile .type

  type 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

  .spec .sidecars[] .securityContext .capabilities

  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.

• array

  .spec .sidecars[] .securityContext .capabilities .add

  Added capabilities

• array

  .spec .sidecars[] .securityContext .capabilities .drop

  Removed capabilities

• boolean

  .spec .sidecars[] .securityContext .privileged

  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

  .spec .sidecars[] .securityContext .procMount

  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

  .spec .sidecars[] .securityContext .readOnlyRootFilesystem

  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

  .spec .sidecars[] .securityContext .runAsGroup

  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

  .spec .sidecars[] .securityContext .runAsNonRoot

  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

  .spec .sidecars[] .securityContext .runAsUser

  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

  .spec .sidecars[] .securityContext .seLinuxOptions

  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

  .spec .sidecars[] .securityContext .seLinuxOptions .level

  Level is SELinux level label that applies to the container.

• string

  .spec .sidecars[] .securityContext .seLinuxOptions .role

  Role is a SELinux role label that applies to the container.

• string

  .spec .sidecars[] .securityContext .seLinuxOptions .type

  Type is a SELinux type label that applies to the container.

• string

  .spec .sidecars[] .securityContext .seLinuxOptions .user

  User is a SELinux user label that applies to the container.

• object

  .spec .sidecars[] .securityContext .seccompProfile

  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

  .spec .sidecars[] .securityContext .seccompProfile .localhostProfile

  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 required

  .spec .sidecars[] .securityContext .seccompProfile .type

  type 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

  .spec .sidecars[] .securityContext .windowsOptions

  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

  .spec .sidecars[] .securityContext .windowsOptions .gmsaCredentialSpec

  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

  .spec .sidecars[] .securityContext .windowsOptions .gmsaCredentialSpecName

  GMSACredentialSpecName is the name of the GMSA credential spec to use.

• boolean

  .spec .sidecars[] .securityContext .windowsOptions .hostProcess

  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

  .spec .sidecars[] .securityContext .windowsOptions .runAsUserName

  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

  .spec .sidecars[] .startupProbe

  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

  .spec .sidecars[] .startupProbe .exec

  Exec specifies a command to execute in the container.

• array

  .spec .sidecars[] .startupProbe .exec .command

  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

  .spec .sidecars[] .startupProbe .failureThreshold

  Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

• object

  .spec .sidecars[] .startupProbe .grpc

  GRPC specifies a GRPC HealthCheckRequest.

• integer required

  .spec .sidecars[] .startupProbe .grpc .port

  Port number of the gRPC service. Number must be in the range 1 to 65535.

• string

  .spec .sidecars[] .startupProbe .grpc .service

  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

  .spec .sidecars[] .startupProbe .httpGet

  HTTPGet specifies an HTTP GET request to perform.

• string

  .spec .sidecars[] .startupProbe .httpGet .host

  Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

• array

  .spec .sidecars[] .startupProbe .httpGet .httpHeaders

  Custom headers to set in the request. HTTP allows repeated headers.

• string required

  .spec .sidecars[] .startupProbe .httpGet .httpHeaders[] .name

  The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

• string required

  .spec .sidecars[] .startupProbe .httpGet .httpHeaders[] .value

  The header field value

• string

  .spec .sidecars[] .startupProbe .httpGet .path

  Path to access on the HTTP server.

• integer | string required

  .spec .sidecars[] .startupProbe .httpGet .port

  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

  .spec .sidecars[] .startupProbe .httpGet .scheme

  Scheme to use for connecting to the host. Defaults to HTTP.

• integer

  .spec .sidecars[] .startupProbe .initialDelaySeconds

  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

  .spec .sidecars[] .startupProbe .periodSeconds

  How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

• integer

  .spec .sidecars[] .startupProbe .successThreshold

  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

  .spec .sidecars[] .startupProbe .tcpSocket

  TCPSocket specifies a connection to a TCP port.

• string

  .spec .sidecars[] .startupProbe .tcpSocket .host

  Optional: Host name to connect to, defaults to the pod IP.

• integer | string required

  .spec .sidecars[] .startupProbe .tcpSocket .port

  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

  .spec .sidecars[] .startupProbe .terminationGracePeriodSeconds

  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

  .spec .sidecars[] .startupProbe .timeoutSeconds

  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

  .spec .sidecars[] .stdin

  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

  .spec .sidecars[] .stdinOnce

  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

  .spec .sidecars[] .terminationMessagePath

  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

  .spec .sidecars[] .terminationMessagePolicy

  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

  .spec .sidecars[] .tty

  Whether this Sidecar should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

• array

  .spec .sidecars[] .volumeDevices

  volumeDevices is the list of block devices to be used by the Sidecar.

• string required

  .spec .sidecars[] .volumeDevices[] .devicePath

  devicePath is the path inside of the container that the device will be mapped to.

• string required

  .spec .sidecars[] .volumeDevices[] .name

  name must match the name of a persistentVolumeClaim in the pod

• array

  .spec .sidecars[] .volumeMounts

  Volumes to mount into the Sidecar’s filesystem. Cannot be updated.

• string required

  .spec .sidecars[] .volumeMounts[] .mountPath

  Path within the container at which the volume should be mounted. Must not contain ‘:’.

• string

  .spec .sidecars[] .volumeMounts[] .mountPropagation

  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 required

  .spec .sidecars[] .volumeMounts[] .name

  This must match the Name of a Volume.

• boolean

  .spec .sidecars[] .volumeMounts[] .readOnly

  Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

• string

  .spec .sidecars[] .volumeMounts[] .recursiveReadOnly

  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

  .spec .sidecars[] .volumeMounts[] .subPath

  Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

• string

  .spec .sidecars[] .volumeMounts[] .subPathExpr

  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

  .spec .sidecars[] .workingDir

  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.

• array

  .spec .sidecars[] .workspaces

  This is an alpha field. You must set the “enable-api-fields” feature flag to “alpha” for this field to be supported.

  Workspaces is a list of workspaces from the Task that this Sidecar wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.

• string required

  .spec .sidecars[] .workspaces[] .mountPath

  MountPath 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 required

  .spec .sidecars[] .workspaces[] .name

  Name is the name of the workspace this Step or Sidecar wants access to.

• object

  .spec .stepTemplate

  StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container.

• array

  .spec .stepTemplate .args

  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

• array

  .spec .stepTemplate .command

  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

  .spec .stepTemplate .computeResources

  ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• array

  .spec .stepTemplate .computeResources .claims

  Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

  This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

  This field is immutable. It can only be set for containers.

• string required

  .spec .stepTemplate .computeResources .claims[] .name

  Name 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

  .spec .stepTemplate .computeResources .claims[] .request

  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

  .spec .stepTemplate .computeResources .limits

  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object

  .spec .stepTemplate .computeResources .requests

  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/

• array

  .spec .stepTemplate .env

  List of environment variables to set in the Step. Cannot be updated.

• string required

  .spec .stepTemplate .env[] .name

  Name of the environment variable. Must be a C_IDENTIFIER.

• string

  .spec .stepTemplate .env[] .value

  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

  .spec .stepTemplate .env[] .valueFrom

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

• object

  .spec .stepTemplate .env[] .valueFrom .configMapKeyRef

  Selects a key of a ConfigMap.

• string required

  .spec .stepTemplate .env[] .valueFrom .configMapKeyRef .key

  The key to select.

• string

  .spec .stepTemplate .env[] .valueFrom .configMapKeyRef .name

  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

  .spec .stepTemplate .env[] .valueFrom .configMapKeyRef .optional

  Specify whether the ConfigMap or its key must be defined

• object

  .spec .stepTemplate .env[] .valueFrom .fieldRef

  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

  .spec .stepTemplate .env[] .valueFrom .fieldRef .apiVersion

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

• string required

  .spec .stepTemplate .env[] .valueFrom .fieldRef .fieldPath

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

• object

  .spec .stepTemplate .env[] .valueFrom .resourceFieldRef

  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

  .spec .stepTemplate .env[] .valueFrom .resourceFieldRef .containerName

  Container name: required for volumes, optional for env vars

• integer | string

  .spec .stepTemplate .env[] .valueFrom .resourceFieldRef .divisor

  Specifies the output format of the exposed resources, defaults to “1”

• string required

  .spec .stepTemplate .env[] .valueFrom .resourceFieldRef .resource

  Required: resource to select

• object

  .spec .stepTemplate .env[] .valueFrom .secretKeyRef

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

• string required

  .spec .stepTemplate .env[] .valueFrom .secretKeyRef .key

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

• string

  .spec .stepTemplate .env[] .valueFrom .secretKeyRef .name

  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

  .spec .stepTemplate .env[] .valueFrom .secretKeyRef .optional

  Specify whether the Secret or its key must be defined

• array

  .spec .stepTemplate .envFrom

  List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

• object

  .spec .stepTemplate .envFrom[] .configMapRef

  The ConfigMap to select from

• string

  .spec .stepTemplate .envFrom[] .configMapRef .name

  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

  .spec .stepTemplate .envFrom[] .configMapRef .optional

  Specify whether the ConfigMap must be defined

• string

  .spec .stepTemplate .envFrom[] .prefix

  An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

• object

  .spec .stepTemplate .envFrom[] .secretRef

  The Secret to select from

• string

  .spec .stepTemplate .envFrom[] .secretRef .name

  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

  .spec .stepTemplate .envFrom[] .secretRef .optional

  Specify whether the Secret must be defined

• string

  .spec .stepTemplate .image

  Image reference name. More info: https://kubernetes.io/docs/concepts/containers/images

• string

  .spec .stepTemplate .imagePullPolicy

  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

  .spec .stepTemplate .securityContext

  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

  .spec .stepTemplate .securityContext .allowPrivilegeEscalation

  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:

  1. run as Privileged
  2. has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
• object

  .spec .stepTemplate .securityContext .appArmorProfile

  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

  .spec .stepTemplate .securityContext .appArmorProfile .localhostProfile

  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 required

  .spec .stepTemplate .securityContext .appArmorProfile .type

  type 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

  .spec .stepTemplate .securityContext .capabilities

  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.

• array

  .spec .stepTemplate .securityContext .capabilities .add

  Added capabilities

• array

  .spec .stepTemplate .securityContext .capabilities .drop

  Removed capabilities

• boolean

  .spec .stepTemplate .securityContext .privileged

  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

  .spec .stepTemplate .securityContext .procMount

  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

  .spec .stepTemplate .securityContext .readOnlyRootFilesystem

  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

  .spec .stepTemplate .securityContext .runAsGroup

  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

  .spec .stepTemplate .securityContext .runAsNonRoot

  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

  .spec .stepTemplate .securityContext .runAsUser

  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

  .spec .stepTemplate .securityContext .seLinuxOptions

  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

  .spec .stepTemplate .securityContext .seLinuxOptions .level

  Level is SELinux level label that applies to the container.

• string

  .spec .stepTemplate .securityContext .seLinuxOptions .role

  Role is a SELinux role label that applies to the container.

• string

  .spec .stepTemplate .securityContext .seLinuxOptions .type

  Type is a SELinux type label that applies to the container.

• string

  .spec .stepTemplate .securityContext .seLinuxOptions .user

  User is a SELinux user label that applies to the container.

• object

  .spec .stepTemplate .securityContext .seccompProfile

  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

  .spec .stepTemplate .securityContext .seccompProfile .localhostProfile

  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 required

  .spec .stepTemplate .securityContext .seccompProfile .type

  type 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

  .spec .stepTemplate .securityContext .windowsOptions

  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

  .spec .stepTemplate .securityContext .windowsOptions .gmsaCredentialSpec

  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

  .spec .stepTemplate .securityContext .windowsOptions .gmsaCredentialSpecName

  GMSACredentialSpecName is the name of the GMSA credential spec to use.

• boolean

  .spec .stepTemplate .securityContext .windowsOptions .hostProcess

  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

  .spec .stepTemplate .securityContext .windowsOptions .runAsUserName

  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.

• array

  .spec .stepTemplate .volumeDevices

  volumeDevices is the list of block devices to be used by the Step.

• string required

  .spec .stepTemplate .volumeDevices[] .devicePath

  devicePath is the path inside of the container that the device will be mapped to.

• string required

  .spec .stepTemplate .volumeDevices[] .name

  name must match the name of a persistentVolumeClaim in the pod

• array

  .spec .stepTemplate .volumeMounts

  Volumes to mount into the Step’s filesystem. Cannot be updated.

• string required

  .spec .stepTemplate .volumeMounts[] .mountPath

  Path within the container at which the volume should be mounted. Must not contain ‘:’.

• string

  .spec .stepTemplate .volumeMounts[] .mountPropagation

  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 required

  .spec .stepTemplate .volumeMounts[] .name

  This must match the Name of a Volume.

• boolean

  .spec .stepTemplate .volumeMounts[] .readOnly

  Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

• string

  .spec .stepTemplate .volumeMounts[] .recursiveReadOnly

  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

  .spec .stepTemplate .volumeMounts[] .subPath

  Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

• string

  .spec .stepTemplate .volumeMounts[] .subPathExpr

  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

  .spec .stepTemplate .workingDir

  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.

• array

  .spec .steps

  Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace.

• array

  .spec .steps[] .args

  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

• array

  .spec .steps[] .command

  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

  .spec .steps[] .computeResources

  ComputeResources required by this Step. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• array

  .spec .steps[] .computeResources .claims

  Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

  This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

  This field is immutable. It can only be set for containers.

• string required

  .spec .steps[] .computeResources .claims[] .name

  Name 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

  .spec .steps[] .computeResources .claims[] .request

  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

  .spec .steps[] .computeResources .limits

  Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

• object

  .spec .steps[] .computeResources .requests

  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/

• array

  .spec .steps[] .env

  List of environment variables to set in the Step. Cannot be updated.

• string required

  .spec .steps[] .env[] .name

  Name of the environment variable. Must be a C_IDENTIFIER.

• string

  .spec .steps[] .env[] .value

  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

  .spec .steps[] .env[] .valueFrom

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

• object

  .spec .steps[] .env[] .valueFrom .configMapKeyRef

  Selects a key of a ConfigMap.

• string required

  .spec .steps[] .env[] .valueFrom .configMapKeyRef .key

  The key to select.

• string

  .spec .steps[] .env[] .valueFrom .configMapKeyRef .name

  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

  .spec .steps[] .env[] .valueFrom .configMapKeyRef .optional

  Specify whether the ConfigMap or its key must be defined

• object

  .spec .steps[] .env[] .valueFrom .fieldRef

  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

  .spec .steps[] .env[] .valueFrom .fieldRef .apiVersion

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

• string required

  .spec .steps[] .env[] .valueFrom .fieldRef .fieldPath

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

• object

  .spec .steps[] .env[] .valueFrom .resourceFieldRef

  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

  .spec .steps[] .env[] .valueFrom .resourceFieldRef .containerName

  Container name: required for volumes, optional for env vars

• integer | string

  .spec .steps[] .env[] .valueFrom .resourceFieldRef .divisor

  Specifies the output format of the exposed resources, defaults to “1”

• string required

  .spec .steps[] .env[] .valueFrom .resourceFieldRef .resource

  Required: resource to select

• object

  .spec .steps[] .env[] .valueFrom .secretKeyRef

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

• string required

  .spec .steps[] .env[] .valueFrom .secretKeyRef .key

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

• string

  .spec .steps[] .env[] .valueFrom .secretKeyRef .name

  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

  .spec .steps[] .env[] .valueFrom .secretKeyRef .optional

  Specify whether the Secret or its key must be defined

• array

  .spec .steps[] .envFrom

  List of sources to populate environment variables in the Step. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the Step is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

• object

  .spec .steps[] .envFrom[] .configMapRef

  The ConfigMap to select from

• string

  .spec .steps[] .envFrom[] .configMapRef .name

  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

  .spec .steps[] .envFrom[] .configMapRef .optional

  Specify whether the ConfigMap must be defined

• string

  .spec .steps[] .envFrom[] .prefix

  An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

• object

  .spec .steps[] .envFrom[] .secretRef

  The Secret to select from

• string

  .spec .steps[] .envFrom[] .secretRef .name

  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

  .spec .steps[] .envFrom[] .secretRef .optional

  Specify whether the Secret must be defined

• string

  .spec .steps[] .image

  Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images

• string

  .spec .steps[] .imagePullPolicy

  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 required

  .spec .steps[] .name

  Name of the Step specified as a DNS_LABEL. Each Step in a Task must have a unique name.

• string

  .spec .steps[] .onError

  OnError defines the exiting behavior of a container on error can be set to [ continue | stopAndFail ]

• array

  .spec .steps[] .params

  Params declares parameters passed to this step action.

• string required

  .spec .steps[] .params[] .name

• undefined required

  .spec .steps[] .params[] .value

• object

  .spec .steps[] .ref

  Contains the reference to an existing StepAction.

• string

  .spec .steps[] .ref .name

  Name of the referenced step

• array

  .spec .steps[] .ref .params

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

• string required

  .spec .steps[] .ref .params[] .name

• undefined required

  .spec .steps[] .ref .params[] .value

• string

  .spec .steps[] .ref .resolver

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

• array

  .spec .steps[] .results

  Results declares StepResults produced by the Step.

  It can be used in an inlined Step when used to store Results to $(step.results.resultName.path). It cannot be used when referencing StepActions using [v1.Step.Ref]. The Results declared by the StepActions will be stored here instead.

• string

  .spec .steps[] .results[] .description

  Description is a human-readable description of the result

• string required

  .spec .steps[] .results[] .name

  Name the given name

• object

  .spec .steps[] .results[] .properties

  Properties is the JSON Schema properties to support key-value pairs results.

• string

  .spec .steps[] .results[] .type

  The possible types are ‘string’, ‘array’, and ‘object’, with ‘string’ as the default.

• string

  .spec .steps[] .script

  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

  .spec .steps[] .securityContext

  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

  .spec .steps[] .securityContext .allowPrivilegeEscalation

  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:

  1. run as Privileged
  2. has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
• object

  .spec .steps[] .securityContext .appArmorProfile

  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

  .spec .steps[] .securityContext .appArmorProfile .localhostProfile

  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 required

  .spec .steps[] .securityContext .appArmorProfile .type

  type 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

  .spec .steps[] .securityContext .capabilities

  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.

• array

  .spec .steps[] .securityContext .capabilities .add

  Added capabilities

• array

  .spec .steps[] .securityContext .capabilities .drop

  Removed capabilities

• boolean

  .spec .steps[] .securityContext .privileged

  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

  .spec .steps[] .securityContext .procMount

  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

  .spec .steps[] .securityContext .readOnlyRootFilesystem

  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

  .spec .steps[] .securityContext .runAsGroup

  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

  .spec .steps[] .securityContext .runAsNonRoot

  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

  .spec .steps[] .securityContext .runAsUser

  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

  .spec .steps[] .securityContext .seLinuxOptions

  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

  .spec .steps[] .securityContext .seLinuxOptions .level

  Level is SELinux level label that applies to the container.

• string

  .spec .steps[] .securityContext .seLinuxOptions .role

  Role is a SELinux role label that applies to the container.

• string

  .spec .steps[] .securityContext .seLinuxOptions .type

  Type is a SELinux type label that applies to the container.

• string

  .spec .steps[] .securityContext .seLinuxOptions .user

  User is a SELinux user label that applies to the container.

• object

  .spec .steps[] .securityContext .seccompProfile

  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

  .spec .steps[] .securityContext .seccompProfile .localhostProfile

  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 required

  .spec .steps[] .securityContext .seccompProfile .type

  type 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

  .spec .steps[] .securityContext .windowsOptions

  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

  .spec .steps[] .securityContext .windowsOptions .gmsaCredentialSpec

  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

  .spec .steps[] .securityContext .windowsOptions .gmsaCredentialSpecName

  GMSACredentialSpecName is the name of the GMSA credential spec to use.

• boolean

  .spec .steps[] .securityContext .windowsOptions .hostProcess

  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

  .spec .steps[] .securityContext .windowsOptions .runAsUserName

  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

  .spec .steps[] .stderrConfig

  Stores configuration for the stderr stream of the step.

• string

  .spec .steps[] .stderrConfig .path

  Path to duplicate stdout stream to on container’s local filesystem.

• object

  .spec .steps[] .stdoutConfig

  Stores configuration for the stdout stream of the step.

• string

  .spec .steps[] .stdoutConfig .path

  Path to duplicate stdout stream to on container’s local filesystem.

• string

  .spec .steps[] .timeout

  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

• array

  .spec .steps[] .volumeDevices

  volumeDevices is the list of block devices to be used by the Step.

• string required

  .spec .steps[] .volumeDevices[] .devicePath

  devicePath is the path inside of the container that the device will be mapped to.

• string required

  .spec .steps[] .volumeDevices[] .name

  name must match the name of a persistentVolumeClaim in the pod

• array

  .spec .steps[] .volumeMounts

  Volumes to mount into the Step’s filesystem. Cannot be updated.

• string required

  .spec .steps[] .volumeMounts[] .mountPath

  Path within the container at which the volume should be mounted. Must not contain ‘:’.

• string

  .spec .steps[] .volumeMounts[] .mountPropagation

  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 required

  .spec .steps[] .volumeMounts[] .name

  This must match the Name of a Volume.

• boolean

  .spec .steps[] .volumeMounts[] .readOnly

  Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

• string

  .spec .steps[] .volumeMounts[] .recursiveReadOnly

  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

  .spec .steps[] .volumeMounts[] .subPath

  Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

• string

  .spec .steps[] .volumeMounts[] .subPathExpr

  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.

• array

  .spec .steps[] .when

  When is a list of when expressions that need to be true for the task to run

• string

  .spec .steps[] .when[] .cel

  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

  .spec .steps[] .when[] .input

  Input is the string for guard checking which can be a static input or an output from a parent Task

• string

  .spec .steps[] .when[] .operator

  Operator that represents an Input’s relationship to the values

• array

  .spec .steps[] .when[] .values

  Values is an array of strings, which is compared against the input, for guard checking It must be non-empty

• string

  .spec .steps[] .workingDir

  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.

• array

  .spec .steps[] .workspaces

  This is an alpha field. You must set the “enable-api-fields” feature flag to “alpha” for this field to be supported.

  Workspaces is a list of workspaces from the Task that this Step wants exclusive access to. Adding a workspace to this list means that any other Step or Sidecar that does not also request this Workspace will not have access to it.

• string required

  .spec .steps[] .workspaces[] .mountPath

  MountPath 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 required

  .spec .steps[] .workspaces[] .name

  Name is the name of the workspace this Step or Sidecar wants access to.

• undefined

  .spec .volumes

  Volumes is a collection of volumes that are available to mount into the steps of the build. See Pod.spec.volumes (API version: v1)

• array

  .spec .workspaces

  Workspaces are the volumes that this Task requires.

• string

  .spec .workspaces[] .description

  Description is an optional human readable description of this volume.

• string

  .spec .workspaces[] .mountPath

  MountPath overrides the directory that the volume will be made available at.

• string required

  .spec .workspaces[] .name

  Name is the name by which you can bind the volume at runtime.

• boolean

  .spec .workspaces[] .optional

  Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

• boolean

  .spec .workspaces[] .readOnly

  ReadOnly dictates whether a mounted volume is writable. By default this field is false and so mounted volumes are writable.