Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WaitForPodsReady: Add documentation for the backoffMaxSeconds #2327

Merged

Conversation

tenzen-y
Copy link
Member

@tenzen-y tenzen-y commented May 30, 2024

What type of PR is this?

/kind documentation

What this PR does / why we need it:

We don't have any documentation about #2264.

Which issue(s) this PR fixes:

Part-of #2216

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 30, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tenzen-y

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 30, 2024
Copy link

netlify bot commented May 30, 2024

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit b7a4e83
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6659f4a4cd8547000884d562
😎 Deploy Preview https://deploy-preview-2327--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@tenzen-y tenzen-y mentioned this pull request May 30, 2024
26 tasks
@tenzen-y
Copy link
Member Author

/assign @alculquicondor

@@ -77,9 +78,15 @@ When the `blockAdmission` is set to `true`, admitted Workload with not ready pod
{{% alert title="Warning" color="warning" %}}
_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_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_The `backoffBaseSeconds` and `backodMaxSeconds` are available in Kueue v0.7.0 and later_
The `backoffBaseSeconds` and `backodMaxSeconds` are available in Kueue v0.7.0 and later

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines 86 to 89
- `timestamp` (`waitForPodsReady.requeuingStrategy.timestamp`)
- `backoffLimitCount` (`waitForPodsReady.requeuingStrategy.backoffLimitCount`)
- `backoffBaseSeconds` (`waitForPodsReady.requeuingStrategy.backoffBaseSeconds`)
- `backoffMaxSeconds` (`waitForPodsReady.requeuingStrategy.backoffMaxSeconds`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `timestamp` (`waitForPodsReady.requeuingStrategy.timestamp`)
- `backoffLimitCount` (`waitForPodsReady.requeuingStrategy.backoffLimitCount`)
- `backoffBaseSeconds` (`waitForPodsReady.requeuingStrategy.backoffBaseSeconds`)
- `backoffMaxSeconds` (`waitForPodsReady.requeuingStrategy.backoffMaxSeconds`)
- `timestamp`
- `backoffLimitCount`
- `backoffBaseSeconds`
- `backoffMaxSeconds`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines 106 to 108
`backoffBaseSeconds` parameter (defaulting to 60). So, after the consecutive timeouts
the evicted workload is re-queued after approximately `60, 120, 240, ...` seconds.
the evicted workload is re-queued after approximately `60, 120, 240, ..., 3600, 3600 ..., 3600` seconds
if you don't specify the maximum backoff time by the `backoffMaxSeconds` (defaulting to 3600).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`backoffBaseSeconds` parameter (defaulting to 60). You can configure the maximum
backoff time by setting `backoffMaxSeconds` (defaulting to 3600). Using the defaults, the
evicted workload is re-queued after approximately `60, 120, 240, ..., 3600, ..., 3600` seconds.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for great suggestion!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

the evicted workload is re-queued after approximately `60, 120, 240, ...` seconds.
the evicted workload is re-queued after approximately `60, 120, 240, ..., 3600, 3600 ..., 3600` seconds
if you don't specify the maximum backoff time by the `backoffMaxSeconds` (defaulting to 3600).
Even if the backoff time reaches the `backoffMaxSeconds`, Kueue will keep to re-queue an evicted Workload with the `backoffMaxSeconds`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Even if the backoff time reaches the `backoffMaxSeconds`, Kueue will keep to re-queue an evicted Workload with the `backoffMaxSeconds`
Even if the backoff time reaches the `backoffMaxSeconds`, Kueue will continue to re-queue an evicted Workload with the `backoffMaxSeconds`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
@tenzen-y tenzen-y force-pushed the add-back-off-max-seconds-docs branch from 702f9ff to b7a4e83 Compare May 31, 2024 16:02
@tenzen-y
Copy link
Member Author

@alculquicondor I addressed all comments. PTAL, thanks!

Copy link
Contributor

@alculquicondor alculquicondor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 31, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 54615eb5d71c5f90d13dd4a32e2dcd82d029ecc2

@k8s-ci-robot k8s-ci-robot merged commit 0584b86 into kubernetes-sigs:main May 31, 2024
6 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.7 milestone May 31, 2024
@tenzen-y tenzen-y deleted the add-back-off-max-seconds-docs branch May 31, 2024 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants