diff --git a/Makefile b/Makefile
index 97edeadbf..d1c363879 100644
--- a/Makefile
+++ b/Makefile
@@ -100,7 +100,7 @@ clean:
rm -rf _output
rm -rf _tmp
-verify: verify-govet verify-spelling verify-gofmt verify-vendor lint lint-chart verify-toc verify-gen
+verify: verify-govet verify-spelling verify-gofmt verify-vendor lint lint-chart verify-gen
verify-govet:
./hack/verify-govet.sh
@@ -114,9 +114,6 @@ verify-gofmt:
verify-vendor:
./hack/verify-vendor.sh
-verify-toc:
- ./hack/verify-toc.sh
-
verify-docs:
./hack/verify-docs.sh
@@ -130,7 +127,6 @@ gen:
./hack/update-generated-conversions.sh
./hack/update-generated-deep-copies.sh
./hack/update-generated-defaulters.sh
- ./hack/update-toc.sh
./hack/update-docs.sh
verify-gen:
diff --git a/README.md b/README.md
index 6c42649db..7c7469607 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
[](https://goreportcard.com/report/sigs.k8s.io/descheduler)
+
+ ↖️ Click at the [bullet list icon] at the top left corner of the Readme visualization for the github generated table of contents.
+
+
@@ -26,44 +30,6 @@ Descheduler, based on its policy, finds pods that can be moved and evicts them.
note, in current implementation, descheduler does not schedule replacement of evicted pods
but relies on the default scheduler for that.
-Table of Contents
-=================
-
-- [Quick Start](#quick-start)
- - [Run As A Job](#run-as-a-job)
- - [Run As A CronJob](#run-as-a-cronjob)
- - [Run As A Deployment](#run-as-a-deployment)
- - [Install Using Helm](#install-using-helm)
- - [Install Using Kustomize](#install-using-kustomize)
-- [User Guide](#user-guide)
-- [Policy and Strategies](#policy-and-strategies)
- - [RemoveDuplicates](#removeduplicates)
- - [LowNodeUtilization](#lownodeutilization)
- - [HighNodeUtilization](#highnodeutilization)
- - [RemovePodsViolatingInterPodAntiAffinity](#removepodsviolatinginterpodantiaffinity)
- - [RemovePodsViolatingNodeAffinity](#removepodsviolatingnodeaffinity)
- - [RemovePodsViolatingNodeTaints](#removepodsviolatingnodetaints)
- - [RemovePodsViolatingTopologySpreadConstraint](#removepodsviolatingtopologyspreadconstraint)
- - [RemovePodsHavingTooManyRestarts](#removepodshavingtoomanyrestarts)
- - [PodLifeTime](#podlifetime)
- - [RemoveFailedPods](#removefailedpods)
-- [Filter Pods](#filter-pods)
- - [Namespace filtering](#namespace-filtering)
- - [Priority filtering](#priority-filtering)
- - [Label filtering](#label-filtering)
- - [Node Fit filtering](#node-fit-filtering)
-- [Pod Evictions](#pod-evictions)
- - [Pod Disruption Budget (PDB)](#pod-disruption-budget-pdb)
-- [High Availability](#high-availability)
- - [Configure HA Mode](#configure-ha-mode)
-- [Metrics](#metrics)
-- [Compatibility Matrix](#compatibility-matrix)
-- [Getting Involved and Contributing](#getting-involved-and-contributing)
- - [Communicating With Contributors](#communicating-with-contributors)
-- [Roadmap](#roadmap)
- - [Code of conduct](#code-of-conduct)
-
-
## Quick Start
The descheduler can be run as a `Job`, `CronJob`, or `Deployment` inside of a k8s cluster. It has the
@@ -126,37 +92,71 @@ kustomize build 'github.com/kubernetes-sigs/descheduler/kubernetes/deployment?re
See the [user guide](docs/user-guide.md) in the `/docs` directory.
-## Policy and Strategies
+## Policy, Default Evictor and Strategy plugins
-Descheduler's policy is configurable and includes strategies that can be enabled or disabled. By default, all strategies are enabled.
+**⚠️ v1alpha1 configuration is still suported, but deprecated (and soon will be removed). Please consider migrating to v1alpha2 (described bellow). For previous v1alpha1 documentation go to [docs/deprecated/v1alpha1.md](docs/deprecated/v1alpha1.md) ⚠️**
-The policy includes a common configuration that applies to all the strategies:
-| Name | Default Value | Description |
-|------|---------------|-------------|
-| `nodeSelector` | `nil` | limiting the nodes which are processed |
-| `evictLocalStoragePods` | `false` | allows eviction of pods with local storage |
-| `evictSystemCriticalPods` | `false` | [Warning: Will evict Kubernetes system pods] allows eviction of pods with any priority, including system pods like kube-dns |
-| `ignorePvcPods` | `false` | set whether PVC pods should be evicted or ignored |
-| `maxNoOfPodsToEvictPerNode` | `nil` | maximum number of pods evicted from each node (summed through all strategies) |
-| `maxNoOfPodsToEvictPerNamespace` | `nil` | maximum number of pods evicted from each namespace (summed through all strategies) |
-| `evictFailedBarePods` | `false` | allow eviction of pods without owner references and in failed phase |
+The Descheduler Policy is configurable and includes default strategy plugins that can be enabled or disabled. It includes a common eviction configuration at the top level, as well as configuration from the Evictor plugin (Default Evictor, if not specified otherwise). Top-level configuration and Evictor plugin configuration are applied to all evictions.
-As part of the policy, the parameters associated with each strategy can be configured.
-See each strategy for details on available parameters.
+### Top Level configuration
+
+These are top level keys in the Descheduler Policy that you can use to configure all evictions.
+
+| Name |type| Default Value | Description |
+|------|----|---------------|-------------|
+| `nodeSelector` |`string`| `nil` | limiting the nodes which are processed. Only used when `nodeFit`=`true` and only by the PreEvictionFilter Extension Point |
+| `maxNoOfPodsToEvictPerNode` |`int`| `nil` | maximum number of pods evicted from each node (summed through all strategies) |
+| `maxNoOfPodsToEvictPerNamespace` |`int`| `nil` | maximum number of pods evicted from each namespace (summed through all strategies) |
+
+### Evictor Plugion configuration (Default Evictor)
+
+The Default Evictor Plugin is used by default for filtering pods before processing them in an strategy plugin, or for applying a PreEvictionFilter of pods before eviction. You can also create your own Evictor Plugin or use the Default one provided by Descheduler. Other uses for the Evictor plugin can be to sort, filter, validate or group pods by different criteria, and that's why this is handled by a plugin and not configured in the top level config.
+
+| Name |type| Default Value | Description |
+|------|----|---------------|-------------|
+| `nodeSelector` |`string`| `nil` | limiting the nodes which are processed |
+| `evictLocalStoragePods` |`bool`| `false` | allows eviction of pods with local storage |
+| `evictSystemCriticalPods` |`bool`| `false` | [Warning: Will evict Kubernetes system pods] allows eviction of pods with any priority, including system pods like kube-dns |
+| `ignorePvcPods` |`bool`| `false` | set whether PVC pods should be evicted or ignored |
+| `evictFailedBarePods` |`bool`| `false` | allow eviction of pods without owner references and in failed phase |
+|`labelSelector`|`metav1.LabelSelector`||(see [label filtering](#label-filtering))|
+|`priorityThreshold`|`priorityThreshold`||(see [priority filtering](#priority-filtering))|
+|`nodeFit`|`bool`|`false`|(see [node fit filtering](#node-fit-filtering))|
+
+### Example policy
+
+As part of the policy, you will start deciding which top level configuration to use, then which Evictor plugin to use (if you have your own, the Default Evictor if not), followed by deciding the configuration passed to the Evictor Plugin. After that you will enable/disable eviction strategies plugins and configure them properly.
+
+See each strategy plugin section for details on available parameters.
**Policy:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-nodeSelector: prod=dev
-evictFailedBarePods: false
-evictLocalStoragePods: true
-evictSystemCriticalPods: true
-maxNoOfPodsToEvictPerNode: 40
-ignorePvcPods: false
-strategies:
- ...
+nodeSelector: "node=node1" # you don't need to set this, if not set all will be processed
+maxNoOfPodsToEvictPerNode: 5000 # you don't need to set this, unlimited if not set
+maxNoOfPodsToEvictPerNamespace: 5000 # you don't need to set this, unlimited if not set
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ args:
+ evictSystemCriticalPods: true
+ evictFailedBarePods: true
+ evictLocalStoragePods: true
+ nodeFit: true
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - ...
+ balance:
+ enabled:
+ - ...
+ [...]
```
The following diagram provides a visualization of most of the strategies to help
@@ -164,9 +164,28 @@ categorize how strategies fit together.
+The following sections provide an overview of the different strategy plugins available. These plugins are grouped based on their implementation of extension points: Deschedule or Balance.
+
+Deschedule Plugins: These plugins process pods one by one, and evict them in a sequential manner.
+
+Balance Plugins: These plugins process all pods, or groups of pods, and determine which pods to evict based on how the group was intended to be spread.
+
+|Name|Extension Point Implemented|Description|
+|----|-----------|-----------|
+| [RemoveDuplicates](#removeduplicates) |Balance|Spreads replicas|
+| [LowNodeUtilization](#lownodeutilization) |Balance|Spreads pods according to pods resource requests and node resources available|
+| [HighNodeUtilization](#highnodeutilization) |Balance|Spreads pods according to pods resource requests and node resources available|
+| [RemovePodsViolatingInterPodAntiAffinity](#removepodsviolatinginterpodantiaffinity) |Deschedule|Evicts pods violating pod anti affinity|
+| [RemovePodsViolatingNodeAffinity](#removepodsviolatingnodeaffinity) |Deschedule|Evicts pods violating node affinity|
+| [RemovePodsViolatingNodeTaints](#removepodsviolatingnodetaints) |Deschedule|Evicts pods violating node taints|
+| [RemovePodsViolatingTopologySpreadConstraint](#removepodsviolatingtopologyspreadconstraint) |Balance|Evicts pods violating TopologySpreadConstraints|
+| [PodLifeTime](#podlifetime) |Deschedule|Evicts pods that have exceeded a specified age limit|
+| [RemoveFailedPods](#removefailedpods) |Deschedule|Evicts pods with certain failed reasons|
+
+
### RemoveDuplicates
-This strategy makes sure that there is only one pod associated with a ReplicaSet (RS),
+This strategy plugin makes sure that there is only one pod associated with a ReplicaSet (RS),
ReplicationController (RC), StatefulSet, or Job running on the same node. If there are more,
those duplicate pods are evicted for better spreading of pods in a cluster. This issue could happen
if some nodes went down due to whatever reasons, and pods on them were moved to other nodes leading to
@@ -184,21 +203,26 @@ should include `ReplicaSet` to have pods created by Deployments excluded.
|---|---|
|`excludeOwnerKinds`|list(string)|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemoveDuplicates":
- enabled: true
- params:
- removeDuplicates:
- excludeOwnerKinds:
- - "ReplicaSet"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemoveDuplicates"
+ args:
+ excludeOwnerKinds:
+ - "ReplicaSet"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "RemoveDuplicates"
```
### LowNodeUtilization
@@ -240,33 +264,38 @@ actual usage metrics. Implementing metrics-based descheduling is currently TODO
|Name|Type|
|---|---|
+|`useDeviationThresholds`|bool|
|`thresholds`|map(string:int)|
|`targetThresholds`|map(string:int)|
|`numberOfNodes`|int|
-|`useDeviationThresholds`|bool|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
-|`Namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`evictableNamespaces`|(see [namespace filtering](#namespace-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "LowNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
- thresholds:
- "cpu" : 20
- "memory": 20
- "pods": 20
- targetThresholds:
- "cpu" : 50
- "memory": 50
- "pods": 50
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "LowNodeUtilization"
+ args:
+ thresholds:
+ "cpu" : 20
+ "memory": 20
+ "pods": 20
+ targetThresholds:
+ "cpu" : 50
+ "memory": 50
+ "pods": 50
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "LowNodeUtilization"
```
Policy should pass the following validation checks:
@@ -317,25 +346,35 @@ actual usage metrics. Implementing metrics-based descheduling is currently TODO
|---|---|
|`thresholds`|map(string:int)|
|`numberOfNodes`|int|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
-|`Namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`evictableNamespaces`|(see [namespace filtering](#namespace-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "HighNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
- thresholds:
- "cpu" : 20
- "memory": 20
- "pods": 20
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "HighNodeUtilization"
+ args:
+ thresholds:
+ "cpu" : 20
+ "memory": 20
+ "pods": 20
+ evictableNamespaces:
+ namespaces:
+ exclude:
+ - "kube-system"
+ - "namespace1"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "HighNodeUtilization"
```
Policy should pass the following validation checks:
@@ -361,20 +400,26 @@ node.
|Name|Type|
|---|---|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingInterPodAntiAffinity":
- enabled: true
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingInterPodAntiAffinity"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsViolatingInterPodAntiAffinity"
```
### RemovePodsViolatingNodeAffinity
@@ -400,23 +445,29 @@ podA gets evicted from nodeA.
|Name|Type|
|---|---|
|`nodeAffinityType`|list(string)|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingNodeAffinity":
- enabled: true
- params:
- nodeAffinityType:
- - "requiredDuringSchedulingIgnoredDuringExecution"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingNodeAffinity"
+ args:
+ nodeAffinityType:
+ - "requiredDuringSchedulingIgnoredDuringExecution"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsViolatingNodeAffinity"
```
### RemovePodsViolatingNodeTaints
@@ -437,24 +488,31 @@ excludedTaints entry "dedicated=special-user" would match taints with key "dedic
|Name|Type|
|---|---|
|`excludedTaints`|list(string)|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`includePreferNoSchedule`|bool|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
````yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingNodeTaints":
- enabled: true
- params:
- excludedTaints:
- - dedicated=special-user # exclude taints with key "dedicated" and value "special-user"
- - reserved # exclude all taints with key "reserved"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingNodeTaints"
+ args:
+ excludedTaints:
+ - dedicated=special-user # exclude taints with key "dedicated" and value "special-user"
+ - reserved # exclude all taints with key "reserved"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsViolatingNodeTaints"
````
### RemovePodsViolatingTopologySpreadConstraint
@@ -473,22 +531,28 @@ Strategy parameter `labelSelector` is not utilized when balancing topology domai
|Name|Type|
|---|---|
|`includeSoftConstraints`|bool|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingTopologySpreadConstraint":
- enabled: true
- params:
- includeSoftConstraints: false
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingTopologySpreadConstraint"
+ args:
+ includeSoftConstraints: false
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "RemovePodsViolatingTopologySpreadConstraint"
```
@@ -506,24 +570,29 @@ into that calculation.
|---|---|
|`podRestartThreshold`|int|
|`includingInitContainers`|bool|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsHavingTooManyRestarts":
- enabled: true
- params:
- podsHavingTooManyRestarts:
- podRestartThreshold: 100
- includingInitContainers: true
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsHavingTooManyRestarts"
+ args:
+ podRestartThreshold: 100
+ includingInitContainers: true
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsHavingTooManyRestarts"
```
### PodLifeTime
@@ -542,27 +611,32 @@ Pods in any state (even `Running`) are considered for eviction.
|Name|Type|Notes|
|---|---|---|
|`maxPodLifeTimeSeconds`|int||
-|`podStatusPhases`|list(string)|Deprecated in v0.25+ Use `states` instead|
|`states`|list(string)|Only supported in v0.25+|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))||
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))||
|`namespaces`|(see [namespace filtering](#namespace-filtering))||
|`labelSelector`|(see [label filtering](#label-filtering))||
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 86400
- states:
- - "Pending"
- - "PodInitializing"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
+ states:
+ - "Pending"
+ - "PodInitializing"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
### RemoveFailedPods
@@ -582,28 +656,33 @@ has any of these `Kind`s listed as an `OwnerRef`, that pod will not be considere
|`excludeOwnerKinds`|list(string)|
|`reasons`|list(string)|
|`includingInitContainers`|bool|
-|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
-|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
|`namespaces`|(see [namespace filtering](#namespace-filtering))|
|`labelSelector`|(see [label filtering](#label-filtering))|
-|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
**Example:**
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemoveFailedPods":
- enabled: true
- params:
- failedPods:
- reasons:
- - "NodeAffinity"
- includingInitContainers: true
- excludeOwnerKinds:
- - "Job"
- minPodLifetimeSeconds: 3600
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemoveFailedPods"
+ args:
+ reasons:
+ - "NodeAffinity"
+ includingInitContainers: true
+ excludeOwnerKinds:
+ - "Job"
+ minPodLifetimeSeconds: 3600
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemoveFailedPods"
```
## Filter Pods
@@ -619,41 +698,60 @@ The following strategies accept a `namespaces` parameter which allows to specify
* `RemoveDuplicates`
* `RemovePodsViolatingTopologySpreadConstraint`
* `RemoveFailedPods`
+
+
+The following strategies accept a `evictableNamespaces` parameter which allows to specify a list of excluding namespaces:
* `LowNodeUtilization` and `HighNodeUtilization` (Only filtered right before eviction)
-For example:
+For example with PodLifeTime:
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 86400
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
namespaces:
include:
- "namespace1"
- "namespace2"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
-In the examples `PodLifeTime` gets executed only over `namespace1` and `namespace2`.
+In the example `PodLifeTime` gets executed only over `namespace1` and `namespace2`.
The similar holds for `exclude` field:
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 86400
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
namespaces:
exclude:
- "namespace1"
- "namespace2"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
The strategy gets executed over all namespaces but `namespace1` and `namespace2`.
@@ -662,42 +760,62 @@ It's not allowed to compute `include` with `exclude` field.
### Priority filtering
-All strategies are able to configure a priority threshold, only pods under the threshold can be evicted. You can
-specify this threshold by setting `thresholdPriorityClassName`(setting the threshold to the value of the given
-priority class) or `thresholdPriority`(directly setting the threshold) parameters. By default, this threshold
+Priority threshold can be configured via the Default Evictor Filter, and, only pods under the threshold can be evicted. You can
+specify this threshold by setting `priorityThreshold.name`(setting the threshold to the value of the given
+priority class) or `priorityThreshold.value`(directly setting the threshold) parameters. By default, this threshold
is set to the value of `system-cluster-critical` priority class.
Note: Setting `evictSystemCriticalPods` to true disables priority filtering entirely.
E.g.
-Setting `thresholdPriority`
+Setting `priorityThreshold value`
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 86400
- thresholdPriority: 10000
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ args:
+ priorityThreshold:
+ value: 10000
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
-Setting `thresholdPriorityClassName`
+Setting `Priority Threshold Class Name (priorityThreshold.name)`
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 86400
- thresholdPriorityClassName: "priorityclass1"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ args:
+ priorityThreshold:
+ name: "priorityClassName1"
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
-Note that you can't configure both `thresholdPriority` and `thresholdPriorityClassName`, if the given priority class
+Note that you can't configure both `priorityThreshold.name` and `priorityThreshold.value`, if the given priority class
does not exist, descheduler won't create it and will throw an error.
### Label filtering
@@ -718,37 +836,34 @@ This allows running strategies among pods the descheduler is interested in.
For example:
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
maxPodLifeTimeSeconds: 86400
- labelSelector:
- matchLabels:
- component: redis
- matchExpressions:
- - {key: tier, operator: In, values: [cache]}
- - {key: environment, operator: NotIn, values: [dev]}
+ labelSelector:
+ matchLabels:
+ component: redis
+ matchExpressions:
+ - {key: tier, operator: In, values: [cache]}
+ - {key: environment, operator: NotIn, values: [dev]}
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
### Node Fit filtering
-The following strategies accept a `nodeFit` boolean parameter which can optimize descheduling:
-* `RemoveDuplicates`
-* `LowNodeUtilization`
-* `HighNodeUtilization`
-* `RemovePodsViolatingInterPodAntiAffinity`
-* `RemovePodsViolatingNodeAffinity`
-* `RemovePodsViolatingNodeTaints`
-* `RemovePodsViolatingTopologySpreadConstraint`
-* `RemovePodsHavingTooManyRestarts`
-* `RemoveFailedPods`
-
- If set to `true` the descheduler will consider whether or not the pods that meet eviction criteria will fit on other nodes before evicting them. If a pod cannot be rescheduled to another node, it will not be evicted. Currently the following criteria are considered when setting `nodeFit` to `true`:
+ NodeFit can be configured via the Default Evictor Filter. If set to `true` the descheduler will consider whether or not the pods that meet eviction criteria will fit on other nodes before evicting them. If a pod cannot be rescheduled to another node, it will not be evicted. Currently the following criteria are considered when setting `nodeFit` to `true`:
- A `nodeSelector` on the pod
- Any `tolerations` on the pod and any `taints` on the other nodes
- `nodeAffinity` on the pod
@@ -758,22 +873,24 @@ The following strategies accept a `nodeFit` boolean parameter which can optimize
E.g.
```yaml
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "LowNodeUtilization":
- enabled: true
- params:
- nodeFit: true
- nodeResourceUtilizationThresholds:
- thresholds:
- "cpu": 20
- "memory": 20
- "pods": 20
- targetThresholds:
- "cpu": 50
- "memory": 50
- "pods": 50
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ args:
+ nodeFit: true
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 86400
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
Note that node fit filtering references the current pod spec, and not that of it's owner.
diff --git a/docs/deprecated/v1alpha1.md b/docs/deprecated/v1alpha1.md
new file mode 100644
index 000000000..402cdd8fd
--- /dev/null
+++ b/docs/deprecated/v1alpha1.md
@@ -0,0 +1,784 @@
+[](https://goreportcard.com/report/sigs.k8s.io/descheduler)
+
+
+
+
+
+
+# Descheduler for Kubernetes
+
+Scheduling in Kubernetes is the process of binding pending pods to nodes, and is performed by
+a component of Kubernetes called kube-scheduler. The scheduler's decisions, whether or where a
+pod can or can not be scheduled, are guided by its configurable policy which comprises of set of
+rules, called predicates and priorities. The scheduler's decisions are influenced by its view of
+a Kubernetes cluster at that point of time when a new pod appears for scheduling.
+As Kubernetes clusters are very dynamic and their state changes over time, there may be desire
+to move already running pods to some other nodes for various reasons:
+
+* Some nodes are under or over utilized.
+* The original scheduling decision does not hold true any more, as taints or labels are added to
+or removed from nodes, pod/node affinity requirements are not satisfied any more.
+* Some nodes failed and their pods moved to other nodes.
+* New nodes are added to clusters.
+
+Consequently, there might be several pods scheduled on less desired nodes in a cluster.
+Descheduler, based on its policy, finds pods that can be moved and evicts them. Please
+note, in current implementation, descheduler does not schedule replacement of evicted pods
+but relies on the default scheduler for that.
+
+Table of Contents
+=================
+
+- [Quick Start](#quick-start)
+ - [Run As A Job](#run-as-a-job)
+ - [Run As A CronJob](#run-as-a-cronjob)
+ - [Run As A Deployment](#run-as-a-deployment)
+ - [Install Using Helm](#install-using-helm)
+ - [Install Using Kustomize](#install-using-kustomize)
+- [User Guide](#user-guide)
+- [Policy and Strategies](#policy-and-strategies)
+ - [RemoveDuplicates](#removeduplicates)
+ - [LowNodeUtilization](#lownodeutilization)
+ - [HighNodeUtilization](#highnodeutilization)
+ - [RemovePodsViolatingInterPodAntiAffinity](#removepodsviolatinginterpodantiaffinity)
+ - [RemovePodsViolatingNodeAffinity](#removepodsviolatingnodeaffinity)
+ - [RemovePodsViolatingNodeTaints](#removepodsviolatingnodetaints)
+ - [RemovePodsViolatingTopologySpreadConstraint](#removepodsviolatingtopologyspreadconstraint)
+ - [RemovePodsHavingTooManyRestarts](#removepodshavingtoomanyrestarts)
+ - [PodLifeTime](#podlifetime)
+ - [RemoveFailedPods](#removefailedpods)
+- [Filter Pods](#filter-pods)
+ - [Namespace filtering](#namespace-filtering)
+ - [Priority filtering](#priority-filtering)
+ - [Label filtering](#label-filtering)
+ - [Node Fit filtering](#node-fit-filtering)
+- [Pod Evictions](#pod-evictions)
+ - [Pod Disruption Budget (PDB)](#pod-disruption-budget-pdb)
+- [High Availability](#high-availability)
+ - [Configure HA Mode](#configure-ha-mode)
+- [Metrics](#metrics)
+- [Compatibility Matrix](#compatibility-matrix)
+- [Getting Involved and Contributing](#getting-involved-and-contributing)
+ - [Communicating With Contributors](#communicating-with-contributors)
+- [Roadmap](#roadmap)
+ - [Code of conduct](#code-of-conduct)
+
+
+## Quick Start
+
+The descheduler can be run as a `Job`, `CronJob`, or `Deployment` inside of a k8s cluster. It has the
+advantage of being able to be run multiple times without needing user intervention.
+The descheduler pod is run as a critical pod in the `kube-system` namespace to avoid
+being evicted by itself or by the kubelet.
+
+### Run As A Job
+
+```
+kubectl create -f kubernetes/base/rbac.yaml
+kubectl create -f kubernetes/base/configmap.yaml
+kubectl create -f kubernetes/job/job.yaml
+```
+
+### Run As A CronJob
+
+```
+kubectl create -f kubernetes/base/rbac.yaml
+kubectl create -f kubernetes/base/configmap.yaml
+kubectl create -f kubernetes/cronjob/cronjob.yaml
+```
+
+### Run As A Deployment
+
+```
+kubectl create -f kubernetes/base/rbac.yaml
+kubectl create -f kubernetes/base/configmap.yaml
+kubectl create -f kubernetes/deployment/deployment.yaml
+```
+
+### Install Using Helm
+
+Starting with release v0.18.0 there is an official helm chart that can be used to install the
+descheduler. See the [helm chart README](https://github.com/kubernetes-sigs/descheduler/blob/master/charts/descheduler/README.md) for detailed instructions.
+
+The descheduler helm chart is also listed on the [artifact hub](https://artifacthub.io/packages/helm/descheduler/descheduler).
+
+### Install Using Kustomize
+
+You can use kustomize to install descheduler.
+See the [resources | Kustomize](https://kubectl.docs.kubernetes.io/references/kustomize/cmd/build/) for detailed instructions.
+
+Run As A Job
+```
+kustomize build 'github.com/kubernetes-sigs/descheduler/kubernetes/job?ref=v0.26.0' | kubectl apply -f -
+```
+
+Run As A CronJob
+```
+kustomize build 'github.com/kubernetes-sigs/descheduler/kubernetes/cronjob?ref=v0.26.0' | kubectl apply -f -
+```
+
+Run As A Deployment
+```
+kustomize build 'github.com/kubernetes-sigs/descheduler/kubernetes/deployment?ref=v0.26.0' | kubectl apply -f -
+```
+
+## User Guide
+
+See the [user guide](docs/user-guide.md) in the `/docs` directory.
+
+## Policy and Strategies
+
+Descheduler's policy is configurable and includes strategies that can be enabled or disabled. By default, all strategies are enabled.
+
+The policy includes a common configuration that applies to all the strategies:
+| Name | Default Value | Description |
+|------|---------------|-------------|
+| `nodeSelector` | `nil` | limiting the nodes which are processed |
+| `evictLocalStoragePods` | `false` | allows eviction of pods with local storage |
+| `evictSystemCriticalPods` | `false` | [Warning: Will evict Kubernetes system pods] allows eviction of pods with any priority, including system pods like kube-dns |
+| `ignorePvcPods` | `false` | set whether PVC pods should be evicted or ignored |
+| `maxNoOfPodsToEvictPerNode` | `nil` | maximum number of pods evicted from each node (summed through all strategies) |
+| `maxNoOfPodsToEvictPerNamespace` | `nil` | maximum number of pods evicted from each namespace (summed through all strategies) |
+| `evictFailedBarePods` | `false` | allow eviction of pods without owner references and in failed phase |
+
+As part of the policy, the parameters associated with each strategy can be configured.
+See each strategy for details on available parameters.
+
+**Policy:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+nodeSelector: prod=dev
+evictFailedBarePods: false
+evictLocalStoragePods: true
+evictSystemCriticalPods: true
+maxNoOfPodsToEvictPerNode: 40
+ignorePvcPods: false
+strategies:
+ ...
+```
+
+The following diagram provides a visualization of most of the strategies to help
+categorize how strategies fit together.
+
+
+
+### RemoveDuplicates
+
+This strategy makes sure that there is only one pod associated with a ReplicaSet (RS),
+ReplicationController (RC), StatefulSet, or Job running on the same node. If there are more,
+those duplicate pods are evicted for better spreading of pods in a cluster. This issue could happen
+if some nodes went down due to whatever reasons, and pods on them were moved to other nodes leading to
+more than one pod associated with a RS or RC, for example, running on the same node. Once the failed nodes
+are ready again, this strategy could be enabled to evict those duplicate pods.
+
+It provides one optional parameter, `excludeOwnerKinds`, which is a list of OwnerRef `Kind`s. If a pod
+has any of these `Kind`s listed as an `OwnerRef`, that pod will not be considered for eviction. Note that
+pods created by Deployments are considered for eviction by this strategy. The `excludeOwnerKinds` parameter
+should include `ReplicaSet` to have pods created by Deployments excluded.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`excludeOwnerKinds`|list(string)|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemoveDuplicates":
+ enabled: true
+ params:
+ removeDuplicates:
+ excludeOwnerKinds:
+ - "ReplicaSet"
+```
+
+### LowNodeUtilization
+
+This strategy finds nodes that are under utilized and evicts pods, if possible, from other nodes
+in the hope that recreation of evicted pods will be scheduled on these underutilized nodes. The
+parameters of this strategy are configured under `nodeResourceUtilizationThresholds`.
+
+The under utilization of nodes is determined by a configurable threshold `thresholds`. The threshold
+`thresholds` can be configured for cpu, memory, number of pods, and extended resources in terms of percentage (the percentage is
+calculated as the current resources requested on the node vs [total allocatable](https://kubernetes.io/docs/concepts/architecture/nodes/#capacity).
+For pods, this means the number of pods on the node as a fraction of the pod capacity set for that node).
+
+If a node's usage is below threshold for all (cpu, memory, number of pods and extended resources), the node is considered underutilized.
+Currently, pods request resource requirements are considered for computing node resource utilization.
+
+There is another configurable threshold, `targetThresholds`, that is used to compute those potential nodes
+from where pods could be evicted. If a node's usage is above targetThreshold for any (cpu, memory, number of pods, or extended resources),
+the node is considered over utilized. Any node between the thresholds, `thresholds` and `targetThresholds` is
+considered appropriately utilized and is not considered for eviction. The threshold, `targetThresholds`,
+can be configured for cpu, memory, and number of pods too in terms of percentage.
+
+These thresholds, `thresholds` and `targetThresholds`, could be tuned as per your cluster requirements. Note that this
+strategy evicts pods from `overutilized nodes` (those with usage above `targetThresholds`) to `underutilized nodes`
+(those with usage below `thresholds`), it will abort if any number of `underutilized nodes` or `overutilized nodes` is zero.
+
+Additionally, the strategy accepts a `useDeviationThresholds` parameter.
+If that parameter is set to `true`, the thresholds are considered as percentage deviations from mean resource usage.
+`thresholds` will be deducted from the mean among all nodes and `targetThresholds` will be added to the mean.
+A resource consumption above (resp. below) this window is considered as overutilization (resp. underutilization).
+
+**NOTE:** Node resource consumption is determined by the requests and limits of pods, not actual usage.
+This approach is chosen in order to maintain consistency with the kube-scheduler, which follows the same
+design for scheduling pods onto nodes. This means that resource usage as reported by Kubelet (or commands
+like `kubectl top`) may differ from the calculated consumption, due to these components reporting
+actual usage metrics. Implementing metrics-based descheduling is currently TODO for the project.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`thresholds`|map(string:int)|
+|`targetThresholds`|map(string:int)|
+|`numberOfNodes`|int|
+|`useDeviationThresholds`|bool|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+|`Namespaces`|(see [namespace filtering](#namespace-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "LowNodeUtilization":
+ enabled: true
+ params:
+ nodeResourceUtilizationThresholds:
+ thresholds:
+ "cpu" : 20
+ "memory": 20
+ "pods": 20
+ targetThresholds:
+ "cpu" : 50
+ "memory": 50
+ "pods": 50
+```
+
+Policy should pass the following validation checks:
+* Three basic native types of resources are supported: `cpu`, `memory` and `pods`.
+If any of these resource types is not specified, all its thresholds default to 100% to avoid nodes going from underutilized to overutilized.
+* Extended resources are supported. For example, resource type `nvidia.com/gpu` is specified for GPU node utilization. Extended resources are optional,
+and will not be used to compute node's usage if it's not specified in `thresholds` and `targetThresholds` explicitly.
+* `thresholds` or `targetThresholds` can not be nil and they must configure exactly the same types of resources.
+* The valid range of the resource's percentage value is \[0, 100\]
+* Percentage value of `thresholds` can not be greater than `targetThresholds` for the same resource.
+
+There is another parameter associated with the `LowNodeUtilization` strategy, called `numberOfNodes`.
+This parameter can be configured to activate the strategy only when the number of under utilized nodes
+are above the configured value. This could be helpful in large clusters where a few nodes could go
+under utilized frequently or for a short period of time. By default, `numberOfNodes` is set to zero.
+
+### HighNodeUtilization
+
+This strategy finds nodes that are under utilized and evicts pods from the nodes in the hope that these pods will be
+scheduled compactly into fewer nodes. Used in conjunction with node auto-scaling, this strategy is intended to help
+trigger down scaling of under utilized nodes.
+This strategy **must** be used with the scheduler scoring strategy `MostAllocated`. The parameters of this strategy are
+configured under `nodeResourceUtilizationThresholds`.
+
+The under utilization of nodes is determined by a configurable threshold `thresholds`. The threshold
+`thresholds` can be configured for cpu, memory, number of pods, and extended resources in terms of percentage. The percentage is
+calculated as the current resources requested on the node vs [total allocatable](https://kubernetes.io/docs/concepts/architecture/nodes/#capacity).
+For pods, this means the number of pods on the node as a fraction of the pod capacity set for that node.
+
+If a node's usage is below threshold for all (cpu, memory, number of pods and extended resources), the node is considered underutilized.
+Currently, pods request resource requirements are considered for computing node resource utilization.
+Any node above `thresholds` is considered appropriately utilized and is not considered for eviction.
+
+The `thresholds` param could be tuned as per your cluster requirements. Note that this
+strategy evicts pods from `underutilized nodes` (those with usage below `thresholds`)
+so that they can be recreated in appropriately utilized nodes.
+The strategy will abort if any number of `underutilized nodes` or `appropriately utilized nodes` is zero.
+
+**NOTE:** Node resource consumption is determined by the requests and limits of pods, not actual usage.
+This approach is chosen in order to maintain consistency with the kube-scheduler, which follows the same
+design for scheduling pods onto nodes. This means that resource usage as reported by Kubelet (or commands
+like `kubectl top`) may differ from the calculated consumption, due to these components reporting
+actual usage metrics. Implementing metrics-based descheduling is currently TODO for the project.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`thresholds`|map(string:int)|
+|`numberOfNodes`|int|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+|`Namespaces`|(see [namespace filtering](#namespace-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "HighNodeUtilization":
+ enabled: true
+ params:
+ nodeResourceUtilizationThresholds:
+ thresholds:
+ "cpu" : 20
+ "memory": 20
+ "pods": 20
+```
+
+Policy should pass the following validation checks:
+* Three basic native types of resources are supported: `cpu`, `memory` and `pods`. If any of these resource types is not specified, all its thresholds default to 100%.
+* Extended resources are supported. For example, resource type `nvidia.com/gpu` is specified for GPU node utilization. Extended resources are optional, and will not be used to compute node's usage if it's not specified in `thresholds` explicitly.
+* `thresholds` can not be nil.
+* The valid range of the resource's percentage value is \[0, 100\]
+
+There is another parameter associated with the `HighNodeUtilization` strategy, called `numberOfNodes`.
+This parameter can be configured to activate the strategy only when the number of under utilized nodes
+is above the configured value. This could be helpful in large clusters where a few nodes could go
+under utilized frequently or for a short period of time. By default, `numberOfNodes` is set to zero.
+
+### RemovePodsViolatingInterPodAntiAffinity
+
+This strategy makes sure that pods violating interpod anti-affinity are removed from nodes. For example,
+if there is podA on a node and podB and podC (running on the same node) have anti-affinity rules which prohibit
+them to run on the same node, then podA will be evicted from the node so that podB and podC could run. This
+issue could happen, when the anti-affinity rules for podB and podC are created when they are already running on
+node.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemovePodsViolatingInterPodAntiAffinity":
+ enabled: true
+```
+
+### RemovePodsViolatingNodeAffinity
+
+This strategy makes sure all pods violating
+[node affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity)
+are eventually removed from nodes. Node affinity rules allow a pod to specify
+`requiredDuringSchedulingIgnoredDuringExecution` type, which tells the scheduler
+to respect node affinity when scheduling the pod but kubelet to ignore
+in case node changes over time and no longer respects the affinity.
+When enabled, the strategy serves as a temporary implementation
+of `requiredDuringSchedulingRequiredDuringExecution` and evicts pod for kubelet
+that no longer respects node affinity.
+
+For example, there is podA scheduled on nodeA which satisfies the node
+affinity rule `requiredDuringSchedulingIgnoredDuringExecution` at the time
+of scheduling. Over time nodeA stops to satisfy the rule. When the strategy gets
+executed and there is another node available that satisfies the node affinity rule,
+podA gets evicted from nodeA.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`nodeAffinityType`|list(string)|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemovePodsViolatingNodeAffinity":
+ enabled: true
+ params:
+ nodeAffinityType:
+ - "requiredDuringSchedulingIgnoredDuringExecution"
+```
+
+### RemovePodsViolatingNodeTaints
+
+This strategy makes sure that pods violating NoSchedule taints on nodes are removed. For example there is a
+pod "podA" with a toleration to tolerate a taint ``key=value:NoSchedule`` scheduled and running on the tainted
+node. If the node's taint is subsequently updated/removed, taint is no longer satisfied by its pods' tolerations
+and will be evicted.
+
+Node taints can be excluded from consideration by specifying a list of excludedTaints. If a node taint key **or**
+key=value matches an excludedTaints entry, the taint will be ignored.
+
+For example, excludedTaints entry "dedicated" would match all taints with key "dedicated", regardless of value.
+excludedTaints entry "dedicated=special-user" would match taints with key "dedicated" and value "special-user".
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`excludedTaints`|list(string)|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+````yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemovePodsViolatingNodeTaints":
+ enabled: true
+ params:
+ excludedTaints:
+ - dedicated=special-user # exclude taints with key "dedicated" and value "special-user"
+ - reserved # exclude all taints with key "reserved"
+````
+
+### RemovePodsViolatingTopologySpreadConstraint
+
+This strategy makes sure that pods violating [topology spread constraints](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/)
+are evicted from nodes. Specifically, it tries to evict the minimum number of pods required to balance topology domains to within each constraint's `maxSkew`.
+This strategy requires k8s version 1.18 at a minimum.
+
+By default, this strategy only deals with hard constraints, setting parameter `includeSoftConstraints` to `true` will
+include soft constraints.
+
+Strategy parameter `labelSelector` is not utilized when balancing topology domains and is only applied during eviction to determine if the pod can be evicted.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`includeSoftConstraints`|bool|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemovePodsViolatingTopologySpreadConstraint":
+ enabled: true
+ params:
+ includeSoftConstraints: false
+```
+
+
+### RemovePodsHavingTooManyRestarts
+
+This strategy makes sure that pods having too many restarts are removed from nodes. For example a pod with EBS/PD that
+can't get the volume/disk attached to the instance, then the pod should be re-scheduled to other nodes. Its parameters
+include `podRestartThreshold`, which is the number of restarts (summed over all eligible containers) at which a pod
+should be evicted, and `includingInitContainers`, which determines whether init container restarts should be factored
+into that calculation.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`podRestartThreshold`|int|
+|`includingInitContainers`|bool|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemovePodsHavingTooManyRestarts":
+ enabled: true
+ params:
+ podsHavingTooManyRestarts:
+ podRestartThreshold: 100
+ includingInitContainers: true
+```
+
+### PodLifeTime
+
+This strategy evicts pods that are older than `maxPodLifeTimeSeconds`.
+
+You can also specify `states` parameter to **only** evict pods matching the following conditions:
+ - [Pod Phase](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase) status of: `Running`, `Pending`
+ - [Container State Waiting](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-state-waiting) condition of: `PodInitializing`, `ContainerCreating`
+
+If a value for `states` or `podStatusPhases` is not specified,
+Pods in any state (even `Running`) are considered for eviction.
+
+**Parameters:**
+
+|Name|Type|Notes|
+|---|---|---|
+|`maxPodLifeTimeSeconds`|int||
+|`podStatusPhases`|list(string)|Deprecated in v0.25+ Use `states` instead|
+|`states`|list(string)|Only supported in v0.25+|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))||
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))||
+|`namespaces`|(see [namespace filtering](#namespace-filtering))||
+|`labelSelector`|(see [label filtering](#label-filtering))||
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ states:
+ - "Pending"
+ - "PodInitializing"
+```
+
+### RemoveFailedPods
+
+This strategy evicts pods that are in failed status phase.
+You can provide an optional parameter to filter by failed `reasons`.
+`reasons` can be expanded to include reasons of InitContainers as well by setting the optional parameter `includingInitContainers` to `true`.
+You can specify an optional parameter `minPodLifetimeSeconds` to evict pods that are older than specified seconds.
+Lastly, you can specify the optional parameter `excludeOwnerKinds` and if a pod
+has any of these `Kind`s listed as an `OwnerRef`, that pod will not be considered for eviction.
+
+**Parameters:**
+
+|Name|Type|
+|---|---|
+|`minPodLifetimeSeconds`|uint|
+|`excludeOwnerKinds`|list(string)|
+|`reasons`|list(string)|
+|`includingInitContainers`|bool|
+|`thresholdPriority`|int (see [priority filtering](#priority-filtering))|
+|`thresholdPriorityClassName`|string (see [priority filtering](#priority-filtering))|
+|`namespaces`|(see [namespace filtering](#namespace-filtering))|
+|`labelSelector`|(see [label filtering](#label-filtering))|
+|`nodeFit`|bool (see [node fit filtering](#node-fit-filtering))|
+
+**Example:**
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "RemoveFailedPods":
+ enabled: true
+ params:
+ failedPods:
+ reasons:
+ - "NodeAffinity"
+ includingInitContainers: true
+ excludeOwnerKinds:
+ - "Job"
+ minPodLifetimeSeconds: 3600
+```
+
+## Filter Pods
+
+### Namespace filtering
+
+The following strategies accept a `namespaces` parameter which allows to specify a list of including, resp. excluding namespaces:
+* `PodLifeTime`
+* `RemovePodsHavingTooManyRestarts`
+* `RemovePodsViolatingNodeTaints`
+* `RemovePodsViolatingNodeAffinity`
+* `RemovePodsViolatingInterPodAntiAffinity`
+* `RemoveDuplicates`
+* `RemovePodsViolatingTopologySpreadConstraint`
+* `RemoveFailedPods`
+* `LowNodeUtilization` and `HighNodeUtilization` (Only filtered right before eviction)
+
+For example:
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ namespaces:
+ include:
+ - "namespace1"
+ - "namespace2"
+```
+
+In the examples `PodLifeTime` gets executed only over `namespace1` and `namespace2`.
+The similar holds for `exclude` field:
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ namespaces:
+ exclude:
+ - "namespace1"
+ - "namespace2"
+```
+
+The strategy gets executed over all namespaces but `namespace1` and `namespace2`.
+
+It's not allowed to compute `include` with `exclude` field.
+
+### Priority filtering
+
+All strategies are able to configure a priority threshold, only pods under the threshold can be evicted. You can
+specify this threshold by setting `thresholdPriorityClassName`(setting the threshold to the value of the given
+priority class) or `thresholdPriority`(directly setting the threshold) parameters. By default, this threshold
+is set to the value of `system-cluster-critical` priority class.
+
+Note: Setting `evictSystemCriticalPods` to true disables priority filtering entirely.
+
+E.g.
+
+Setting `thresholdPriority`
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ thresholdPriority: 10000
+```
+
+Setting `thresholdPriorityClassName`
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ thresholdPriorityClassName: "priorityclass1"
+```
+
+Note that you can't configure both `thresholdPriority` and `thresholdPriorityClassName`, if the given priority class
+does not exist, descheduler won't create it and will throw an error.
+
+### Label filtering
+
+The following strategies can configure a [standard kubernetes labelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#labelselector-v1-meta)
+to filter pods by their labels:
+
+* `PodLifeTime`
+* `RemovePodsHavingTooManyRestarts`
+* `RemovePodsViolatingNodeTaints`
+* `RemovePodsViolatingNodeAffinity`
+* `RemovePodsViolatingInterPodAntiAffinity`
+* `RemovePodsViolatingTopologySpreadConstraint`
+* `RemoveFailedPods`
+
+This allows running strategies among pods the descheduler is interested in.
+
+For example:
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "PodLifeTime":
+ enabled: true
+ params:
+ podLifeTime:
+ maxPodLifeTimeSeconds: 86400
+ labelSelector:
+ matchLabels:
+ component: redis
+ matchExpressions:
+ - {key: tier, operator: In, values: [cache]}
+ - {key: environment, operator: NotIn, values: [dev]}
+```
+
+
+### Node Fit filtering
+
+The following strategies accept a `nodeFit` boolean parameter which can optimize descheduling:
+* `RemoveDuplicates`
+* `LowNodeUtilization`
+* `HighNodeUtilization`
+* `RemovePodsViolatingInterPodAntiAffinity`
+* `RemovePodsViolatingNodeAffinity`
+* `RemovePodsViolatingNodeTaints`
+* `RemovePodsViolatingTopologySpreadConstraint`
+* `RemovePodsHavingTooManyRestarts`
+* `RemoveFailedPods`
+
+ If set to `true` the descheduler will consider whether or not the pods that meet eviction criteria will fit on other nodes before evicting them. If a pod cannot be rescheduled to another node, it will not be evicted. Currently the following criteria are considered when setting `nodeFit` to `true`:
+- A `nodeSelector` on the pod
+- Any `tolerations` on the pod and any `taints` on the other nodes
+- `nodeAffinity` on the pod
+- Resource `requests` made by the pod and the resources available on other nodes
+- Whether any of the other nodes are marked as `unschedulable`
+
+E.g.
+
+```yaml
+apiVersion: "descheduler/v1alpha1"
+kind: "DeschedulerPolicy"
+strategies:
+ "LowNodeUtilization":
+ enabled: true
+ params:
+ nodeFit: true
+ nodeResourceUtilizationThresholds:
+ thresholds:
+ "cpu": 20
+ "memory": 20
+ "pods": 20
+ targetThresholds:
+ "cpu": 50
+ "memory": 50
+ "pods": 50
+```
+
+Note that node fit filtering references the current pod spec, and not that of it's owner.
+Thus, if the pod is owned by a ReplicationController (and that ReplicationController was modified recently),
+the pod may be running with an outdated spec, which the descheduler will reference when determining node fit.
+This is expected behavior as the descheduler is a "best-effort" mechanism.
+
+Using Deployments instead of ReplicationControllers provides an automated rollout of pod spec changes, therefore ensuring that the descheduler has an up-to-date view of the cluster state.
diff --git a/docs/user-guide.md b/docs/user-guide.md
index ff36407f9..8d08f9f47 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -51,14 +51,22 @@ descheduler -v=3 --evict-local-storage-pods --policy-config-file=pod-life-time.y
This policy configuration file ensures that pods created more than 7 days ago are evicted.
```
---
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
- maxPodLifeTimeSeconds: 604800 # pods run for a maximum of 7 days
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
+ maxPodLifeTimeSeconds: 604800
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
```
### Balance Cluster By Node Memory Utilization
@@ -71,17 +79,25 @@ Using `LowNodeUtilization`, descheduler will rebalance the cluster based on memo
from nodes with memory utilization over 70% to nodes with memory utilization below 20%.
```
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "LowNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "LowNodeUtilization"
+ args:
thresholds:
"memory": 20
targetThresholds:
"memory": 70
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "LowNodeUtilization"
```
#### Balance low utilization nodes
@@ -90,15 +106,23 @@ from nodes with memory utilization lower than 20%. This should be use `NodeResou
The evicted pods will be compacted into minimal set of nodes.
```
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "HighNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "HighNodeUtilization"
+ args:
thresholds:
"memory": 20
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "HighNodeUtilization"
```
### Autoheal Node Problems
diff --git a/examples/failed-pods.yaml b/examples/failed-pods.yaml
index 623fd2cde..a9b5a678c 100644
--- a/examples/failed-pods.yaml
+++ b/examples/failed-pods.yaml
@@ -1,14 +1,22 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemoveFailedPods":
- enabled: true
- params:
- failedPods:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemoveFailedPods"
+ args:
reasons:
- "OutOfcpu"
- "CreateContainerConfigError"
includingInitContainers: true
excludeOwnerKinds:
- "Job"
- minPodLifetimeSeconds: 3600 # 1 hour
+ minPodLifetimeSeconds: 3600
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemoveFailedPods"
diff --git a/examples/high-node-utilization.yml b/examples/high-node-utilization.yml
index 972710d40..411be05be 100644
--- a/examples/high-node-utilization.yml
+++ b/examples/high-node-utilization.yml
@@ -1,9 +1,17 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "HighNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "HighNodeUtilization"
+ args:
thresholds:
"memory": 20
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "HighNodeUtilization"
diff --git a/examples/low-node-utilization.yml b/examples/low-node-utilization.yml
index 1ba9cc5e7..8d9e7221c 100644
--- a/examples/low-node-utilization.yml
+++ b/examples/low-node-utilization.yml
@@ -1,11 +1,19 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "LowNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "LowNodeUtilization"
+ args:
thresholds:
"memory": 20
targetThresholds:
"memory": 70
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "LowNodeUtilization"
diff --git a/examples/node-affinity.yml b/examples/node-affinity.yml
index c8421006d..1a1347e00 100644
--- a/examples/node-affinity.yml
+++ b/examples/node-affinity.yml
@@ -1,8 +1,17 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingNodeAffinity":
- enabled: true
- params:
- nodeAffinityType:
- - "requiredDuringSchedulingIgnoredDuringExecution"
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingNodeAffinity"
+ args:
+ nodeAffinityType:
+ - "requiredDuringSchedulingIgnoredDuringExecution"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsViolatingNodeAffinity"
diff --git a/examples/pod-life-time.yml b/examples/pod-life-time.yml
index 6b89ba0dd..86b255f90 100644
--- a/examples/pod-life-time.yml
+++ b/examples/pod-life-time.yml
@@ -1,11 +1,19 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "PodLifeTime":
- enabled: true
- params:
- podLifeTime:
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "PodLifeTime"
+ args:
maxPodLifeTimeSeconds: 604800 # 7 days
states:
- "Pending"
- "PodInitializing"
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "PodLifeTime"
diff --git a/examples/policy.yaml b/examples/policy.yaml
index 81f6ad970..23bebe751 100644
--- a/examples/policy.yaml
+++ b/examples/policy.yaml
@@ -1,29 +1,39 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemoveDuplicates":
- enabled: true
- "RemovePodsViolatingInterPodAntiAffinity":
- enabled: true
- "LowNodeUtilization":
- enabled: true
- params:
- nodeResourceUtilizationThresholds:
- thresholds:
- "cpu" : 20
- "memory": 20
- "pods": 20
- targetThresholds:
- "cpu" : 50
- "memory": 50
- "pods": 50
- "RemovePodsHavingTooManyRestarts":
- enabled: true
- params:
- podsHavingTooManyRestarts:
- podRestartThreshold: 100
- includingInitContainers: true
- "RemovePodsViolatingTopologySpreadConstraint":
- enabled: true
- params:
- includeSoftConstraints: true
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemoveDuplicates"
+ - name: "RemovePodsViolatingInterPodAntiAffinity"
+ - name: "LowNodeUtilization"
+ args:
+ thresholds:
+ "cpu" : 20
+ "memory": 20
+ "pods": 20
+ targetThresholds:
+ "cpu" : 50
+ "memory": 50
+ "pods": 50
+ - name: "RemovePodsHavingTooManyRestarts"
+ args:
+ podRestartThreshold: 100
+ includingInitContainers: true
+ - name: "RemovePodsViolatingTopologySpreadConstraint"
+ args:
+ includeSoftConstraints: true
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ deschedule:
+ enabled:
+ - "RemovePodsViolatingInterPodAntiAffinity"
+ - "RemovePodsHavingTooManyRestarts"
+ balance:
+ enabled:
+ - "RemoveDuplicates"
+ - "LowNodeUtilization"
+ - "RemovePodsViolatingTopologySpreadConstraint"
+
diff --git a/examples/topology-spread-constraint.yaml b/examples/topology-spread-constraint.yaml
index 687a3f379..ebbbca7da 100644
--- a/examples/topology-spread-constraint.yaml
+++ b/examples/topology-spread-constraint.yaml
@@ -1,8 +1,16 @@
-apiVersion: "descheduler/v1alpha1"
+apiVersion: "descheduler/v1alpha2"
kind: "DeschedulerPolicy"
-strategies:
- "RemovePodsViolatingTopologySpreadConstraint":
- enabled: true
- params:
- nodeFit: true
- includeSoftConstraints: true # Include 'ScheduleAnyways' constraints
+profiles:
+ - name: ProfileName
+ pluginConfig:
+ - name: "DefaultEvictor"
+ - name: "RemovePodsViolatingTopologySpreadConstraint"
+ args:
+ includeSoftConstraints: true # Include 'ScheduleAnyways' constraints
+ plugins:
+ evict:
+ enabled:
+ - "DefaultEvictor"
+ balance:
+ enabled:
+ - "RemovePodsViolatingTopologySpreadConstraint"
diff --git a/hack/update-toc.sh b/hack/update-toc.sh
deleted file mode 100755
index 2ce6d0815..000000000
--- a/hack/update-toc.sh
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/bin/bash
-
-# Copyright 2021 The Kubernetes Authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-source "$(dirname "${BASH_SOURCE}")/lib/init.sh"
-
-go build -o "${OS_OUTPUT_BINPATH}/mdtoc" "sigs.k8s.io/mdtoc"
-
-${OS_OUTPUT_BINPATH}/mdtoc --inplace README.md
diff --git a/hack/verify-toc.sh b/hack/verify-toc.sh
deleted file mode 100755
index 11371b02d..000000000
--- a/hack/verify-toc.sh
+++ /dev/null
@@ -1,29 +0,0 @@
-#!/bin/bash
-
-# Copyright 2021 The Kubernetes Authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-source "$(dirname "${BASH_SOURCE}")/lib/init.sh"
-
-go build -o "${OS_OUTPUT_BINPATH}/mdtoc" "sigs.k8s.io/mdtoc"
-
-if ! ${OS_OUTPUT_BINPATH}/mdtoc --inplace --dryrun README.md
-then
- echo "ERROR: Changes detected to table of contents. Run ./hack/update-toc.sh" >&2
- exit 1
-fi