-
Notifications
You must be signed in to change notification settings - Fork 268
Add deletionTimestamp check to avoid race condition #982
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
Open
wpross
wants to merge
2
commits into
kubernetes:master
Choose a base branch
from
wpross:fix-981
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+146
−5
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| package service | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| v1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| servicehelper "k8s.io/cloud-provider/service/helpers" | ||
| ) | ||
|
|
||
| // TestNeedsCleanup verifies that services with deletionTimestamp set are | ||
| // correctly identified as needing cleanup, regardless of finalizer state. | ||
| // This prevents a race condition where node updates trigger reconciliation | ||
| // after the finalizer is removed but before the service is deleted from etcd. | ||
| func TestNeedsCleanup(t *testing.T) { | ||
| now := metav1.Now() | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| service *v1.Service | ||
| expected bool | ||
| }{ | ||
| { | ||
| name: "service with deletionTimestamp and finalizer should need cleanup", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| DeletionTimestamp: &now, | ||
| Finalizers: []string{servicehelper.LoadBalancerCleanupFinalizer}, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeLoadBalancer, | ||
| }, | ||
| }, | ||
| expected: true, | ||
| }, | ||
| { | ||
| name: "service with deletionTimestamp but no finalizer should need cleanup", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| DeletionTimestamp: &now, | ||
| Finalizers: []string{}, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeLoadBalancer, | ||
| }, | ||
| }, | ||
| expected: true, | ||
| }, | ||
| { | ||
| name: "service without deletionTimestamp and without finalizer should not need cleanup", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Finalizers: []string{}, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeLoadBalancer, | ||
| }, | ||
| }, | ||
| expected: false, | ||
| }, | ||
| { | ||
| name: "service without deletionTimestamp but with finalizer should not need cleanup", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Finalizers: []string{servicehelper.LoadBalancerCleanupFinalizer}, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeLoadBalancer, | ||
| }, | ||
| }, | ||
| expected: false, | ||
| }, | ||
| { | ||
| name: "non-LoadBalancer service with finalizer should need cleanup", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Finalizers: []string{servicehelper.LoadBalancerCleanupFinalizer}, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeClusterIP, | ||
| }, | ||
| }, | ||
| expected: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| result := needsCleanup(tc.service) | ||
| if result != tc.expected { | ||
| t.Errorf("needsCleanup() = %v, expected %v", result, tc.expected) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // TestNodeSyncService_DeletionTimestamp verifies that nodeSyncService returns | ||
| // success (false) without attempting to sync when a service has deletionTimestamp set. | ||
| func TestNodeSyncService_DeletionTimestamp(t *testing.T) { | ||
| now := metav1.Now() | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| service *v1.Service | ||
| }{ | ||
| { | ||
| name: "nil service should return success", | ||
| service: nil, | ||
| }, | ||
| { | ||
| name: "service with deletionTimestamp should return success without syncing", | ||
| service: &v1.Service{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| DeletionTimestamp: &now, | ||
| }, | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeLoadBalancer, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "non-LoadBalancer service should return success", | ||
| service: &v1.Service{ | ||
| Spec: v1.ServiceSpec{ | ||
| Type: v1.ServiceTypeClusterIP, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| c := &Controller{} | ||
|
|
||
| result := c.nodeSyncService(tc.service) | ||
| if result != false { | ||
| t.Errorf("nodeSyncService() returned needRetry=true, expected success (false)") | ||
| } | ||
| }) | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is forked from here https://github.com/kubernetes/cloud-provider/blob/master/controllers/service/controller.go#L364
And it was on purpose. The service deletion is delayed and waits for all finalizers to be removed before actually deleting the object.
What are the side effect, e.g. resource leakage did you see other than the error messages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pointing it out @YifeiZhuang
so yes, this code was forked and is used only if the service has a specific LB class set. For usual services (no loadBalancerClass) which I believe the fix is intended for, you need to change the code in https://github.com/kubernetes/cloud-provider/ and vendor it in here