🐛 fix bug when set renewDeadline greater than leaseDuration the control… #1761

yuzp1996 · 2021-12-30T16:46:48Z

fix bug when set renewDeadline greater than leaseDuration the controller will hang and no error will be return

linux-foundation-easycla · 2021-12-30T16:46:51Z

The committers are authorized under a signed CLA.

✅ 于志鹏 (e009b83)

k8s-ci-robot · 2021-12-30T16:46:51Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

k8s-ci-robot · 2021-12-30T16:46:56Z

Welcome @yuzp1996!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2021-12-30T16:46:56Z

Hi @yuzp1996. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

k8s-ci-robot · 2021-12-30T16:47:05Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: yuzp1996
To complete the pull request process, please assign droot after the PR has been reviewed.
You can assign the PR to them by writing /assign @droot in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

yuzp1996 · 2021-12-31T02:11:46Z

pkg/manager/internal.go

@@ -634,6 +634,7 @@ func (cm *controllerManager) startLeaderElection(ctx context.Context) (err error
 		ReleaseOnCancel: cm.leaderElectionReleaseOnCancel,
 	})
 	if err != nil {


if err happend the leaderElectionStopped will not close and engageStopProcedure will hang in this code

defer func() { // Cancel leader election only after we waited. It will os.Exit() the app for safety. if cm.resourceLock != nil { // After asking the context to be cancelled, make sure // we wait for the leader stopped channel to be closed, otherwise // we might encounter race conditions between this code // and the event recorder, which is used within leader election code. cm.leaderElectionCancel() <-cm.leaderElectionStopped } }()

so I think when error happened we should close this channel

FillZpp · 2021-12-31T03:20:03Z

@yuzp1996 Yeah, it is a bug here, but not only for the NewLeaderElector error.

The cause of the manager hang during stopping, is the cm.leaderElectionStopped might not be closed. Sometimes the cm.leaderElectionCancel might be nil so it could also panic here. For example it fails to cm.add(cm.cluster) or cm.runnables.Webhooks.Start(cm.internalCtx) in the Start().

        // Cancel leader election only after we waited. It will os.Exit() the app for safety.
        if cm.resourceLock != nil {
	        // After asking the context to be cancelled, make sure
	        // we wait for the leader stopped channel to be closed, otherwise
	        // we might encounter race conditions between this code
	        // and the event recorder, which is used within leader election code.
	        cm.leaderElectionCancel()
	        <-cm.leaderElectionStopped
        }

So it might need to change like this, IMHO

Init leaderElectionStopped only when NewLeaderElector succeeds.
Should check if cm.leaderElectionCancel is nil before cm.leaderElectionCancel() and check if cm.leaderElectionStopped is nil before <-cm.leaderElectionStopped. If so, maybe there is no need to check if cm.resourceLock != nil here any more.

yuzp1996 · 2022-01-03T14:11:56Z

pkg/manager/internal.go

@@ -637,6 +638,10 @@ func (cm *controllerManager) startLeaderElection(ctx context.Context) (err error
 		return err
 	}

+	ctx, cancel := context.WithCancel(context.Background())


Following @FillZpp's suggestion, I changed the location of initialization cm.leaderElectionCancel and cm.leaderElectionStopped. So these values will not be nil if NewLeaderElector succeeds.

When engageStopProcedure needs to check cm.leaderElectionCancel and cm.leaderElectionStopped, it will first check whether they are nil.

I'm not sure if this is correct, if we set the context and cancel here it'll be set in a goroutine which can cause a race condition if the controller closes too quickly.

FillZpp

Mostly LG. Some nits.
/ok-to-test

FillZpp · 2022-01-04T03:13:20Z

pkg/manager/internal.go

+		// we wait for the leader stopped channel to be closed, otherwise
+		// we might encounter race conditions between this code
+		// and the event recorder, which is used within leader election code.
+		if cm.leaderElectionCancel != nil {


It seems you only have to check one of cm.leaderElectionCancel and cm.leaderElectionStopped for now they are assigned at the same place.

Yes but I think maybe checking them individually is safer 😄

FillZpp · 2022-01-04T03:21:16Z

@yuzp1996 And you have to fix the failed job, which you can test locally with make lint.

…ler will hang and no error will be return but actually the error should be throw and exit Signed-off-by: yuzhipeng <[email protected]>

FillZpp · 2022-01-04T06:20:02Z

Thanks for fixing this.
/lgtm
/cc @vincepri @alvaroaleman PTAL

k8s-ci-robot · 2022-01-04T06:20:05Z

@FillZpp: GitHub didn't allow me to request PR reviews from the following users: PTAL.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Thanks for fixing this.
/lgtm
/cc @vincepri @alvaroaleman PTAL

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.

vincepri

Why do you want renewDeadline greater than lease duration? The lease should always be greater than its renewal, otherwise you might end up losing leader election which is probably what's happening here.

We could validate that the rule above applies and enforce it when configuring the manager, instead of changing the code around to avoid leader election.

/hold

yuzp1996 · 2022-01-19T23:21:48Z

Yes, I think we have had the validation but when someone set renewDeadline greater than lease duration the whole process will block and does not throw an error.

I don't think this is the correct way to do that so I make some changes to make sure errors can be thrown

FillZpp · 2022-01-20T03:59:55Z

@vincepri As I said above, it is not only caused by renewDeadline greater than lease duration.

Any error occurred between defer engageStopProcedure in controllerManager.Start() and // Start the leader elector process in controllerManager.startLeaderElection(), such as:

Error of cm.add(cm.cluster)
Error of cm.runnables.Webhooks.Start(cm.internalCtx)
Error of cm.runnables.Caches.Start(cm.internalCtx)
Error of cm.runnables.Others.Start(cm.internalCtx)
Error of leaderelection.NewLeaderElector

They will all return error, trigger engageStopProcedure in defer, and finally hang on <-cm.leaderElectionStopped, because the channel will not be closed forever.

FillZpp · 2022-01-25T06:24:30Z

WDYT @vincepri

k8s-triage-robot · 2022-04-25T07:06:56Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-05-25T07:39:43Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

FillZpp · 2022-05-25T07:44:51Z

/remove-lifecycle rotten

k8s-triage-robot · 2022-08-23T08:29:41Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-09-22T08:37:00Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

vincepri · 2022-09-26T16:41:27Z

Can we add a failing test that covers the above bug first which can help explain and prevent the deadlock above? I cannot reproduce locally, so it'd be good to have a test for this

k8s-triage-robot · 2022-10-26T17:03:22Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2022-10-26T17:03:26Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 30, 2021

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Dec 30, 2021

k8s-ci-robot requested review from droot and pwittrock December 30, 2021 16:47

yuzp1996 changed the title ~~fix bug when set renewDeadline greater than leaseDuration the control…~~ 🐛 fix bug when set renewDeadline greater than leaseDuration the control… Dec 30, 2021

yuzp1996 force-pushed the master branch from e009b83 to 5302c1f Compare December 31, 2021 02:07

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 31, 2021

yuzp1996 commented Dec 31, 2021

View reviewed changes

yuzp1996 force-pushed the master branch from 5302c1f to 4df5727 Compare January 3, 2022 13:53

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 3, 2022

yuzp1996 force-pushed the master branch from 4df5727 to ef93ca1 Compare January 3, 2022 13:54

yuzp1996 commented Jan 3, 2022

View reviewed changes

FillZpp reviewed Jan 4, 2022

View reviewed changes

k8s-ci-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 Jan 4, 2022

yuzp1996 closed this Jan 4, 2022

yuzp1996 reopened this Jan 4, 2022

fix bug when set renewDeadline greater than leaseDuration the control…

df792cd

…ler will hang and no error will be return but actually the error should be throw and exit Signed-off-by: yuzhipeng <[email protected]>

yuzp1996 force-pushed the master branch from ef93ca1 to df792cd Compare January 4, 2022 05:16

k8s-ci-robot requested review from vincepri and alvaroaleman January 4, 2022 06:20

k8s-ci-robot assigned FillZpp Jan 4, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 4, 2022

vincepri reviewed Jan 19, 2022

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 19, 2022

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 25, 2022

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 25, 2022

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label May 25, 2022

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 23, 2022

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 22, 2022

k8s-ci-robot closed this Oct 26, 2022

Tomasz-Smelcerz-SAP mentioned this pull request Mar 28, 2024

chore: Increase leader election timeout kyma-project/lifecycle-manager#1351

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 fix bug when set renewDeadline greater than leaseDuration the control… #1761

🐛 fix bug when set renewDeadline greater than leaseDuration the control… #1761

yuzp1996 commented Dec 30, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 30, 2021 •

edited

Loading

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

yuzp1996 Dec 31, 2021

FillZpp commented Dec 31, 2021

yuzp1996 Jan 3, 2022

vincepri Jan 19, 2022

FillZpp left a comment

FillZpp Jan 4, 2022

yuzp1996 Jan 4, 2022

FillZpp commented Jan 4, 2022

FillZpp commented Jan 4, 2022

k8s-ci-robot commented Jan 4, 2022

vincepri left a comment

yuzp1996 commented Jan 19, 2022 •

edited

Loading

FillZpp commented Jan 20, 2022 •

edited

Loading

FillZpp commented Jan 25, 2022

k8s-triage-robot commented Apr 25, 2022

k8s-triage-robot commented May 25, 2022

FillZpp commented May 25, 2022

k8s-triage-robot commented Aug 23, 2022

k8s-triage-robot commented Sep 22, 2022

vincepri commented Sep 26, 2022

k8s-triage-robot commented Oct 26, 2022

k8s-ci-robot commented Oct 26, 2022

🐛 fix bug when set renewDeadline greater than leaseDuration the control… #1761

🐛 fix bug when set renewDeadline greater than leaseDuration the control… #1761

Conversation

yuzp1996 commented Dec 30, 2021 • edited Loading

linux-foundation-easycla bot commented Dec 30, 2021 • edited Loading

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

k8s-ci-robot commented Dec 30, 2021

yuzp1996 Dec 31, 2021

Choose a reason for hiding this comment

FillZpp commented Dec 31, 2021

yuzp1996 Jan 3, 2022

Choose a reason for hiding this comment

vincepri Jan 19, 2022

Choose a reason for hiding this comment

FillZpp left a comment

Choose a reason for hiding this comment

FillZpp Jan 4, 2022

Choose a reason for hiding this comment

yuzp1996 Jan 4, 2022

Choose a reason for hiding this comment

FillZpp commented Jan 4, 2022

FillZpp commented Jan 4, 2022

k8s-ci-robot commented Jan 4, 2022

vincepri left a comment

Choose a reason for hiding this comment

yuzp1996 commented Jan 19, 2022 • edited Loading

FillZpp commented Jan 20, 2022 • edited Loading

FillZpp commented Jan 25, 2022

k8s-triage-robot commented Apr 25, 2022

k8s-triage-robot commented May 25, 2022

FillZpp commented May 25, 2022

k8s-triage-robot commented Aug 23, 2022

k8s-triage-robot commented Sep 22, 2022

vincepri commented Sep 26, 2022

k8s-triage-robot commented Oct 26, 2022

k8s-ci-robot commented Oct 26, 2022

yuzp1996 commented Dec 30, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 30, 2021 •

edited

Loading

yuzp1996 commented Jan 19, 2022 •

edited

Loading

FillZpp commented Jan 20, 2022 •

edited

Loading