Skip to content

Commit

Permalink
Update API reference docs for TaskRun
Browse files Browse the repository at this point in the history
This commit adds missing optional fields to "Configuring a TaskRun".
Other than these changes, the TaskRun documentation looks up to date.
  • Loading branch information
lbernick authored and tekton-robot committed Mar 11, 2022
1 parent a343e75 commit 9a2deb3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/taskruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,17 @@ A `TaskRun` definition supports the following fields:
- [`serviceAccountName`](#specifying-serviceaccount-credentials) - Specifies a `ServiceAccount`
object that provides custom credentials for executing the `TaskRun`.
- [`params`](#specifying-parameters) - Specifies the desired execution parameters for the `Task`.
- [`resources`](#specifying-resources) - Specifies the desired `PipelineResource` values.
- [`resources` (deprecated)](#specifying-resources) - Specifies the desired `PipelineResource` values.
- [`inputs`](#specifying-resources) - Specifies the input resources.
- [`outputs`](#specifying-resources) - Specifies the output resources.
- [`timeout`](#configuring-the-failure-timeout) - Specifies the timeout before the `TaskRun` fails.
- [`podTemplate`](#specifying-a-pod-template) - Specifies a [`Pod` template](podtemplates.md) to use as
the starting point for configuring the `Pods` for the `Task`.
- [`workspaces`](#specifying-workspaces) - Specifies the physical volumes to use for the
[`Workspaces`](workspaces.md#using-workspaces-in-tasks) declared by a `Task`.
- [`debug`](#debugging-a-taskrun)- Specifies any breakpoints and debugging configuration for the `Task` execution.
- [`stepOverrides`](#overriding-task-steps-and-sidecars) - Specifies configuration to use to override the `Task`'s `Step`s.
- [`sidecarOverrides`](#overriding-task-steps-and-sidecars) - Specifies configuration to use to override the `Task`'s `Sidecar`s.

[kubernetes-overview]:
https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
Expand Down

0 comments on commit 9a2deb3

Please sign in to comment.