Skip to content

Commit

Permalink
Remove deleted NEG reference during NEG GC.
Browse files Browse the repository at this point in the history 
* Once a NEG has been deleted, remove its referece from NEG CR. This
  prevents NEG CR retaining reference of non-existing NEGs.
  • Loading branch information
@sawsa307
sawsa307 committed Jul 24, 2024
1 parent 5adc2df commit 8449144
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 20 deletions.
52 changes: 49 additions & 3 deletions pkg/neg/manager.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,9 @@ func (manager *syncerManager) processNEGDeletionCandidate(svcNegCR *negv1beta1.S
var errList []error
shouldDeleteNegCR := true
deleteByZone := len(svcNegCR.Status.NetworkEndpointGroups) == 0
// Change this to a map from NEG name to sets once we allow multiple NEGs
// in a specific zone(multi-subnet cluster).
deletedNegZones := sets.New[string]()

for _, negRef := range svcNegCR.Status.NetworkEndpointGroups {
resourceID, err := cloud.ParseResourceURL(negRef.SelfLink)
Expand All @@ -623,14 +626,34 @@ func (manager *syncerManager) processNEGDeletionCandidate(svcNegCR *negv1beta1.S
deleteByZone = true
continue
}

shouldDeleteNegCR = shouldDeleteNegCR && manager.deleteNegOrReportErr(resourceID.Key.Name, resourceID.Key.Zone, svcNegCR, &errList)
negDeleted := manager.deleteNegOrReportErr(resourceID.Key.Name, resourceID.Key.Zone, svcNegCR, &errList)
if negDeleted {
deletedNegZones.Insert(resourceID.Key.Zone)
}
shouldDeleteNegCR = shouldDeleteNegCR && negDeleted
}

if deleteByZone {
manager.logger.V(2).Info("Deletion candidate has 0 NEG reference", "svcneg", klog.KObj(svcNegCR), "svcNegCR", svcNegCR)
for _, zone := range zones {
shouldDeleteNegCR = shouldDeleteNegCR && manager.deleteNegOrReportErr(svcNegCR.Name, zone, svcNegCR, &errList)
negDeleted := manager.deleteNegOrReportErr(svcNegCR.Name, zone, svcNegCR, &errList)
if negDeleted {
deletedNegZones.Insert(zone)
}
shouldDeleteNegCR = shouldDeleteNegCR && negDeleted
}
}
// Since no more NEG deletion will be happening at this point, and NEG
// CR will not be deleted, clear the reference for deleted NEGs in the
// NEG CR.
if deletedNegZones.Len() != 0 {
updatedCR := svcNegCR.DeepCopy()

if errs := ensureExistingNegRef(updatedCR, deletedNegZones); len(errs) != 0 {
errList = append(errList, errs...)
}
if _, err := patchNegStatus(manager.svcNegClient, *svcNegCR, *updatedCR); err != nil {
errList = append(errList, err)
}
}

Expand All @@ -655,7 +678,10 @@ func (manager *syncerManager) processNEGDeletionCandidate(svcNegCR *negv1beta1.S

manager.logger.V(2).Info("Deleting NEG CR", "svcneg", klog.KObj(svcNegCR))
if err := deleteSvcNegCR(manager.svcNegClient, svcNegCR, manager.logger); err != nil {
fmt.Printf("remove me: deleteSvcNegCR error: %v\n", err)
errList = append(errList, err)
} else {
fmt.Printf("remove me: deleteSvcNegCR no error\n")
}
}()

Expand Down Expand Up @@ -684,6 +710,25 @@ func (manager *syncerManager) deleteNegOrReportErr(name, zone string, svcNegCR *
return true
}

// ensureExistingNegRef remove NEG refs in NEG CR for NEGs that has been
// deleted successfully.
func ensureExistingNegRef(neg *negv1beta1.ServiceNetworkEndpointGroup, deletedNegZones sets.Set[string]) []error {
var updatedNegRef []negv1beta1.NegObjectReference
var errList []error
for _, negRef := range neg.Status.NetworkEndpointGroups {
resourceID, err := cloud.ParseResourceURL(negRef.SelfLink)
if err != nil {
errList = append(errList, fmt.Errorf("failed to parse selflink for NEG %s: %v", negRef.SelfLink, err))
continue
}
if !deletedNegZones.Has(resourceID.Key.Zone) {
updatedNegRef = append(updatedNegRef, negRef)
}
}
neg.Status.NetworkEndpointGroups = updatedNegRef
return errList
}

// ensureDeleteNetworkEndpointGroup ensures neg is delete from zone
func (manager *syncerManager) ensureDeleteNetworkEndpointGroup(name, zone string, expectedDesc *utils.NegDescription) error {
neg, err := manager.cloud.GetNetworkEndpointGroup(name, zone, meta.VersionGA, manager.logger)
Expand Down Expand Up @@ -822,6 +867,7 @@ func deleteSvcNegCR(svcNegClient svcnegclient.Interface, negCR *negv1beta1.Servi

logger.V(2).Info("Removed finalizer on ServiceNetworkEndpointGroup CR", "svcneg", klog.KRef(negCR.Namespace, negCR.Name))

fmt.Printf("remove me: deletion timestamp=%v\n", negCR.GetDeletionTimestamp().IsZero())
// If CR does not have a deletion timestamp, delete
if negCR.GetDeletionTimestamp().IsZero() {
logger.V(2).Info("Deleting ServiceNetworkEndpointGroup CR", "svcneg", klog.KRef(negCR.Namespace, negCR.Name))
Expand Down
76 changes: 59 additions & 17 deletions pkg/neg/manager_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,21 @@ import (
apiv1 "k8s.io/api/core/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
apitypes "k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/fake"
k8stesting "k8s.io/client-go/testing"
"k8s.io/client-go/tools/record"
negv1beta1 "k8s.io/ingress-gce/pkg/apis/svcneg/v1beta1"
"k8s.io/ingress-gce/pkg/neg/metrics/metricscollector"
"k8s.io/ingress-gce/pkg/neg/syncers/labels"
"k8s.io/ingress-gce/pkg/neg/types"
negtypes "k8s.io/ingress-gce/pkg/neg/types"
svcnegclient "k8s.io/ingress-gce/pkg/svcneg/client/clientset/versioned"
negfake "k8s.io/ingress-gce/pkg/svcneg/client/clientset/versioned/fake"
"k8s.io/ingress-gce/pkg/utils/common"
namer_util "k8s.io/ingress-gce/pkg/utils/namer"
"k8s.io/ingress-gce/pkg/utils/zonegetter"
Expand Down Expand Up @@ -1189,7 +1192,10 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
expectNegGC bool
expectCrGC bool
expectErr bool
gcError error
negGCError error
negGCErrorZone []string
negCrGCError error
expectedNegCount int

// expectGenNamedNegGC indicates that the Neg GC only occurs if using a generated name
// expectNegGC will take precedence over this value
Expand Down Expand Up @@ -1250,6 +1256,7 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
expectNegGC: false,
expectCrGC: true,
negDesc: wrongDesc.String(),
expectedNegCount: 2,
},
{desc: "neg config not in svcPortMap, empty neg list, neg has empty description",
negsExist: true,
Expand All @@ -1258,20 +1265,23 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
expectGenNamedNegGC: true,
expectCrGC: true,
negDesc: "",
expectedNegCount: 2,
},
{desc: "neg config in svcPortMap, marked for deletion",
negsExist: true,
markedForDeletion: true,
desiredConfig: true,
expectNegGC: false,
expectCrGC: false,
expectedNegCount: 2,
},
{desc: "neg config in svcPortMap",
negsExist: true,
markedForDeletion: false,
desiredConfig: true,
expectNegGC: false,
expectCrGC: false,
expectedNegCount: 2,
},
{desc: "negs don't exist, config not in svcPortMap",
negsExist: false,
Expand All @@ -1288,16 +1298,38 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
markedForDeletion: true,
expectCrGC: true,
expectErr: false,
gcError: &googleapi.Error{Code: http.StatusBadRequest},
negGCError: &googleapi.Error{Code: http.StatusBadRequest},
negGCErrorZone: []string{negtypes.TestZone1, negtypes.TestZone2},
negDesc: matchingDesc.String(),
},
{desc: "error during neg gc, config not in svcPortMap",
{desc: "error on all NEG deletions during neg gc, config not in svcPortMap, NEG CR should still have all NEG ref",
negsExist: true,
markedForDeletion: true,
expectCrGC: true,
expectErr: true,
gcError: fmt.Errorf("gc-error"),
negGCError: fmt.Errorf("neg-gc-error"),
negGCErrorZone: []string{negtypes.TestZone1, negtypes.TestZone2},
negDesc: matchingDesc.String(),
expectedNegCount: 2,
},
{desc: "error on one NEG deletion during neg gc, config not in svcPortMap, NEG CR should not have the deleted NEG ref",
negsExist: true,
markedForDeletion: true,
expectCrGC: true,
expectErr: true,
negGCError: fmt.Errorf("neg-gc-error"),
negGCErrorZone: []string{negtypes.TestZone1},
negDesc: matchingDesc.String(),
expectedNegCount: 1,
},
{desc: "error when deleting NEG CR during neg gc, config not in svcPortMap, NEG CR should not have any stale NEG ref",
negsExist: true,
markedForDeletion: false, // Make sure deletion timestamp is not set so we will trigger error when delete NEG CR
expectErr: true,
expectCrGC: false, // NEG CR deletion should fail due to error from deletion API call
negCrGCError: fmt.Errorf("neg-cr-gc-error"),
negDesc: matchingDesc.String(),
expectedNegCount: 0,
},
}

Expand All @@ -1310,6 +1342,13 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
manager, testCloud := NewTestSyncerManager(kubeClient)
svcNegClient := manager.svcNegClient

if tc.negCrGCError != nil {
svcNegClientFake := svcNegClient.(*negfake.Clientset)
svcNegClientFake.PrependReactor("delete", "servicenetworkendpointgroups", func(action k8stesting.Action) (handled bool, ret runtime.Object, err error) {
return true, &negv1beta1.ServiceNetworkEndpointGroup{}, tc.negCrGCError
})
}

manager.serviceLister.Add(svc)
fakeNegCloud := manager.cloud

Expand Down Expand Up @@ -1349,7 +1388,7 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
}

if _, err := manager.svcNegClient.NetworkingV1beta1().ServiceNetworkEndpointGroups(cr.Namespace).Create(context2.TODO(), &cr, metav1.CreateOptions{}); err != nil {
t.Fatalf("failed to create neg cr")
t.Fatalf("failed to create neg cr: %v", err)
}

crs := getNegCRs(t, svcNegClient, testServiceNamespace)
Expand All @@ -1370,19 +1409,20 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
}
}

if tc.gcError != nil {
if tc.negGCError != nil {
mockCloud := testCloud.Compute().(*cloud.MockGCE)
mockNEG := mockCloud.NetworkEndpointGroups().(*cloud.MockNetworkEndpointGroups)

for _, zone := range []string{negtypes.TestZone1, negtypes.TestZone2} {
mockNEG.DeleteError[*meta.ZonalKey(negName, zone)] = tc.gcError
for _, zone := range tc.negGCErrorZone {
mockNEG.DeleteError[*meta.ZonalKey(negName, zone)] = tc.negGCError
}
}

err := manager.GC()
if !tc.expectErr && err != nil {
t.Fatalf("failed to GC: %v", err)
} else if tc.expectErr && err == nil {
}
if tc.expectErr && err == nil {
t.Errorf("expected GC to error")
}

Expand All @@ -1391,21 +1431,23 @@ func TestGarbageCollectionNegCrdEnabled(t *testing.T) {
t.Errorf("failed getting negs from cloud: %s", err)
}

numExistingNegs, negsDeleted := checkForNegDeletions(negs, negName)
numExistingNegs := checkForNegDeletions(negs, negName)

expectNegGC := tc.expectNegGC || (tc.expectGenNamedNegGC && !customName)
if tc.negsExist && expectNegGC && !negsDeleted {
if tc.negsExist && expectNegGC && numExistingNegs != 0 {
t.Errorf("expected negs to be GCed, but found %d", numExistingNegs)
} else if tc.negsExist && !expectNegGC && numExistingNegs != 2 {
t.Errorf("expected two negs in the cloud, but found %d", numExistingNegs)
}
if tc.negsExist && !expectNegGC && numExistingNegs != tc.expectedNegCount {
t.Errorf("expected %d negs in the cloud, but found %d", tc.expectedNegCount, numExistingNegs)
}

crs = getNegCRs(t, svcNegClient, testServiceNamespace)
crDeleted := checkForNegCRDeletion(crs, negName)

if tc.expectCrGC && !crDeleted {
t.Errorf("expected neg %s to be deleted", negName)
} else if !tc.expectCrGC && crDeleted && !tc.markedForDeletion {
}
if !tc.expectCrGC && crDeleted && !tc.markedForDeletion {
t.Errorf("expected neg %s to not be deleted", negName)
}
}
Expand Down Expand Up @@ -1554,16 +1596,16 @@ func getNegObjectRefs(t *testing.T, cloud negtypes.NetworkEndpointGroupCloud, zo
return negRefs
}

// checkForNegDeletions checks that negs does not have a neg with the provided negName. If none exists, returns true, otherwise returns false the number of negs found with the name
func checkForNegDeletions(negs map[*meta.Key]*composite.NetworkEndpointGroup, negName string) (int, bool) {
// checkForNegDeletions gets the count of neg objects in negs that has the provided negName.
func checkForNegDeletions(negs map[*meta.Key]*composite.NetworkEndpointGroup, negName string) int {
foundNegs := 0
for _, neg := range negs {
if neg.Name == negName {
foundNegs += 1
}
}

return foundNegs, foundNegs == 0
return foundNegs
}

// checkForNegCRDeletion verifies that either no cr with name `negName` exists or a cr withe name `negName` has its deletion timestamp set
Expand Down

0 comments on commit 8449144

Please sign in to comment.