v1alpha2 docs (#1049)

* v1alph2 docs

* remove internal toc (gh has this natively)

* fix typo and newlines

* name plugins with less confusing names

* add type column

* fix kv selector and nodeSelector desc

* group plugin types in a table

* link the deprecated doc

* warning signs

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"

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"

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"

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"

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"

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"
+

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"