1
0
mirror of https://github.com/kubernetes-sigs/descheduler.git synced 2026-01-28 06:29:29 +01:00

Merge pull request #1753 from tiraboschi/annotate_eviction_requests

feat(eviction): add annotations to eviction requests for observability
This commit is contained in:
Kubernetes Prow Robot
2025-10-13 04:26:57 -07:00
committed by GitHub
2 changed files with 19 additions and 4 deletions

View File

@@ -42,6 +42,12 @@ import (
"sigs.k8s.io/descheduler/pkg/tracing" "sigs.k8s.io/descheduler/pkg/tracing"
) )
const (
deschedulerGlobalName = "sigs.k8s.io/descheduler"
reasonAnnotationKey = "reason"
requestedByAnnotationKey = "requested-by"
)
var ( var (
assumedEvictionRequestTimeoutSeconds uint = 10 * 60 // 10 minutes assumedEvictionRequestTimeoutSeconds uint = 10 * 60 // 10 minutes
evictionRequestsCacheResyncPeriod time.Duration = 10 * time.Minute evictionRequestsCacheResyncPeriod time.Duration = 10 * time.Minute
@@ -522,7 +528,7 @@ func (pe *PodEvictor) EvictPod(ctx context.Context, pod *v1.Pod, opts EvictOptio
return err return err
} }
ignore, err := pe.evictPod(ctx, pod) ignore, err := pe.evictPod(ctx, pod, opts)
if err != nil { if err != nil {
// err is used only for logging purposes // err is used only for logging purposes
span.AddEvent("Eviction Failed", trace.WithAttributes(attribute.String("node", pod.Spec.NodeName), attribute.String("err", err.Error()))) span.AddEvent("Eviction Failed", trace.WithAttributes(attribute.String("node", pod.Spec.NodeName), attribute.String("err", err.Error())))
@@ -569,7 +575,7 @@ func (pe *PodEvictor) EvictPod(ctx context.Context, pod *v1.Pod, opts EvictOptio
} }
// return (ignore, err) // return (ignore, err)
func (pe *PodEvictor) evictPod(ctx context.Context, pod *v1.Pod) (bool, error) { func (pe *PodEvictor) evictPod(ctx context.Context, pod *v1.Pod, opts EvictOptions) (bool, error) {
deleteOptions := &metav1.DeleteOptions{ deleteOptions := &metav1.DeleteOptions{
GracePeriodSeconds: pe.gracePeriodSeconds, GracePeriodSeconds: pe.gracePeriodSeconds,
} }
@@ -582,6 +588,10 @@ func (pe *PodEvictor) evictPod(ctx context.Context, pod *v1.Pod) (bool, error) {
ObjectMeta: metav1.ObjectMeta{ ObjectMeta: metav1.ObjectMeta{
Name: pod.Name, Name: pod.Name,
Namespace: pod.Namespace, Namespace: pod.Namespace,
Annotations: map[string]string{
"reason": fmt.Sprintf("triggered by %v/%v: %v", opts.ProfileName, opts.StrategyName, opts.Reason),
"requested-by": deschedulerGlobalName,
},
}, },
DeleteOptions: deleteOptions, DeleteOptions: deleteOptions,
} }

View File

@@ -20,6 +20,7 @@ import (
"context" "context"
"fmt" "fmt"
"reflect" "reflect"
"strings"
"testing" "testing"
"time" "time"
@@ -114,7 +115,7 @@ func TestEvictPod(t *testing.T) {
t.Fatalf("Unexpected error when creating a pod evictor: %v", err) t.Fatalf("Unexpected error when creating a pod evictor: %v", err)
} }
_, got := podEvictor.evictPod(ctx, test.evictedPod) _, got := podEvictor.evictPod(ctx, test.evictedPod, EvictOptions{})
if got != test.wantErr { if got != test.wantErr {
t.Errorf("Test error for Desc: %s. Expected %v pod eviction to be %v, got %v", test.description, test.evictedPod.Name, test.wantErr, got) t.Errorf("Test error for Desc: %s. Expected %v pod eviction to be %v, got %v", test.description, test.evictedPod.Name, test.wantErr, got)
} }
@@ -418,7 +419,11 @@ func TestEvictionRequestsCacheCleanup(t *testing.T) {
} }
if eviction, matched := createAct.Object.(*policy.Eviction); matched { if eviction, matched := createAct.Object.(*policy.Eviction); matched {
podName := eviction.GetName() podName := eviction.GetName()
if podName == "p1" || podName == "p2" { annotations := eviction.GetAnnotations()
if (podName == "p1" || podName == "p2") && annotations[requestedByAnnotationKey] == deschedulerGlobalName && strings.HasPrefix(
annotations[reasonAnnotationKey],
"triggered by",
) {
return true, nil, &apierrors.StatusError{ return true, nil, &apierrors.StatusError{
ErrStatus: metav1.Status{ ErrStatus: metav1.Status{
Reason: metav1.StatusReasonTooManyRequests, Reason: metav1.StatusReasonTooManyRequests,