🐛 Don't call session logout for keepAliveHandler

[xiujuanx]

What this PR does / why we need it:
We should not call session logout when keepAliveHandler. Once we call Logout, it means we send a stop signal to the handler. So when we reboot the VC, the keepAliveHandler finds the vCenter is down and we call logout, the keepAliveHandler will stop work. Also at this time, the VC is down, so logout will be stuck.
So this PR remove the session logout logic for keepAliveHandler, and keep session logout when the session is inactive.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1925

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

None

[k8s-ci-robot]

Welcome @xiujuanx!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-vsphere 🎉. 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/cluster-api-provider-vsphere 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]

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

[tommasopozzetti]

@srm09 Any chance of getting this reviewed and merged/released?
This issue is continuing to bite us and at the moment requires constant monitoring and manual restarting of the controller. This change would be extremely valuable to automate the safe-healing!
Thank you!

[zhanggbj]

Hi @xiujuanx , since sessionCache.Delete() is actually contains func (m *Map) LoadAndDelete(key any) (value any, loaded bool) which will load&delete in an atomic way, so do we still need the check sessionCache.Load(sessionKey) here?

[xiujuanx]

Thanks @zhanggbj for your review!
Indeed, we should not check if the key exists in the cache or not twice. I have changed the code, please help review it again. Thanks!

[zhanggbj]

cool, how about https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/pull/1949/files#diff-59fbb0bb5dfeeb4f123f1e9e0a3d12c38a60b839e113b29868cb905755639e13R145, this could also be moved out.

[zhanggbj]

/lgtm Thanks for the PR!

And need approvers to take a review @srm09 @MaxRink @yastij

[chrischdi]

/ok-to-test

[xiujuanx]

/ok-to-test

[xiujuanx]

/test pull-cluster-api-provider-vsphere-verify-gen

[xiujuanx]

/test pull-cluster-api-provider-vsphere-verify-gen

[zhanggbj]

@xiujuanx there's a known issue for verify-gen, if this is the same case, you can ignore it #1928

[xiujuanx]

Thanks @zhanggbj ! I run make generate locally doesn't generate any difference.

[sbueringer]

/retest-required

[chrischdi]

/test pull-cluster-api-provider-vsphere-verify-gen

[sbueringer]

Thanks @zhanggbj ! I run make generate locally doesn't generate any difference.

I think the issue should be fixed now, can you rebase?

[xiujuanx]

Thanks @sbueringer for your kind reminder! I have rebased the code, so pls help review again, thanks!

[xiujuanx]

/test pull-cluster-api-provider-vsphere-e2e

[chrischdi]

/test pull-cluster-api-provider-vsphere-e2e

[srm09]

/lgtm
/retest

[randomvariable]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: randomvariable

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 [randomvariable]

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

[sbueringer]

Let's cherry-pick this one as well

/cherry-pick release-1.7

[sbueringer]

/cherry-pick release-1.6

[sbueringer]

/cherry-pick release-1.5

[k8s-infra-cherrypick-robot]

@sbueringer: new pull request created: #2027

In response to this:

Let's cherry-pick this one as well

/cherry-pick release-1.7

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-infra-cherrypick-robot]

@sbueringer: #1949 failed to apply on top of branch "release-1.6":

Applying: don't call session logout for keephandler
Using index info to reconstruct a base tree...
M	pkg/session/session.go
Falling back to patching base and 3-way merge...
Auto-merging pkg/session/session.go
CONFLICT (content): Merge conflict in pkg/session/session.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 don't call session logout for keephandler
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.6

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-infra-cherrypick-robot]

@sbueringer: #1949 failed to apply on top of branch "release-1.5":

Applying: don't call session logout for keephandler
Using index info to reconstruct a base tree...
M	pkg/session/session.go
Falling back to patching base and 3-way merge...
Auto-merging pkg/session/session.go
CONFLICT (content): Merge conflict in pkg/session/session.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 don't call session logout for keephandler
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.5

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.