Skip to content

Commit ba05f7a

Browse files
committed
add a doc for QueueingHint
1 parent c5a035c commit ba05f7a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

content/en/docs/concepts/scheduling-eviction/scheduling-framework.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,25 @@ This is an informational extension point. Post-bind plugins are called after a
222222
Pod is successfully bound. This is the end of a binding cycle, and can be used
223223
to clean up associated resources.
224224

225+
### EnqueueExtension
226+
227+
EnqueueExtension is the interface where the plugin can have control how the scheduling of Pods rejected by this plugin are retried.
228+
PreEnqueue, PreFilter, Filter, Reserve and Permit plugins are supposed to implement this interface.
229+
230+
{{< feature-state for_k8s_version="v1.28" state="beta" >}}
231+
232+
QueueingHint is a part of EnqueueExtension.
233+
It's callback functions to decide if a Pod can be requeued to activeQ/backoffQ.
234+
It's executed every time certain kind of events happens,
235+
and when the QueueingHint finds that the event might make the Pod schedulable,
236+
the scheduling queue requeues the Pod into activeQ/backoffQ so that the scheduler will retry the scheduling of the Pod.
237+
238+
{{< note >}}
239+
QueueingHint is a beta-level field and enabled by default in 1.28.
240+
You can disable it via the
241+
`SchedulerQueueingHints` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/).
242+
{{< /note >}}
243+
225244
## Plugin API
226245

227246
There are two steps to the plugin API. First, plugins must register and get

0 commit comments

Comments
 (0)