Skip to content

Commit

Permalink
Update TaskRuns documentation ToC
Browse files Browse the repository at this point in the history
This fixes missing and changed entries in the ToC according to the
section headings. Some minor improvements were made, including moving
some headings to their correct depth.
  • Loading branch information
nbaudis authored and tekton-robot committed Sep 29, 2021
1 parent 6b6c672 commit 43a5891
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions docs/taskruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,41 @@ weight: 300

# `TaskRuns`

- [Overview](#taskruns)
<!-- toc -->
- [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)
- [Example `TaskRun` with a referenced `Task`](#example-taskrun-with-a-referenced-task)
- [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)
<!-- /toc -->

# 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
Expand Down Expand Up @@ -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
Expand All @@ -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`
Expand Down Expand Up @@ -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.

Expand All @@ -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.
Expand Down

0 comments on commit 43a5891

Please sign in to comment.