From d53c49e9ac7e387f48c769d13d588482b7d7a6a1 Mon Sep 17 00:00:00 2001 From: Priti Desai Date: Wed, 10 Jul 2024 16:25:37 -0700 Subject: [PATCH] document failureIgnored Document the status when a taskRun fails but the failure is ignored with onError set to countinue. Signed-off-by: Priti Desai --- docs/taskruns.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/taskruns.md b/docs/taskruns.md index 8e0a4886506..9321bcaa16a 100644 --- a/docs/taskruns.md +++ b/docs/taskruns.md @@ -802,20 +802,21 @@ steps: The following tables shows how to read the overall status of a `TaskRun`: -`status` | `reason` | `message` | `completionTime` is set | Description -:--------|:-----------------------|:------------------------------------------------------------------|:-----------------------:|-------------------------------------------------------------------------------------------------: -Unknown | Started | n/a | No | The TaskRun has just been picked up by the controller. -Unknown | Pending | n/a | No | The TaskRun is waiting on a Pod in status Pending. -Unknown | Running | n/a | No | The TaskRun has been validated and started to perform its work. -Unknown | TaskRunCancelled | n/a | No | The user requested the TaskRun to be cancelled. Cancellation has not been done yet. -True | Succeeded | n/a | Yes | The TaskRun completed successfully. -False | Failed | n/a | Yes | The TaskRun failed because one of the steps failed. -False | \[Error message\] | n/a | No | The TaskRun encountered a non-permanent error, and it's still running. It may ultimately succeed. -False | \[Error message\] | n/a | Yes | The TaskRun failed with a permanent error (usually validation). -False | TaskRunCancelled | n/a | Yes | The TaskRun was cancelled successfully. -False | TaskRunCancelled | TaskRun cancelled as the PipelineRun it belongs to has timed out. | Yes | The TaskRun was cancelled because the PipelineRun timed out. -False | TaskRunTimeout | n/a | Yes | The TaskRun timed out. -False | TaskRunImagePullFailed | n/a | Yes | The TaskRun failed due to one of its steps not being able to pull the image. +| `status` | `reason` | `message` | `completionTime` is set | Description | +|:---------|:-----------------------|:------------------------------------------------------------------|:-----------------------:|--------------------------------------------------------------------------------------------------:| +| Unknown | Started | n/a | No | The TaskRun has just been picked up by the controller. | +| Unknown | Pending | n/a | No | The TaskRun is waiting on a Pod in status Pending. | +| Unknown | Running | n/a | No | The TaskRun has been validated and started to perform its work. | +| Unknown | TaskRunCancelled | n/a | No | The user requested the TaskRun to be cancelled. Cancellation has not been done yet. | +| True | Succeeded | n/a | Yes | The TaskRun completed successfully. | +| False | Failed | n/a | Yes | The TaskRun failed because one of the steps failed. | +| False | \[Error message\] | n/a | No | The TaskRun encountered a non-permanent error, and it's still running. It may ultimately succeed. | +| False | \[Error message\] | n/a | Yes | The TaskRun failed with a permanent error (usually validation). | +| False | TaskRunCancelled | n/a | Yes | The TaskRun was cancelled successfully. | +| False | TaskRunCancelled | TaskRun cancelled as the PipelineRun it belongs to has timed out. | Yes | The TaskRun was cancelled because the PipelineRun timed out. | +| False | TaskRunTimeout | n/a | Yes | The TaskRun timed out. | +| False | TaskRunImagePullFailed | n/a | Yes | The TaskRun failed due to one of its steps not being able to pull the image. | +| False | FailureIgnored | n/a | Yes | The TaskRun failed but the failure was ignored. | When a `TaskRun` changes status, [events](events.md#taskruns) are triggered accordingly.