Add granular termination reason in container termination message

[renzodavid9]

Fixes #7223 and #7539

To report specific Steps termination reasons we need to know why its container finished; we use the termination message to store a new "state" with this information. To avoid breaking changes we are introducing a new status.steps[].terminationReason in TaskRun, to store the information from the container state for each step.

The schema conversion logic for v1beta1 to v1 is modified to take into account the new field introduced in v1 TaskRun.

/kind feature

Changes

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

• Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
• Has Tests included if any functionality added or changed
• Follows the commit message standard
• Meets the Tekton contributor standards (including functionality, content, code)
• Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
• Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
• Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Steps in a TaskRun will have more granular termination reasons indicating what exactly happened in new terminationReason field: Completed, Continued, Error, TimeoutExceeded, Skipped, TaskRunCancelled

[tekton-robot]

Hi @renzodavid9. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[chitrangpatel]

/ok-to-test

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/entrypoint/entrypointer.go	87.0%	86.5%	-0.5
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/entrypoint/entrypointer.go	87.0%	86.5%	-0.5
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[renzodavid9]

/assign @chitrangpatel @JeromeJu

[JeromeJu]

Thanks @renzodavid9 , this change generally looks good to me following up the discussion at #7539 . Would you mind adding a bit explanation at taskrun.md i.e. https://github.com/tektoncd/pipeline/blob/main/docs/taskruns.md#the-status-field.

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[renzodavid9]

Thanks @renzodavid9 , this change generally looks good to me following up the discussion at #7539 . Would you mind adding a bit explanation at taskrun.md i.e. https://github.com/tektoncd/pipeline/blob/main/docs/taskruns.md#the-status-field.

Thanks @JeromeJu, I added the field to the section you mentioned and in a couple of examples where we are referencing the status.steps[] field. Please let mw know if it looks good, or if we should add more detail to it. Thanks!

[chitrangpatel]

/approve

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel, JeromeJu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [JeromeJu,chitrangpatel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[chitrangpatel]

Thanks @renzodavid9 for all your hardwork!

[chitrangpatel]

@AlanGreene @vdemeester PTAL to ensure that this wont break dashboard etc.

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
cmd/entrypoint/waiter.go	81.0%	85.0%	4.0
pkg/apis/pipeline/v1beta1/taskrun_conversion.go	91.8%	91.9%	0.1
pkg/entrypoint/entrypointer.go	89.3%	89.0%	-0.4
pkg/pod/status.go	93.0%	95.2%	2.2
pkg/reconciler/taskrun/taskrun.go	85.2%	85.3%	0.1

[AlanGreene]

@AlanGreene @vdemeester PTAL to ensure that this wont break dashboard etc.

As long as this is just adding a new field and leaving the existing fields as they are (as discussed in the issue) it will be fine for the Dashboard at least.

[chitrangpatel]

/lgtm