Merge pull request kubernetes-sigs#393 from lixiang233/Ft_custom_pod_…

…phase_PodLifeTime PodLifeTime: allow custom podStatusPhases
briend · Sep 11, 2020 · bf5b5a9 · bf5b5a9
2 parents ec8dce1 + 91b1e52
commit bf5b5a9
Show file tree

Hide file tree

Showing 10 changed files with 195 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -263,18 +263,36 @@ strategies:
 
 ### PodLifeTime
 
-This strategy evicts pods that are older than `.strategies.PodLifeTime.params.maxPodLifeTimeSeconds` The policy
-file should look like:
+This strategy evicts pods that are older than `maxPodLifeTimeSeconds`. The policy file should look like:
 
-````
+```
 apiVersion: "descheduler/v1alpha1"
 kind: "DeschedulerPolicy"
 strategies:
   "PodLifeTime":
      enabled: true
      params:
-        maxPodLifeTimeSeconds: 86400
-````
+       podLifeTime:
+         maxPodLifeTimeSeconds: 86400
+```
+
+You can specify `podStatusPhases` to `only` evict pods with specific `StatusPhases`, currently this parameter is limited
+to `Running` and `Pending`. E.g.
+
+```
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+  "PodLifeTime":
+     enabled: true
+     params:
+       podLifeTime:
+         maxPodLifeTimeSeconds: 86400
+         podStatusPhases:
+         - "Pending"
+```
+
+Only `Pending` pods will get evicted in this example.
 
 ## Filter Pods
 
@@ -292,7 +310,8 @@ strategies:
   "PodLifeTime":
      enabled: true
      params:
-        maxPodLifeTimeSeconds: 86400
+        podLifeTime:
+          maxPodLifeTimeSeconds: 86400
         namespaces:
           include:
           - "namespace1"
@@ -309,7 +328,8 @@ strategies:
   "PodLifeTime":
      enabled: true
      params:
-        maxPodLifeTimeSeconds: 86400
+        podLifeTime:
+          maxPodLifeTimeSeconds: 86400
         namespaces:
           exclude:
           - "namespace1"
@@ -336,7 +356,8 @@ strategies:
   "PodLifeTime":
      enabled: true
      params:
-        maxPodLifeTimeSeconds: 86400
+        podLifeTime:
+          maxPodLifeTimeSeconds: 86400
         thresholdPriority: 10000
 ```
 
@@ -348,7 +369,8 @@ strategies:
   "PodLifeTime":
      enabled: true
      params:
-        maxPodLifeTimeSeconds: 86400
+        podLifeTime:
+          maxPodLifeTimeSeconds: 86400
         thresholdPriorityClassName: "priorityclass1"
 ```
 

diff --git a/examples/pod-life-time.yml b/examples/pod-life-time.yml
@@ -17,4 +17,5 @@ strategies:
   "PodLifeTime":
     enabled: true
     params:
-      maxPodLifeTimeSeconds: 604800 # 7 days
+      podLifeTime:
+        maxPodLifeTimeSeconds: 604800 # 7 days
diff --git a/pkg/api/types.go b/pkg/api/types.go
@@ -67,7 +67,7 @@ type StrategyParameters struct {
 	NodeResourceUtilizationThresholds *NodeResourceUtilizationThresholds
 	NodeAffinityType                  []string
 	PodsHavingTooManyRestarts         *PodsHavingTooManyRestarts
-	MaxPodLifeTimeSeconds             *uint
+	PodLifeTime                       *PodLifeTime
 	RemoveDuplicates                  *RemoveDuplicates
 	Namespaces                        *Namespaces
 	ThresholdPriority                 *int32
@@ -91,3 +91,8 @@ type PodsHavingTooManyRestarts struct {
 type RemoveDuplicates struct {
 	ExcludeOwnerKinds []string
 }
+
+type PodLifeTime struct {
+	MaxPodLifeTimeSeconds *uint
+	PodStatusPhases       []string
+}
diff --git a/pkg/api/v1alpha1/types.go b/pkg/api/v1alpha1/types.go
@@ -65,7 +65,7 @@ type StrategyParameters struct {
 	NodeResourceUtilizationThresholds *NodeResourceUtilizationThresholds `json:"nodeResourceUtilizationThresholds,omitempty"`
 	NodeAffinityType                  []string                           `json:"nodeAffinityType,omitempty"`
 	PodsHavingTooManyRestarts         *PodsHavingTooManyRestarts         `json:"podsHavingTooManyRestarts,omitempty"`
-	MaxPodLifeTimeSeconds             *uint                              `json:"maxPodLifeTimeSeconds,omitempty"`
+	PodLifeTime                       *PodLifeTime                       `json:"podLifeTime,omitempty"`
 	RemoveDuplicates                  *RemoveDuplicates                  `json:"removeDuplicates,omitempty"`
 	Namespaces                        *Namespaces                        `json:"namespaces"`
 	ThresholdPriority                 *int32                             `json:"thresholdPriority"`
@@ -89,3 +89,8 @@ type PodsHavingTooManyRestarts struct {
 type RemoveDuplicates struct {
 	ExcludeOwnerKinds []string `json:"excludeOwnerKinds,omitempty"`
 }
+
+type PodLifeTime struct {
+	MaxPodLifeTimeSeconds *uint    `json:"maxPodLifeTimeSeconds,omitempty"`
+	PodStatusPhases       []string `json:"podStatusPhases,omitempty"`
+}
diff --git a/pkg/api/v1alpha1/zz_generated.conversion.go b/pkg/api/v1alpha1/zz_generated.conversion.go
diff --git a/pkg/api/v1alpha1/zz_generated.deepcopy.go b/pkg/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/api/zz_generated.deepcopy.go b/pkg/api/zz_generated.deepcopy.go
diff --git a/pkg/descheduler/strategies/pod_lifetime.go b/pkg/descheduler/strategies/pod_lifetime.go
@@ -32,10 +32,18 @@ import (
 )
 
 func validatePodLifeTimeParams(params *api.StrategyParameters) error {
-	if params == nil || params.MaxPodLifeTimeSeconds == nil {
+	if params == nil || params.PodLifeTime == nil || params.PodLifeTime.MaxPodLifeTimeSeconds == nil {
 		return fmt.Errorf("MaxPodLifeTimeSeconds not set")
 	}
 
+	if params.PodLifeTime.PodStatusPhases != nil {
+		for _, phase := range params.PodLifeTime.PodStatusPhases {
+			if phase != string(v1.PodPending) && phase != string(v1.PodRunning) {
+				return fmt.Errorf("only Pending and Running phases are supported in PodLifeTime")
+			}
+		}
+	}
+
 	// At most one of include/exclude can be set
 	if params.Namespaces != nil && len(params.Namespaces.Include) > 0 && len(params.Namespaces.Exclude) > 0 {
 		return fmt.Errorf("only one of Include/Exclude namespaces can be set")
@@ -68,14 +76,26 @@ func PodLifeTime(ctx context.Context, client clientset.Interface, strategy api.D
 
 	evictable := podEvictor.Evictable(evictions.WithPriorityThreshold(thresholdPriority))
 
+	filter := evictable.IsEvictable
+	if strategy.Params.PodLifeTime.PodStatusPhases != nil {
+		filter = func(pod *v1.Pod) bool {
+			for _, phase := range strategy.Params.PodLifeTime.PodStatusPhases {
+				if string(pod.Status.Phase) == phase {
+					return evictable.IsEvictable(pod)
+				}
+			}
+			return false
+		}
+	}
+
 	for _, node := range nodes {
 		klog.V(1).InfoS("Processing node", "node", klog.KObj(node))
 
-		pods := listOldPodsOnNode(ctx, client, node, includedNamespaces, excludedNamespaces, *strategy.Params.MaxPodLifeTimeSeconds, evictable.IsEvictable)
+		pods := listOldPodsOnNode(ctx, client, node, includedNamespaces, excludedNamespaces, *strategy.Params.PodLifeTime.MaxPodLifeTimeSeconds, filter)
 		for _, pod := range pods {
 			success, err := podEvictor.EvictPod(ctx, pod, node, "PodLifeTime")
 			if success {
-				klog.V(1).InfoS("Evicted pod because it exceeded its lifetime", "pod", klog.KObj(pod), "maxPodLifeTime", *strategy.Params.MaxPodLifeTimeSeconds)
+				klog.V(1).InfoS("Evicted pod because it exceeded its lifetime", "pod", klog.KObj(pod), "maxPodLifeTime", *strategy.Params.PodLifeTime.MaxPodLifeTimeSeconds)
 			}
 
 			if err != nil {