Skip to content

feat: add graceful stop annotation #486

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.

Sign up for GitHub

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
Bowser1704 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add graceful stop annotation #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/controller/helper/event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ const (
DeleteTimestampChanged = "DeleteTimestampChanged"
PreservedOnDelete = "PreservedOnDelete"
FeatureNotSupported = "FeatureNotSupported"
GracefulShutdownDisabled = "GracefulShutdownDisabled"
)

// NodeEventReason
Expand Down
25 changes: 18 additions & 7 deletions pkg/controller/service/clbv1/vgroups.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,6 +705,8 @@ func (mgr *VGroupManager) setBackendsFromEndpointSlices(reqCtx *svcCtx.RequestCo
return nil, false, nil
}

gracefulShutdownEnabled := backend.IsGracefulShutdownEnabled(reqCtx, candidates.TrafficPolicy)

for _, es := range candidates.EndpointSlices {
var backendPort int
if vgroup.ServicePort.TargetPort.Type == intstr.Int {
Expand All @@ -726,17 +728,19 @@ func (mgr *VGroupManager) setBackendsFromEndpointSlices(reqCtx *svcCtx.RequestCo
}

for _, ep := range es.Endpoints {
// ignore terminating pods
if ep.Conditions.Terminating != nil && *ep.Conditions.Terminating {
continue
isTerminating := ep.Conditions.Terminating != nil && *ep.Conditions.Terminating
if isTerminating {
if !gracefulShutdownEnabled || ep.Conditions.Serving == nil || !*ep.Conditions.Serving {
continue
}
}

for _, addr := range ep.Addresses {
if _, ok := endpointMap[addr]; ok {
continue
}

if ep.Conditions.Ready != nil && *ep.Conditions.Ready {
if isTerminating || (ep.Conditions.Ready != nil && *ep.Conditions.Ready) {
endpointMap[addr] = true
backends = append(backends, model.BackendAttribute{
NodeName: ep.NodeName,
Expand All @@ -746,6 +750,7 @@ func (mgr *VGroupManager) setBackendsFromEndpointSlices(reqCtx *svcCtx.RequestCo
Port: backendPort,
Description: vgroup.VGroupName,
TargetRef: ep.TargetRef,
Terminating: isTerminating,
})
continue
}
Expand Down Expand Up @@ -962,11 +967,17 @@ func setWeightBackends(mode helper.TrafficPolicy, backends []model.BackendAttrib
// use default
if weight == nil {
defaultWeight := pointer.IntDeref(defaultWeight, DefaultServerWeight)
return podNumberAlgorithm(mode, backends, defaultWeight)
backends = podNumberAlgorithm(mode, backends, defaultWeight)
} else {
backends = podPercentAlgorithm(mode, backends, *weight)
}

return podPercentAlgorithm(mode, backends, *weight)

for i := range backends {
if backends[i].Terminating {
backends[i].Weight = 0
}
}
return backends
}

// weight algorithm
Expand Down
304 changes: 304 additions & 0 deletions pkg/controller/service/clbv1/vgroups_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,310 @@ func TestSetBackendsFromEndpointSlices(t *testing.T) {
assert.Equal(t, 0, len(backends))
})

t.Run("graceful-shutdown: terminating+serving kept in ENI mode", func(t *testing.T) {
terminating := true
serving := true
nodeName := "node-1"
portName := "http"
port := int32(8080)
protocol := v1.ProtocolTCP
svcWithAnno := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
Annotations: map[string]string{
annotation.Annotation(annotation.GracefulShutdown): "true",
},
},
}
reqCtxWithAnno := &svcCtx.RequestContext{
Ctx: context.TODO(),
Service: svcWithAnno,
Anno: annotation.NewAnnotationRequest(svcWithAnno),
Log: klogr.New(),
}
candidates := &backend.EndpointWithENI{
TrafficPolicy: helper.ENITrafficPolicy,
EndpointSlices: []discovery.EndpointSlice{
{
ObjectMeta: metav1.ObjectMeta{
Name: "test-slice",
Namespace: "default",
},
Endpoints: []discovery.Endpoint{
{
Addresses: []string{"10.0.0.10"},
Conditions: discovery.EndpointConditions{
Terminating: &terminating,
Serving: &serving,
},
NodeName: &nodeName,
},
},
Ports: []discovery.EndpointPort{
{
Name: &portName,
Port: &port,
Protocol: &protocol,
},
},
},
},
}
vgroup := model.VServerGroup{
VGroupName: "test-vgroup",
ServicePort: v1.ServicePort{
Port: 80,
TargetPort: intstr.FromInt(8080),
Name: "http",
},
}
backends, containsPotential, err := mgr.setBackendsFromEndpointSlices(reqCtxWithAnno, candidates, vgroup)
assert.NoError(t, err)
assert.False(t, containsPotential)
assert.Equal(t, 1, len(backends))
assert.Equal(t, "10.0.0.10", backends[0].ServerIp)
assert.True(t, backends[0].Terminating)
})

t.Run("graceful-shutdown: ignored when ignore-weight-update is on", func(t *testing.T) {
terminating := true
serving := true
nodeName := "node-1"
portName := "http"
port := int32(8080)
protocol := v1.ProtocolTCP
svcWithAnno := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
Annotations: map[string]string{
annotation.Annotation(annotation.GracefulShutdown): "true",
annotation.Annotation(annotation.IgnoreWeightUpdate): string(model.OnFlag),
},
},
}
reqCtxWithAnno := &svcCtx.RequestContext{
Ctx: context.TODO(),
Service: svcWithAnno,
Anno: annotation.NewAnnotationRequest(svcWithAnno),
Log: klogr.New(),
}
candidates := &backend.EndpointWithENI{
TrafficPolicy: helper.ENITrafficPolicy,
EndpointSlices: []discovery.EndpointSlice{
{
ObjectMeta: metav1.ObjectMeta{
Name: "test-slice",
Namespace: "default",
},
Endpoints: []discovery.Endpoint{
{
Addresses: []string{"10.0.0.14"},
Conditions: discovery.EndpointConditions{
Terminating: &terminating,
Serving: &serving,
},
NodeName: &nodeName,
},
},
Ports: []discovery.EndpointPort{
{
Name: &portName,
Port: &port,
Protocol: &protocol,
},
},
},
},
}
vgroup := model.VServerGroup{
VGroupName: "test-vgroup",
ServicePort: v1.ServicePort{
Port: 80,
TargetPort: intstr.FromInt(8080),
Name: "http",
},
}
backends, _, err := mgr.setBackendsFromEndpointSlices(reqCtxWithAnno, candidates, vgroup)
assert.NoError(t, err)
assert.Equal(t, 0, len(backends))
})

t.Run("graceful-shutdown: terminating+not-serving removed", func(t *testing.T) {
terminating := true
serving := false
nodeName := "node-1"
portName := "http"
port := int32(8080)
protocol := v1.ProtocolTCP
svcWithAnno := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
Annotations: map[string]string{
annotation.Annotation(annotation.GracefulShutdown): "true",
},
},
}
reqCtxWithAnno := &svcCtx.RequestContext{
Ctx: context.TODO(),
Service: svcWithAnno,
Anno: annotation.NewAnnotationRequest(svcWithAnno),
Log: klogr.New(),
}
candidates := &backend.EndpointWithENI{
TrafficPolicy: helper.ENITrafficPolicy,
EndpointSlices: []discovery.EndpointSlice{
{
ObjectMeta: metav1.ObjectMeta{
Name: "test-slice",
Namespace: "default",
},
Endpoints: []discovery.Endpoint{
{
Addresses: []string{"10.0.0.11"},
Conditions: discovery.EndpointConditions{
Terminating: &terminating,
Serving: &serving,
},
NodeName: &nodeName,
},
},
Ports: []discovery.EndpointPort{
{
Name: &portName,
Port: &port,
Protocol: &protocol,
},
},
},
},
}
vgroup := model.VServerGroup{
VGroupName: "test-vgroup",
ServicePort: v1.ServicePort{
Port: 80,
TargetPort: intstr.FromInt(8080),
Name: "http",
},
}
backends, _, err := mgr.setBackendsFromEndpointSlices(reqCtxWithAnno, candidates, vgroup)
assert.NoError(t, err)
assert.Equal(t, 0, len(backends))
})

t.Run("graceful-shutdown: terminating ignored without annotation", func(t *testing.T) {
terminating := true
serving := true
nodeName := "node-1"
portName := "http"
port := int32(8080)
protocol := v1.ProtocolTCP
candidates := &backend.EndpointWithENI{
TrafficPolicy: helper.ENITrafficPolicy,
EndpointSlices: []discovery.EndpointSlice{
{
ObjectMeta: metav1.ObjectMeta{
Name: "test-slice",
Namespace: "default",
},
Endpoints: []discovery.Endpoint{
{
Addresses: []string{"10.0.0.12"},
Conditions: discovery.EndpointConditions{
Terminating: &terminating,
Serving: &serving,
},
NodeName: &nodeName,
},
},
Ports: []discovery.EndpointPort{
{
Name: &portName,
Port: &port,
Protocol: &protocol,
},
},
},
},
}
vgroup := model.VServerGroup{
VGroupName: "test-vgroup",
ServicePort: v1.ServicePort{
Port: 80,
TargetPort: intstr.FromInt(8080),
Name: "http",
},
}
backends, _, err := mgr.setBackendsFromEndpointSlices(reqCtx, candidates, vgroup)
assert.NoError(t, err)
assert.Equal(t, 0, len(backends))
})

t.Run("graceful-shutdown: terminating ignored in non-ENI mode", func(t *testing.T) {
terminating := true
serving := true
nodeName := "node-1"
portName := "http"
port := int32(8080)
protocol := v1.ProtocolTCP
svcWithAnno := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
Annotations: map[string]string{
annotation.Annotation(annotation.GracefulShutdown): "true",
},
},
}
reqCtxWithAnno := &svcCtx.RequestContext{
Ctx: context.TODO(),
Service: svcWithAnno,
Anno: annotation.NewAnnotationRequest(svcWithAnno),
Log: klogr.New(),
}
candidates := &backend.EndpointWithENI{
TrafficPolicy: helper.LocalTrafficPolicy,
EndpointSlices: []discovery.EndpointSlice{
{
ObjectMeta: metav1.ObjectMeta{
Name: "test-slice",
Namespace: "default",
},
Endpoints: []discovery.Endpoint{
{
Addresses: []string{"10.0.0.13"},
Conditions: discovery.EndpointConditions{
Terminating: &terminating,
Serving: &serving,
},
NodeName: &nodeName,
},
},
Ports: []discovery.EndpointPort{
{
Name: &portName,
Port: &port,
Protocol: &protocol,
},
},
},
},
}
vgroup := model.VServerGroup{
VGroupName: "test-vgroup",
ServicePort: v1.ServicePort{
Port: 80,
TargetPort: intstr.FromInt(8080),
Name: "http",
},
}
backends, _, err := mgr.setBackendsFromEndpointSlices(reqCtxWithAnno, candidates, vgroup)
assert.NoError(t, err)
assert.Equal(t, 0, len(backends))
})

t.Run("duplicate endpoint addresses", func(t *testing.T) {
ready := true
nodeName := "node-1"
Expand Down
Loading