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

Add documentation for preemption #618

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

alculquicondor
Copy link
Contributor

@alculquicondor alculquicondor commented Mar 8, 2023

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Follow up to #514

Which issue(s) this PR fixes:

Fixes #576

Special notes for your reviewer:

I'm using v1beta1 in this PR, but updates to the rest of the documentation will come in a separate PR.

Change-Id: I75cb8023e75f22c44c8271be52033c0d41026666
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 8, 2023
@netlify
Copy link

netlify bot commented Mar 8, 2023

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit 5db1f31
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6408ea332eeffe0007f72467
😎 Deploy Preview https://deploy-preview-618--kubernetes-sigs-kueue.netlify.app/docs/concepts/cluster_queue
📱 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 settings.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor

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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 8, 2023
@tenzen-y
Copy link
Member

tenzen-y commented Mar 8, 2023

Fixes #576

Copy link
Contributor

@cortespao cortespao left a comment

Choose a reason for hiding this comment

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

Just adding some suggestions.

Comment on lines 282 to 283
Workloads from other ClusterQueues in the cohort that are using more than
their nominal quota. Possible values are:
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
Workloads from other ClusterQueues in the cohort that are using more than
their nominal quota. Possible values are:
Workloads from other ClusterQueues that are using more than
their nominal quota in the cohort. The possible values are:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why move "in the cohort"? The ClusterQueues belong to the cohort.

Changed the other part.

- `LowerPriority`: if the pending workload fits within the nominal
quota of its ClusterQueue, only preempt workloads in the cohort that have
lower priority than the pending Workload.
- `Any`: if the pending workload fits within the nominal quota of its
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
- `Any`: if the pending workload fits within the nominal quota of its
- `Any`: if the pending Workload fits within the nominal quota of its

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


Note that an incoming Workload can preempt Workloads both within the
ClusterQueue and the cohort. Kueue implements heuristics to preempt as few
Workloads as possible, prefering Workloads with these characteristics:
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
Workloads as possible, prefering Workloads with these characteristics:
Workloads as possible, prioritizing Workloads with these characteristics:

If you decide to keep preferring, fix the typo :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😂 thanks
I kept the word "preferring". I think "prioritizing" can be confusing given that we talk about priority below.

Change-Id: Ia1cbb44c348624cb348c640540cdadaaba2f301a
Copy link
Contributor Author

@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.

/label tide/merge-method-squash

Comment on lines 282 to 283
Workloads from other ClusterQueues in the cohort that are using more than
their nominal quota. Possible values are:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why move "in the cohort"? The ClusterQueues belong to the cohort.

Changed the other part.

- `LowerPriority`: if the pending workload fits within the nominal
quota of its ClusterQueue, only preempt workloads in the cohort that have
lower priority than the pending Workload.
- `Any`: if the pending workload fits within the nominal quota of its
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


Note that an incoming Workload can preempt Workloads both within the
ClusterQueue and the cohort. Kueue implements heuristics to preempt as few
Workloads as possible, prefering Workloads with these characteristics:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

😂 thanks
I kept the word "preferring". I think "prioritizing" can be confusing given that we talk about priority below.

@k8s-ci-robot k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 8, 2023
@kerthcet
Copy link
Contributor

kerthcet commented Mar 9, 2023

/lgtm
/hold
In case of other advices.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 9, 2023
@alculquicondor
Copy link
Contributor Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023
@k8s-ci-robot k8s-ci-robot merged commit 11a1bd7 into kubernetes-sigs:main Mar 9, 2023
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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for ClusterQueuePreemption
5 participants