diff --git a/docs/taskruns.md b/docs/taskruns.md index e872b9a1ff1..beb45f55c65 100644 --- a/docs/taskruns.md +++ b/docs/taskruns.md @@ -7,23 +7,30 @@ weight: 300 # `TaskRuns` -- [Overview](#taskruns) + +- [Overview](#overview) - [Configuring a `TaskRun`](#configuring-a-taskrun) - [Specifying the target `Task`](#specifying-the-target-task) - [Tekton Bundles](#tekton-bundles) - [Specifying `Parameters`](#specifying-parameters) + - [Implicit Parameters](#implicit-parameters) + - [Extra Parameters](#extra-parameters) - [Specifying `Resources`](#specifying-resources) - - [Specifying `ServiceAccount` credentials](#specifying-serviceaccount-credentials) + - [Specifying `Resource` limits](#specifying-resource-limits) - [Specifying a `Pod` template](#specifying-a-pod-template) - [Specifying `Workspaces`](#specifying-workspaces) - [Specifying `Sidecars`](#specifying-sidecars) - [Specifying `LimitRange` values](#specifying-limitrange-values) - [Configuring the failure timeout](#configuring-the-failure-timeout) + - [Specifying `ServiceAccount` credentials](#specifying-serviceaccount-credentials) - [Monitoring execution status](#monitoring-execution-status) - [Monitoring `Steps`](#monitoring-steps) + - [Steps](#steps) - [Monitoring `Results`](#monitoring-results) - [Cancelling a `TaskRun`](#cancelling-a-taskrun) - [Debugging a `TaskRun`](#debugging-a-taskrun) + - [Breakpoint on Failure](#breakpoint-on-failure) + - [Debug Environment](#debug-environment) - [Events](events.md#taskruns) - [Running a TaskRun Hermetically](hermetic.md) - [Code examples](#code-examples) @@ -31,9 +38,10 @@ weight: 300 - [Example `TaskRun` with an embedded `Task`](#example-taskrun-with-an-embedded-task) - [Reusing a `Task`](#reusing-a-task) - [Using custom `ServiceAccount` credentials](#using-custom-serviceaccount-credentials) - - [Running step containers as a non-root user](#running-step-containers-as-a-non-root-user) + - [Running Step Containers as a Non Root User](#running-step-containers-as-a-non-root-user) + -# Overview +## Overview A `TaskRun` allows you to instantiate and execute a [`Task`](tasks.md) on-cluster. A `Task` specifies one or more `Steps` that execute container images and each container image performs a specific piece of build work. A `TaskRun` executes the @@ -370,7 +378,7 @@ object(s), if present. Any `Request` or `Limit` specified by the user (on `Task` For more information, see the [`LimitRange` support in Pipeline](./limitrange.md). -## Configuring the failure timeout +### Configuring the failure timeout You can use the `timeout` field to set the `TaskRun's` desired timeout value. If you do not specify this value for the `TaskRun`, the global default timeout value applies. If you set the timeout to 0, the `TaskRun` will @@ -390,7 +398,7 @@ If a `TaskRun` runs longer than its timeout value, the pod associated with the ` means that the logs of the `TaskRun` are not preserved. The deletion of the `TaskRun` pod is necessary in order to stop `TaskRun` step containers from running. -### Specifying `ServiceAccount' credentials +### Specifying `ServiceAccount` credentials You can execute the `Task` in your `TaskRun` with a specific set of credentials by specifying a `ServiceAccount` object name in the `serviceAccountName` field in your `TaskRun` @@ -509,9 +517,9 @@ spec: ``` -### Debugging a `TaskRun` +## Debugging a `TaskRun` -#### Breakpoint on Failure +### Breakpoint on Failure TaskRuns can be halted on failure for troubleshooting by providing the following spec patch as seen below. @@ -530,7 +538,7 @@ During this time, the user/client can get remote shell access to the step contai kubectl exec -it print-date-d7tj5-pod-w5qrn -c step-print-date-human-readable ``` -#### Debug Environment +### Debug Environment After the user/client has access to the container environment, they can scour for any missing parts because of which their step might have failed.