Skip to content

Commit e085610

Browse files
authored
Merge pull request #1578 from googs1025/readme/update
chore: update README.md for DeschedulerPolicy
2 parents fc48403 + 03246d6 commit e085610

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,15 @@ The Descheduler Policy is configurable and includes default strategy plugins tha
118118

119119
These are top level keys in the Descheduler Policy that you can use to configure all evictions.
120120

121-
| Name |type| Default Value | Description |
122-
|------|----|---------------|-------------|
123-
| `nodeSelector` |`string`| `nil` | limiting the nodes which are processed. Only used when `nodeFit`=`true` and only by the PreEvictionFilter Extension Point |
124-
| `maxNoOfPodsToEvictPerNode` |`int`| `nil` | maximum number of pods evicted from each node (summed through all strategies) |
125-
| `maxNoOfPodsToEvictPerNamespace` |`int`| `nil` | maximum number of pods evicted from each namespace (summed through all strategies) |
126-
| `maxNoOfPodsToEvictTotal` |`int`| `nil` | maximum number of pods evicted per rescheduling cycle (summed through all strategies) |
127-
| `metricsCollector` |`object`| `nil` | configures collection of metrics for actual resource utilization |
128-
| `metricsCollector.enabled` |`bool`| `false` | enables kubernetes [metrics server](https://kubernetes-sigs.github.io/metrics-server/) collection |
121+
| Name | type | Default Value | Description |
122+
|------------------------------------|--------|---------------|----------------------------------------------------------------------------------------------------------------------------|
123+
| `nodeSelector` | `string` | `nil` | Limiting the nodes which are processed. Only used when `nodeFit`=`true` and only by the PreEvictionFilter Extension Point. |
124+
| `maxNoOfPodsToEvictPerNode` | `int` | `nil` | Maximum number of pods evicted from each node (summed through all strategies). |
125+
| `maxNoOfPodsToEvictPerNamespace` | `int` | `nil` | Maximum number of pods evicted from each namespace (summed through all strategies). |
126+
| `maxNoOfPodsToEvictTotal` | `int` | `nil` | Maximum number of pods evicted per rescheduling cycle (summed through all strategies). |
127+
| `metricsCollector` | `object` | `nil` | Configures collection of metrics for actual resource utilization. |
128+
| `metricsCollector.enabled` | `bool` | `false` | Enables Kubernetes [Metrics Server](https://kubernetes-sigs.github.io/metrics-server/) collection. |
129+
| `evictionFailureEventNotification` | `bool` | `false` | Enables eviction failure event notification. |
129130

130131
### Evictor Plugin configuration (Default Evictor)
131132

pkg/api/v1alpha2/types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ type DeschedulerPolicy struct {
4343

4444
// EvictionFailureEventNotification should be set to true to enable eviction failure event notification.
4545
// Default is false.
46-
EvictionFailureEventNotification *bool
46+
EvictionFailureEventNotification *bool `json:"evictionFailureEventNotification,omitempty"`
4747

4848
// MetricsCollector configures collection of metrics for actual resource utilization
4949
MetricsCollector MetricsCollector `json:"metricsCollector,omitempty"`

0 commit comments

Comments
 (0)