Skip to content

Instantly share code, notes, and snippets.

@viglesiasce
Created August 13, 2019 18:40
Show Gist options
  • Save viglesiasce/cd721e7d363a780683b806dac448ff4f to your computer and use it in GitHub Desktop.
Save viglesiasce/cd721e7d363a780683b806dac448ff4f to your computer and use it in GitHub Desktop.

Packages:

tekton.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the pipeline v1alpha1 API group

Resource Types:

ClusterTask

ClusterTask is a Task with a cluster scope. ClusterTasks are used to represent Tasks that should be publicly addressable from any namespace in the cluster.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
ClusterTask
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TaskSpec
(Optional)

Spec holds the desired state of the Task from the client



inputs
Inputs
(Optional)

Inputs is an optional set of parameters and resources which must be supplied by the user when a Task is executed by a TaskRun.

outputs
Outputs
(Optional)

Outputs is an optional set of resources and results produced when this Task is run.

steps
[]Kubernetes core/v1.Container

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

volumes
[]Kubernetes core/v1.Volume

Volumes is a collection of volumes that are available to mount into the steps of the build.

stepTemplate
Kubernetes core/v1.Container

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

containerTemplate
Kubernetes core/v1.Container

ContainerTemplate is the deprecated previous name of the StepTemplate field (#977).

Pipeline

Pipeline describes a list of Tasks to execute. It expresses how outputs of tasks feed into inputs of subsequent tasks.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
Pipeline
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PipelineSpec
(Optional)

Spec holds the desired state of the Pipeline from the client



resources
[]PipelineDeclaredResource

Resources declares the names and types of the resources given to the Pipeline’s tasks as inputs and outputs.

tasks
[]PipelineTask

Tasks declares the graph of Tasks that execute when this Pipeline is run.

params
[]ParamSpec

Params declares a list of input parameters that must be supplied when this Pipeline is run.

status
PipelineStatus
(Optional)

Status communicates the observed state of the Pipeline from the controller.

PipelineResource

PipelineResource describes a resource that is an input to or output from a Task.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
PipelineResource
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PipelineResourceSpec
(Optional)

Spec holds the desired state of the PipelineResource from the client



type
PipelineResourceType
params
[]Param
secrets
[]SecretParam
(Optional)

Secrets to fetch to populate some of resource fields

status
PipelineResourceStatus
(Optional)

Status communicates the observed state of the PipelineResource from the controller

PipelineRun

PipelineRun represents a single execution of a Pipeline. PipelineRuns are how the graph of Tasks declared in a Pipeline are executed; they specify inputs to Pipelines such as parameter values and capture operational aspects of the Tasks execution such as service account and tolerations. Creating a PipelineRun creates TaskRuns for Tasks in the referenced Pipeline.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
PipelineRun
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PipelineRunSpec
(Optional)

pipelineRef
PipelineRef
resources
[]PipelineResourceBinding

Resources is a list of bindings specifying which actual instances of PipelineResources to use for the resources the Pipeline has declared it needs.

params
[]Param

Params is a list of parameter names and values.

serviceAccount
string
(Optional)
serviceAccounts
[]PipelineRunSpecServiceAccount
(Optional)
results
Results
(Optional)
status
PipelineRunSpecStatus
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

Time after which the Pipeline times out. Defaults to never. Refer to Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

nodeSelector
map[string]string
(Optional)

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

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

status
PipelineRunStatus
(Optional)

Task

Task represents a collection of sequential steps that are run as part of a Pipeline using a set of inputs and producing a set of outputs. Tasks execute when TaskRuns are created that provide the input parameters and resources and output resources the Task requires.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
Task
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TaskSpec
(Optional)

Spec holds the desired state of the Task from the client



inputs
Inputs
(Optional)

Inputs is an optional set of parameters and resources which must be supplied by the user when a Task is executed by a TaskRun.

outputs
Outputs
(Optional)

Outputs is an optional set of resources and results produced when this Task is run.

steps
[]Kubernetes core/v1.Container

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

volumes
[]Kubernetes core/v1.Volume

Volumes is a collection of volumes that are available to mount into the steps of the build.

stepTemplate
Kubernetes core/v1.Container

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

containerTemplate
Kubernetes core/v1.Container

ContainerTemplate is the deprecated previous name of the StepTemplate field (#977).

TaskRun

TaskRun represents a single execution of a Task. TaskRuns are how the steps specified in a Task are executed; they specify the parameters and resources used to run the steps in a Task.

Field Description
apiVersion
string
tekton.dev/v1alpha1
kind
string
TaskRun
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TaskRunSpec
(Optional)

inputs
TaskRunInputs
(Optional)
outputs
TaskRunOutputs
(Optional)
results
Results
(Optional)
serviceAccount
string
(Optional)
taskRef
TaskRef
(Optional)

no more than one of the TaskRef and TaskSpec may be specified.

taskSpec
TaskSpec
(Optional)
status
TaskRunSpecStatus
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

Time after which the build times out. Defaults to 10 minutes. Specified build timeout should be less than 24h. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

nodeSelector
map[string]string
(Optional)

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

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

status
TaskRunStatus
(Optional)

ArtifactBucket

ArtifactBucket contains the Storage bucket configuration defined in the Bucket config map.

Field Description
Name
string
Location
string
Secrets
[]SecretParam

ArtifactPVC

ArtifactPVC represents the pvc created by the pipelinerun for artifacts temporary storage

Field Description
Name
string
PersistentVolumeClaim
Kubernetes core/v1.PersistentVolumeClaim

BuildGCSResource

Field Description
Name
string
Type
PipelineResourceType
Location
string
DestinationDir
string
ArtifactType
GCSArtifactType

ClusterResource

ClusterResource represents a cluster configuration (kubeconfig) that can be accessed by tasks in the pipeline

Field Description
name
string
type
PipelineResourceType
url
string

URL must be a host string

revision
string
username
string

Server requires Basic authentication

password
string
token
string

Server requires Bearer authentication. This client will not attempt to use refresh tokens for an OAuth2 flow. Token overrides userame and password

Insecure
bool

Server should be accessed without verifying the TLS certificate. For testing only.

cadata
[]byte

CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile

secrets
[]SecretParam

Secrets holds a struct to indicate a field name and corresponding secret name to populate it

DAG

DAG represents the Pipeline DAG

Field Description
Nodes
map[string]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1.Node

Nodes represent map of PipelineTask name to Node in Pipeline DAG

GCSArtifactType (string alias)

(Appears on: BuildGCSResource)

GCSArtifactType defines a type of GCS resource.

GCSResource

GCSResource is a GCS endpoint from which to get artifacts which is required by a Build/Task for context (e.g. a archive from which to build an image).

Field Description
name
string
type
PipelineResourceType
location
string
typeDir
bool
destinationDir
string
secrets
[]SecretParam

Secret holds a struct to indicate a field name and corresponding secret name to populate it

GitResource

GitResource is an endpoint from which to get data which is required by a Build/Task for context (e.g. a repo from which to build an image).

Field Description
name
string
type
PipelineResourceType
url
string
revision
string

Git revision (branch, tag, commit SHA or ref) to clone. See https://git-scm.com/docs/gitrevisions#_specifying_revisions for more information.

TargetPath
string

ImageResource

ImageResource defines an endpoint where artifacts can be stored, such as images.

Field Description
name
string
type
PipelineResourceType
url
string
digest
string
OutputImageDir
string

Inputs

(Appears on: TaskSpec)

Inputs are the requirements that a task needs to run a Build.

Field Description
resources
[]TaskResource
(Optional)

Resources is a list of the input resources required to run the task. Resources are represented in TaskRuns as bindings to instances of PipelineResources.

params
[]ParamSpec
(Optional)

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.

Node

Node represents a Task in a pipeline.

Field Description
Task
PipelineTask

Task represent the PipelineTask in Pipeline

Prev
[]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1.Node

Prev represent all the Previous task Nodes for the current Task

Next
[]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1.Node

Next represent all the Next task Nodes for the current Task

Outputs

(Appears on: TaskSpec)

Outputs allow a task to declare what data the Build/Task will be producing, i.e. results such as logs and artifacts such as images.

Field Description
results
[]TestResult
(Optional)
resources
[]TaskResource
(Optional)

Param

(Appears on: PipelineResourceSpec, PipelineRunSpec, PipelineTask, TaskRunInputs)

Param declares a value to use for the Param called Name.

Field Description
name
string
value
string

ParamSpec

(Appears on: Inputs, PipelineSpec)

ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources). Parameter values are provided by users as inputs on a TaskRun or PipelineRun.

Field Description
name
string

Name declares the name by which a parameter is referenced.

description
string
(Optional)

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

default
string
(Optional)

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.

PipelineDeclaredResource

(Appears on: PipelineSpec)

PipelineDeclaredResource is used by a Pipeline to declare the types of the PipelineResources that it will required to run and names which can be used to refer to these PipelineResources in PipelineTaskResourceBindings.

Field Description
name
string

Name is the name that will be used by the Pipeline to refer to this resource. It does not directly correspond to the name of any PipelineResources Task inputs or outputs, and it does not correspond to the actual names of the PipelineResources that will be bound in the PipelineRun.

type
PipelineResourceType

Type is the type of the PipelineResource.

PipelineRef

(Appears on: PipelineRunSpec)

PipelineRef can be used to refer to a specific instance of a Pipeline. Copied from CrossVersionObjectReference: https://github.com/kubernetes/kubernetes/blob/169df7434155cbbc22f1532cba8e0a9588e29ad8/pkg/apis/autoscaling/types.go#L64

Field Description
name
string

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

apiVersion
string
(Optional)

API version of the referent

PipelineResourceBinding

(Appears on: PipelineRunSpec)

PipelineResourceBinding connects a reference to an instance of a PipelineResource with a PipelineResource dependency that the Pipeline has declared

Field Description
name
string

Name is the name of the PipelineResource in the Pipeline’s declaration

resourceRef
PipelineResourceRef

ResourceRef is a reference to the instance of the actual PipelineResource that should be used

PipelineResourceInterface

PipelineResourceInterface interface to be implemented by different PipelineResource types

PipelineResourceRef

(Appears on: PipelineResourceBinding, TaskResourceBinding)

PipelineResourceRef can be used to refer to a specific instance of a Resource

Field Description
name
string

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

apiVersion
string
(Optional)

API version of the referent

PipelineResourceResult

(Appears on: TaskRunStatus)

PipelineResourceResult used to export the image name and digest as json

Field Description
name
string
digest
string

PipelineResourceSpec

(Appears on: PipelineResource, TaskResourceBinding)

PipelineResourceSpec defines an individual resources used in the pipeline.

Field Description
type
PipelineResourceType
params
[]Param
secrets
[]SecretParam
(Optional)

Secrets to fetch to populate some of resource fields

PipelineResourceStatus

(Appears on: PipelineResource)

PipelineResourceStatus does not contain anything because Resources on their own do not have a status, they just hold data which is later used by PipelineRuns and TaskRuns.

PipelineResourceStorageType (string alias)

PipelineResourceType (string alias)

(Appears on: BuildGCSResource, ClusterResource, GCSResource, GitResource, ImageResource, PipelineDeclaredResource, PipelineResourceSpec, PullRequestResource, TaskResource)

PipelineResourceType represents the type of endpoint the pipelineResource is, so that the controller will know this pipelineResource should be fetched and optionally what additional metatdata should be provided for it.

PipelineRunSpec

(Appears on: PipelineRun)

PipelineRunSpec defines the desired state of PipelineRun

Field Description
pipelineRef
PipelineRef
resources
[]PipelineResourceBinding

Resources is a list of bindings specifying which actual instances of PipelineResources to use for the resources the Pipeline has declared it needs.

params
[]Param

Params is a list of parameter names and values.

serviceAccount
string
(Optional)
serviceAccounts
[]PipelineRunSpecServiceAccount
(Optional)
results
Results
(Optional)
status
PipelineRunSpecStatus
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

Time after which the Pipeline times out. Defaults to never. Refer to Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

nodeSelector
map[string]string
(Optional)

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

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

PipelineRunSpecServiceAccount

(Appears on: PipelineRunSpec)

PipelineRunSpecServiceAccount can be used to configure specific ServiceAccount for a concrete Task

Field Description
taskName
string
serviceAccount
string

PipelineRunSpecStatus (string alias)

(Appears on: PipelineRunSpec)

PipelineRunSpecStatus defines the pipelinerun spec status the user can provide

PipelineRunStatus

(Appears on: PipelineRun)

PipelineRunStatus defines the observed state of PipelineRun

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

results
Results
(Optional)

In #107 should be updated to hold the location logs have been uploaded to

startTime
Kubernetes meta/v1.Time
(Optional)

StartTime is the time the PipelineRun is actually started.

completionTime
Kubernetes meta/v1.Time
(Optional)

CompletionTime is the time the PipelineRun completed.

taskRuns
map[string]*github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1.PipelineRunTaskRunStatus
(Optional)

map of PipelineRunTaskRunStatus with the taskRun name as the key

PipelineRunTaskRunStatus

PipelineRunTaskRunStatus contains the name of the PipelineTask for this TaskRun and the TaskRun’s Status

Field Description
pipelineTaskName
string

PipelineTaskName is the name of the PipelineTask.

status
TaskRunStatus
(Optional)

Status is the TaskRunStatus for the corresponding TaskRun

PipelineSpec

(Appears on: Pipeline)

PipelineSpec defines the desired state of Pipeline.

Field Description
resources
[]PipelineDeclaredResource

Resources declares the names and types of the resources given to the Pipeline’s tasks as inputs and outputs.

tasks
[]PipelineTask

Tasks declares the graph of Tasks that execute when this Pipeline is run.

params
[]ParamSpec

Params declares a list of input parameters that must be supplied when this Pipeline is run.

PipelineStatus

(Appears on: Pipeline)

PipelineStatus does not contain anything because Pipelines on their own do not have a status, they just hold data which is later used by a PipelineRun.

PipelineStorageResourceInterface

PipelineResourceInterface interface to be implemented by different PipelineResource types

PipelineTask

(Appears on: Node, PipelineSpec)

PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.

Field Description
name
string

Name is the name of this task within the context of a Pipeline. Name is used as a coordinate with the from and runAfter fields to establish the execution order of tasks relative to one another.

taskRef
TaskRef

TaskRef is a reference to a task definition.

retries
int
(Optional)

Retries represents how many times this task should be retried in case of task failure: ConditionSucceeded set to False

runAfter
[]string
(Optional)

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)

resources
PipelineTaskResources
(Optional)

Resources declares the resources given to this task as inputs and outputs.

params
[]Param
(Optional)

Parameters declares parameters passed to this task.

PipelineTaskInputResource

(Appears on: PipelineTaskResources)

PipelineTaskInputResource maps the name of a declared PipelineResource input dependency in a Task to the resource in the Pipeline’s DeclaredPipelineResources that should be used. This input may come from a previous task.

Field Description
name
string

Name is the name of the PipelineResource as declared by the Task.

resource
string

Resource is the name of the DeclaredPipelineResource to use.

from
[]string
(Optional)

From is the list of PipelineTask names that the resource has to come from. (Implies an ordering in the execution graph.)

PipelineTaskOutputResource

(Appears on: PipelineTaskResources)

PipelineTaskOutputResource maps the name of a declared PipelineResource output dependency in a Task to the resource in the Pipeline’s DeclaredPipelineResources that should be used.

Field Description
name
string

Name is the name of the PipelineResource as declared by the Task.

resource
string

Resource is the name of the DeclaredPipelienResource to use.

PipelineTaskParam

PipelineTaskParam is used to provide arbitrary string parameters to a Task.

Field Description
name
string
value
string

PipelineTaskResources

(Appears on: PipelineTask)

PipelineTaskResources allows a Pipeline to declare how its DeclaredPipelineResources should be provided to a Task as its inputs and outputs.

Field Description
inputs
[]PipelineTaskInputResource

Inputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

outputs
[]PipelineTaskOutputResource

Outputs holds the mapping from the PipelineResources declared in DeclaredPipelineResources to the input PipelineResources required by the Task.

PipelineTaskRun

PipelineTaskRun reports the results of running a step in the Task. Each task has the potential to succeed or fail (based on the exit code) and produces logs.

Field Description
name
string

PullRequestResource

PullRequestResource is an endpoint from which to get data which is required by a Build/Task for context.

Field Description
name
string
type
PipelineResourceType
destinationDir
string
url
string

GitHub URL pointing to the pull request. Example: https://github.com/owner/repo/pulls/1

secrets
[]SecretParam

Secrets holds a struct to indicate a field name and corresponding secret name to populate it.

ResultTargetType (string alias)

(Appears on: Results)

ResultTargetType represents the type of endpoint that this result target is, so that the controller will know how to write results to it.

Results

(Appears on: PipelineRunSpec, PipelineRunStatus, TaskRunSpec, TaskRunStatus)

Results is used to identify an endpoint where results can be uploaded. The serviceaccount used for the pipeline must have access to this endpoint.

Field Description
type
ResultTargetType
url
string

SecretParam

(Appears on: ArtifactBucket, ClusterResource, GCSResource, PipelineResourceSpec, PullRequestResource)

SecretParam indicates which secret can be used to populate a field of the resource

Field Description
fieldName
string
secretKey
string
secretName
string

StepState

(Appears on: TaskRunStatus)

StepState reports the results of running a step in the Task.

Field Description
ContainerState
Kubernetes core/v1.ContainerState
name
string

TaskInterface

TaskInterface is implemented by Task and ClusterTask

TaskKind (string alias)

(Appears on: TaskRef)

TaskKind defines the type of Task used by the pipeline.

TaskRef

(Appears on: PipelineTask, TaskRunSpec)

TaskRef can be used to refer to a specific instance of a task. Copied from CrossVersionObjectReference: https://github.com/kubernetes/kubernetes/blob/169df7434155cbbc22f1532cba8e0a9588e29ad8/pkg/apis/autoscaling/types.go#L64

Field Description
name
string

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

kind
TaskKind

TaskKind inficates the kind of the task, namespaced or cluster scoped.

apiVersion
string
(Optional)

API version of the referent

TaskResource

(Appears on: Inputs, Outputs)

TaskResource defines an input or output Resource declared as a requirement by a Task. The Name field will be used to refer to these Resources within the Task definition, and when provided as an Input, the Name will be the path to the volume mounted containing this Resource as an input (e.g. an input Resource named workspace will be mounted at /workspace).

Field Description
name
string

Name declares the name by which a resource is referenced in the Task’s definition. Resources may be referenced by name in the definition of a Task’s steps.

type
PipelineResourceType

Type is the type of this resource;

targetPath
string
(Optional)

TargetPath is the path in workspace directory where the task resource will be copied.

outputImageDir
string
(Optional)

Path to the index.json file for output container images.

TaskResourceBinding

(Appears on: TaskRunInputs, TaskRunOutputs)

TaskResourceBinding points to the PipelineResource that will be used for the Task input or output called Name. The optional Path field corresponds to a path on disk at which the Resource can be found (used when providing the resource via mounted volume, overriding the default logic to fetch the Resource).

Field Description
name
string
resourceRef
PipelineResourceRef
(Optional)

no more than one of the ResourceRef and ResourceSpec may be specified.

resourceSpec
PipelineResourceSpec
(Optional)
paths
[]string
(Optional)

TaskRunInputs

(Appears on: TaskRunSpec)

TaskRunInputs holds the input values that this task was invoked with.

Field Description
resources
[]TaskResourceBinding
(Optional)
params
[]Param
(Optional)

TaskRunOutputs

(Appears on: TaskRunSpec)

TaskRunOutputs holds the output values that this task was invoked with.

Field Description
resources
[]TaskResourceBinding
(Optional)

TaskRunSpec

(Appears on: TaskRun)

TaskRunSpec defines the desired state of TaskRun

Field Description
inputs
TaskRunInputs
(Optional)
outputs
TaskRunOutputs
(Optional)
results
Results
(Optional)
serviceAccount
string
(Optional)
taskRef
TaskRef
(Optional)

no more than one of the TaskRef and TaskSpec may be specified.

taskSpec
TaskSpec
(Optional)
status
TaskRunSpecStatus
(Optional)

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

timeout
Kubernetes meta/v1.Duration
(Optional)

Time after which the build times out. Defaults to 10 minutes. Specified build timeout should be less than 24h. Refer Go’s ParseDuration documentation for expected format: https://golang.org/pkg/time/#ParseDuration

nodeSelector
map[string]string
(Optional)

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

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

TaskRunSpecStatus (string alias)

(Appears on: TaskRunSpec)

TaskRunSpecStatus defines the taskrun spec status the user can provide

TaskRunStatus

(Appears on: TaskRun, PipelineRunTaskRunStatus, TaskRunStatus)

TaskRunStatus defines the observed state of TaskRun

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

results
Results
(Optional)

In #107 should be updated to hold the location logs have been uploaded to

podName
string

PodName is the name of the pod responsible for executing this task’s steps.

startTime
Kubernetes meta/v1.Time
(Optional)

StartTime is the time the build is actually started.

completionTime
Kubernetes meta/v1.Time
(Optional)

CompletionTime is the time the build completed.

steps
[]StepState
(Optional)

Steps describes the state of each build step container.

retriesStatus
[]TaskRunStatus
(Optional)

RetriesStatus contains the history of TaskRunStatus in case of a retry in order to keep record of failures. All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant.

resourcesResult
[]PipelineResourceResult

Results from Resources built during the taskRun. currently includes the digest of build container images optional

TaskSpec

(Appears on: ClusterTask, Task, TaskRunSpec)

TaskSpec defines the desired state of Task.

Field Description
inputs
Inputs
(Optional)

Inputs is an optional set of parameters and resources which must be supplied by the user when a Task is executed by a TaskRun.

outputs
Outputs
(Optional)

Outputs is an optional set of resources and results produced when this Task is run.

steps
[]Kubernetes core/v1.Container

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

volumes
[]Kubernetes core/v1.Volume

Volumes is a collection of volumes that are available to mount into the steps of the build.

stepTemplate
Kubernetes core/v1.Container

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

containerTemplate
Kubernetes core/v1.Container

ContainerTemplate is the deprecated previous name of the StepTemplate field (#977).

TestResult

(Appears on: Outputs)

TestResult allows a task to specify the location where test logs can be found and what format they will be in.

Field Description
name
string

Name declares the name by which a result is referenced in the Task’s definition. Results may be referenced by name in the definition of a Task’s steps.

format
string

TODO: maybe this is an enum with types like “go test”, “junit”, etc.

path
string

Generated with gen-crd-api-reference-docs on git commit 52e137b.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment