Skip to content

Commit

Permalink
WaitForPodsReady: Add documentation for the backoffMaxSeconds (#2327)
Browse files Browse the repository at this point in the history
Signed-off-by: Yuki Iwai <[email protected]>
  • Loading branch information
tenzen-y authored May 31, 2024
1 parent 571a848 commit 0584b86
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions site/content/en/docs/tasks/manage/setup_sequential_admission.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ fields:
timestamp: Eviction | Creation
backoffLimitCount: 5
backoffBaseSeconds: 60
backoffMaxSeconds: 3600
```
{{% alert title="Note" color="primary" %}}
Expand Down Expand Up @@ -75,11 +76,17 @@ When the `blockAdmission` is set to `true`, admitted Workload with not ready pod

### Requeuing Strategy
{{% alert title="Warning" color="warning" %}}
_Available in Kueue v0.6.0 and later_
Available in Kueue v0.6.0 and later
{{% /alert %}}
{{% alert title="Note" color="primary" %}}
The `backoffBaseSeconds` and `backodMaxSeconds` are available in Kueue v0.7.0 and later
{{% /alert %}}

The `requeuingStrategy` (`waitForPodsReady.requeuingStrategy`) contains optional parameters:
`timestamp` (`waitForPodsReady.requeuingStrategy.timestamp`) and `backoffLimitCount` (`waitForPodsReady.requeuingStrategy.backoffLimitCount`).
- `timestamp`
- `backoffLimitCount`
- `backoffBaseSeconds`
- `backoffMaxSeconds`

The `timestamp` field defines which timestamp Kueue uses to order the Workloads in the queue:

Expand All @@ -94,13 +101,13 @@ If you don't specify any value for `backoffLimitCount`,
a Workload is repeatedly and endlessly re-queued to the queue based on the `timestamp`.
Once the number of re-queues reaches the limit, Kueue [deactivates the Workload](/docs/concepts/workload/#active).

{{% alert title="Note" color="primary" %}}
_The `backoffBaseSeconds` is available in Kueue v0.7.0 and later_
{{% /alert %}}
The time to re-queue a workload after each consecutive timeout is increased
exponentially, with the exponent of 2. The first delay is determined by the
`backoffBaseSeconds` parameter (defaulting to 60). So, after the consecutive timeouts
the evicted workload is re-queued after approximately `60, 120, 240, ...` seconds.
`backoffBaseSeconds` parameter (defaulting to 60). You can configure the maximum
backoff time by setting the `backoffMaxSeconds` (defaulting to 3600). Using the defaults, the
evicted workload is re-queued after approximately `60, 120, 240, ..., 3600, ..., 3600` seconds.
Even if the backoff time reaches the `backoffMaxSeconds`, Kueue will continue to re-queue an evicted Workload with the `backoffMaxSeconds`
until the number of re-queue reaches the `backoffLimitCount`.

## Example

Expand Down

0 comments on commit 0584b86

Please sign in to comment.