Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: clean results when taskrun retries #7126

Merged
merged 1 commit into from
Sep 20, 2023

Conversation

cugykw
Copy link
Contributor

@cugykw cugykw commented Sep 18, 2023

Changes

Fixes #7125 .

Prior to this PR, after retrying taskrun, the task results of the last run will be retained, which may cause the running situation to be inconsistent with the results.

After this commit, the taskrun will clean up the last task results before retrying.

/kind bug

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

The taskrun will clean up the last task results before retrying.

@tekton-robot tekton-robot added kind/bug Categorizes issue or PR as related to a bug. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Sep 18, 2023
@tekton-robot
Copy link
Collaborator

Hi @cugykw. 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.

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 18, 2023
@tekton-robot
Copy link
Collaborator

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
pkg/reconciler/taskrun/taskrun.go 85.4% 85.4% 0.0

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 18, 2023
@tekton-robot
Copy link
Collaborator

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
pkg/reconciler/taskrun/taskrun.go 85.4% 85.4% 0.0

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it makes sense to me to clean results before a retry attempt, would like to hear from other @tektoncd/core-maintainers though

please update the documentation with this change:

- `status.StartTime` and `status.PodName` are unset to trigger another retry attempt.

also wondering if there's a way for us to checkpoint workspaces before a taskrun then reset to that state on retry attempts, but this can be figured out in future work -- maybe for now we just document that workspaces may be corrupted on retry so the task needs to handle that itself

@cugykw cugykw force-pushed the clear-taskrun-result-with-retry branch from 41596ca to bfc0c4e Compare September 19, 2023 01:15
@tekton-robot
Copy link
Collaborator

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
pkg/reconciler/taskrun/taskrun.go 85.4% 85.4% 0.0

@tekton-robot
Copy link
Collaborator

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
pkg/reconciler/taskrun/taskrun.go 85.4% 85.4% 0.0

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 19, 2023
@vdemeester
Copy link
Member

also wondering if there's a way for us to checkpoint workspaces before a taskrun then reset to that state on retry attempts, but this can be figured out in future work -- maybe for now we just document that workspaces may be corrupted on retry so the task needs to handle that itself

That one is going to be a problem (at least in our current architecture) as we cannot really do anything here. Today, it kind-of falls down to the way the Task behave (and thus on the author of the task to make sure not to modify the workspace or in a indempotent way or something…)

@jerop
Copy link
Member

jerop commented Sep 20, 2023

also wondering if there's a way for us to checkpoint workspaces before a taskrun then reset to that state on retry attempts, but this can be figured out in future work -- maybe for now we just document that workspaces may be corrupted on retry so the task needs to handle that itself

That one is going to be a problem (at least in our current architecture) as we cannot really do anything here. Today, it kind-of falls down to the way the Task behave (and thus on the author of the task to make sure not to modify the workspace or in a indempotent way or something…)

Makes sense, we can just document that Tasks authors need to make sure that Workspaces are handled during retries

In the meantime, we can move forward with this fix for Results

@jerop jerop added this to the Pipelines v0.52 milestone Sep 20, 2023
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 20, 2023
@tekton-robot tekton-robot merged commit 6364191 into tektoncd:main Sep 20, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The task result before retry is retained in the current taskrun status.
5 participants