diff --git a/README.md b/README.md index 9ab477140..9d4236ac7 100644 --- a/README.md +++ b/README.md @@ -118,14 +118,15 @@ The Descheduler Policy is configurable and includes default strategy plugins tha 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) | -| `maxNoOfPodsToEvictTotal` |`int`| `nil` | maximum number of pods evicted per rescheduling cycle (summed through all strategies) | -| `metricsCollector` |`object`| `nil` | configures collection of metrics for actual resource utilization | -| `metricsCollector.enabled` |`bool`| `false` | enables kubernetes [metrics server](https://kubernetes-sigs.github.io/metrics-server/) collection | +| 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). | +| `maxNoOfPodsToEvictTotal` | `int` | `nil` | Maximum number of pods evicted per rescheduling cycle (summed through all strategies). | +| `metricsCollector` | `object` | `nil` | Configures collection of metrics for actual resource utilization. | +| `metricsCollector.enabled` | `bool` | `false` | Enables Kubernetes [Metrics Server](https://kubernetes-sigs.github.io/metrics-server/) collection. | +| `evictionFailureEventNotification` | `bool` | `false` | Enables eviction failure event notification. | ### Evictor Plugin configuration (Default Evictor) diff --git a/pkg/api/v1alpha2/types.go b/pkg/api/v1alpha2/types.go index 67d4845f5..533d7792c 100644 --- a/pkg/api/v1alpha2/types.go +++ b/pkg/api/v1alpha2/types.go @@ -43,7 +43,7 @@ type DeschedulerPolicy struct { // EvictionFailureEventNotification should be set to true to enable eviction failure event notification. // Default is false. - EvictionFailureEventNotification *bool + EvictionFailureEventNotification *bool `json:"evictionFailureEventNotification,omitempty"` // MetricsCollector configures collection of metrics for actual resource utilization MetricsCollector MetricsCollector `json:"metricsCollector,omitempty"`