Skip to content

Commit

Permalink
Add PipelineRun pipeline-timeout note to pipeline docs
Browse files Browse the repository at this point in the history
The Pipelines docs' timeout section did not mention that the Pipeline
itself had its timeout configured by the PipelineRun, causing some
confusion in #8114. Without adding a whole section, linking to the
PipelineRun timeout docs in a note about Task vs Pipeline timeout
precedence both documents where the pipeline timeout is configured
while also clarifying the misconception of timeout precedence.
  • Loading branch information
aThorp96 committed Jan 20, 2025
1 parent 0d698a7 commit 4c59923
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -1202,6 +1202,10 @@ format. For example, valid values are `1h30m`, `1h`, `1m`, and `60s`.

**Note:** If you do not specify a `Timeout` value, Tekton instead honors the timeout for the [`PipelineRun`](pipelineruns.md#configuring-a-pipelinerun).

**Note:** If the specified `Task` timeout is greater than the Pipeline timeout as configured in the [`PipelineRun`](pipelineruns.md#configuring-a-failure-timeout), the Pipeline will time-out first causing the `Task` to timeout before its configured timeout.
For example, if the `PipelineRun` sets `timeouts.pipeline = 1h` and the `Pipeline` sets `tasks[0].timeout = 3h`, the task will still timeout after `1h`.
See [`PipelineRun - Configuring a failure timeout`](pipelineruns.md#configuring-a-failure-timeout) for details.

In the example below, the `build-the-image` `Task` is configured to time out after 90 seconds:

```yaml
Expand Down

0 comments on commit 4c59923

Please sign in to comment.