TEP-0167: Actionable Failure Diagnostics for TaskRuns#1266
Open
waveywaves wants to merge 1 commit intotektoncd:mainfrom
Open
TEP-0167: Actionable Failure Diagnostics for TaskRuns#1266waveywaves wants to merge 1 commit intotektoncd:mainfrom
waveywaves wants to merge 1 commit intotektoncd:mainfrom
Conversation
This TEP proposes structured failure classification and diagnostic context for TaskRun failures, replacing the generic "Failed" reason with specific machine-readable reasons (StepOOM, PodEvicted, InitContainerFailed, ContainerCreationFailed, etc.) and adding a failureInfo field to TaskRun status. /kind tep Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add structured failure classification and diagnostic context to TaskRun status, replacing the generic
reason: Failedwith specific machine-readable reasons and a newfailureInfofield.Today, all non-timeout TaskRun failures produce
reason: Failedregardless of root cause — OOM, pod eviction, init container crash, CRI-O timeout, or non-zero exit code all look the same. Users mustkubectl describe podand manually correlate container statuses. Containers that never started (kubelet-to-CRI timeout) produce no error message at all.Key Design Points
StepOOM,StepFailed,SidecarOOM,SidecarFailed,InitContainerOOM,InitContainerFailed,PodEvicted,ContainerCreationFailed, andFailed(fallthrough)ContainerCreationFailedfailureInfostatus field: Structured diagnostic context including failing container, exit code, node conditions, pod events, and human-readable suggestionfinallytask access:$(tasks.<name>.failureInfo.reason)variable interpolation for conditional diagnostic logic infinallytasksfailureInfoonly populated on failureRelated TEPs
Implementation Status
PR #9368 implements Phase 1 (failure classification) and is approved, pending
/lgtm.Upstream Issues
/kind tep