From 4c599237e7d40a39389779a0d2ef01a4cae1bb7e Mon Sep 17 00:00:00 2001 From: aThorp96 Date: Mon, 20 Jan 2025 15:43:30 -0500 Subject: [PATCH] Add PipelineRun pipeline-timeout note to pipeline docs 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. --- docs/pipelines.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/pipelines.md b/docs/pipelines.md index a8fab09577b..d9f8568fe86 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -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