Clean up “Non-preempting PriorityClasses” page section (#19273)

* Use feature state for non-preempting PriorityClasses

* PreemptionPolicy requires NonPreemptingPriority feature gate

* Remove alpha qualifier from section title and decrease example heading level

* Use singular of PriorityClass in the heading
This commit is contained in:
Thibault Deutsch
2020-03-01 07:08:41 +00:00
committed by GitHub
parent 10d195690d
commit f9fccfe338
@@ -158,12 +158,9 @@ globalDefault: false
description: "This priority class should be used for XYZ service pods only." description: "This priority class should be used for XYZ service pods only."
``` ```
### Non-preempting PriorityClasses (alpha) {#non-preempting-priority-class} ## Non-preempting PriorityClass {#non-preempting-priority-class}
1.15 adds the `PreemptionPolicy` field as an alpha feature. {{< feature-state for_k8s_version="1.15" state="alpha" >}}
It is disabled by default in 1.15,
and requires the `NonPreemptingPriority`[feature gate](/docs/reference/command-line-tools-reference/feature-gates/
) to be enabled.
Pods with `PreemptionPolicy: Never` will be placed in the scheduling queue Pods with `PreemptionPolicy: Never` will be placed in the scheduling queue
ahead of lower-priority pods, ahead of lower-priority pods,
@@ -187,6 +184,10 @@ which will allow pods of that PriorityClass to preempt lower-priority pods
If `PreemptionPolicy` is set to `Never`, If `PreemptionPolicy` is set to `Never`,
pods in that PriorityClass will be non-preempting. pods in that PriorityClass will be non-preempting.
The use of the `PreemptionPolicy` field requires the `NonPreemptingPriority`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
to be enabled.
An example use case is for data science workloads. An example use case is for data science workloads.
A user may submit a job that they want to be prioritized above other workloads, A user may submit a job that they want to be prioritized above other workloads,
but do not wish to discard existing work by preempting running pods. but do not wish to discard existing work by preempting running pods.
@@ -194,7 +195,7 @@ The high priority job with `PreemptionPolicy: Never` will be scheduled
ahead of other queued pods, ahead of other queued pods,
as soon as sufficient cluster resources "naturally" become free. as soon as sufficient cluster resources "naturally" become free.
#### Example Non-preempting PriorityClass ### Example Non-preempting PriorityClass
```yaml ```yaml
apiVersion: scheduling.k8s.io/v1 apiVersion: scheduling.k8s.io/v1