add docs for workloadPriority #1170

Gekko0114 · 2023-10-01T14:42:42Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

add docs for workloadPriority

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

NONE

netlify · 2023-10-01T14:42:48Z

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name	Link
🔨 Latest commit	`05c2f0f`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6523e5c76d379100086cd425
😎 Deploy Preview	https://deploy-preview-1170--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

k8s-ci-robot · 2023-10-01T14:42:51Z

Hi @Gekko0114. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Gekko0114 · 2023-10-01T14:46:38Z

Hi @alculquicondor , @tenzen-y ,
Could you review this PR? Thanks,

Gekko0114 · 2023-10-01T14:48:13Z

/assign @alculquicondor
/assign @tenzen-y

tenzen-y

Also, can you add a concept for the WorkloadPriority to https://github.com/kubernetes-sigs/kueue/tree/f6d9f1e7c4efefba1d67825c2b80e73a17840bdf/site/content/en/docs/concepts?

site/content/en/docs/tasks/_index.md

tenzen-y · 2023-10-03T05:45:09Z

/ok-to-test

Gekko0114 · 2023-10-03T15:00:28Z

Also, can you add a concept for the WorkloadPriority to https://github.com/kubernetes-sigs/kueue/tree/f6d9f1e7c4efefba1d67825c2b80e73a17840bdf/site/content/en/docs/concepts?

Sure, added a concept.

tenzen-y · 2023-10-05T10:27:16Z

site/content/en/docs/concepts/workload.md

@@ -103,4 +103,5 @@ creating a corresponding Workload object for it.



Can you update the Priority section in this file as well?

site/content/en/docs/concepts/workload_priority_class.md

tenzen-y · 2023-10-05T10:54:54Z

site/content/en/docs/concepts/workload_priority_class.md

+About #1's scenario, the `workloadPriorityClass` is used for the `workload's priority`. On the other hand, the `priorityClass` is used for the `pod's priority`.  
+About #2's scenario, the `workloadPriorityClass` is used for the `workload's priority`. On the other hand, `workloadPriorityClass` is not used for `pod's priority`.  
+About #3' scenario,  the `PriorityClass` is used for the `workload's priority` and `pod's priority`. 
+


Also, it would be better to explain what happens if the job implement the JobWithPriorityClass interface.

@tenzen-y this might be too developer focused and a user cannot do too much about it.

I was also concerned about what you say. However, actually, which priorities are used depends on the interface.
For example, we can set three priorities (.spec.runPolicy.priorityClass, .spec.labels.kueue.x-k8s.io/priority-class, and .spec.mpiReplicaSecs[*].template.spec.priorityClassName) on the MPIJob.

Or, instead of mentioning the interface, raise MPIJob as a specific case.

@alculquicondor Any better ideas?

Thanks for your comments! Added the explanation related to JobWithPriorityClass

I like how Hiroyuki phrased it :)

site/content/en/docs/tasks/run_job_with_workload_priority.md

tenzen-y · 2023-10-05T11:05:39Z

/assign @trasc

keps/973-workload-priority/README.md

site/content/en/docs/concepts/workload_priority_class.md

trasc · 2023-10-05T12:05:16Z

site/content/en/docs/concepts/workload_priority_class.md

+About #1's scenario, the `workloadPriorityClass` is used for the `workload's priority`. On the other hand, the `priorityClass` is used for the `pod's priority`.  
+About #2's scenario, the `workloadPriorityClass` is used for the `workload's priority`. On the other hand, `workloadPriorityClass` is not used for `pod's priority`.  
+About #3' scenario,  the `PriorityClass` is used for the `workload's priority` and `pod's priority`. 
+


@tenzen-y this might be too developer focused and a user cannot do too much about it.

site/content/en/docs/tasks/_index.md

trasc · 2023-10-05T12:15:04Z

site/content/en/docs/concepts/workload_priority_class.md

+
+## Workload's priority values are always mutable
+
+Workload's `Priority` field is always mutable because it might be useful for the preemption.  


Is this something relevant for a user?

I think so, I added an example

site/content/en/docs/concepts/workload_priority_class.md

site/content/en/docs/tasks/run_job_with_workload_priority.md

site/content/en/docs/concepts/_index.md

site/content/en/docs/concepts/workload.md

site/content/en/docs/concepts/workload_priority_class.md

site/content/en/docs/tasks/run_job_with_workload_priority.md

tenzen-y

lgtm
leaving /lgtm on @alculquicondor

site/content/en/docs/concepts/workload_priority_class.md

trasc

/lgtm

k8s-ci-robot · 2023-10-09T12:21:59Z

LGTM label has been added.

Git tree hash: 4549ab081455effaaa613e8f0078acc81f21fe52

alculquicondor · 2023-10-10T18:41:12Z

site/content/en/docs/concepts/workload_priority_class.md

+By default kueue will take the PriorityClassName of the first PodSet having one set,
+however the integration of the CRD with Kueue can implement
+[`JobWithPriorityClass interface`](https://github.com/kubernetes-sigs/kueue/blob/e162f8508b503d20feb9b31fd0b27d91e58f2c2f/pkg/controller/jobframework/interface.go#L81-L84)
+to change this behavior. You can read the code for each job integration


I guess that's what we have today :(

If you have the time, please update the documentation for MPIJob and other kubeflow CRDs to explain how we obtain the priority class for each.

alculquicondor

/approve

k8s-ci-robot · 2023-10-10T18:41:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, Gekko0114

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:

~~OWNERS~~ [alculquicondor]

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 added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Oct 1, 2023

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 1, 2023

k8s-ci-robot requested review from ArangoGutierrez and kerthcet October 1, 2023 14:42

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 1, 2023

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 1, 2023

k8s-ci-robot assigned alculquicondor and tenzen-y Oct 1, 2023

Gekko0114 mentioned this pull request Oct 2, 2023

REQUEST: New membership for Gekko0114 kubernetes/org#4496

Closed

9 tasks

tenzen-y reviewed Oct 3, 2023

View reviewed changes

site/content/en/docs/tasks/_index.md Outdated Show resolved Hide resolved

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 3, 2023

Gekko0114 force-pushed the priority_doc branch from 8d6848c to 25e107f Compare October 3, 2023 14:59

k8s-ci-robot added 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 Oct 3, 2023

tenzen-y reviewed Oct 5, 2023

View reviewed changes

k8s-ci-robot assigned trasc Oct 5, 2023

trasc reviewed Oct 5, 2023

View reviewed changes

Gekko0114 force-pushed the priority_doc branch 4 times, most recently from 8734ffb to 53d961f Compare October 5, 2023 15:26

Gekko0114 force-pushed the priority_doc branch from 53d961f to 4d91beb Compare October 6, 2023 13:05

alculquicondor reviewed Oct 6, 2023

View reviewed changes

Gekko0114 force-pushed the priority_doc branch 2 times, most recently from 58dde38 to 6822fd7 Compare October 7, 2023 07:20

tenzen-y reviewed Oct 9, 2023

View reviewed changes

trasc reviewed Oct 9, 2023

View reviewed changes

site/content/en/docs/concepts/workload_priority_class.md Outdated Show resolved Hide resolved

site/content/en/docs/concepts/workload_priority_class.md Outdated Show resolved Hide resolved

add docs for workloadPriority

05c2f0f

Gekko0114 force-pushed the priority_doc branch from 6822fd7 to 05c2f0f Compare October 9, 2023 11:36

trasc reviewed Oct 9, 2023

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 9, 2023

alculquicondor reviewed Oct 10, 2023

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 10, 2023

k8s-ci-robot merged commit 71a2ac5 into kubernetes-sigs:main Oct 10, 2023
3 checks passed

k8s-ci-robot added this to the v0.5 milestone Oct 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add docs for workloadPriority #1170

add docs for workloadPriority #1170

Gekko0114 commented Oct 1, 2023

netlify bot commented Oct 1, 2023 •

edited

Loading

k8s-ci-robot commented Oct 1, 2023

Gekko0114 commented Oct 1, 2023 •

edited

Loading

Gekko0114 commented Oct 1, 2023

tenzen-y left a comment

tenzen-y commented Oct 3, 2023

Gekko0114 commented Oct 3, 2023

tenzen-y Oct 5, 2023

Gekko0114 Oct 5, 2023

tenzen-y Oct 5, 2023

trasc Oct 5, 2023

tenzen-y Oct 5, 2023

tenzen-y Oct 5, 2023

Gekko0114 Oct 6, 2023

alculquicondor Oct 6, 2023

tenzen-y commented Oct 5, 2023

trasc Oct 5, 2023

trasc Oct 5, 2023

Gekko0114 Oct 5, 2023

tenzen-y left a comment

trasc left a comment

k8s-ci-robot commented Oct 9, 2023

alculquicondor Oct 10, 2023

alculquicondor left a comment

k8s-ci-robot commented Oct 10, 2023

		@@ -103,4 +103,5 @@ creating a corresponding Workload object for it.


		## Workload's priority values are always mutable

		Workload's `Priority` field is always mutable because it might be useful for the preemption.

add docs for workloadPriority #1170

add docs for workloadPriority #1170

Conversation

Gekko0114 commented Oct 1, 2023

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

netlify bot commented Oct 1, 2023 • edited Loading

✅ Deploy Preview for kubernetes-sigs-kueue ready!

k8s-ci-robot commented Oct 1, 2023

Gekko0114 commented Oct 1, 2023 • edited Loading

Gekko0114 commented Oct 1, 2023

tenzen-y left a comment

Choose a reason for hiding this comment

tenzen-y commented Oct 3, 2023

Gekko0114 commented Oct 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tenzen-y commented Oct 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tenzen-y left a comment

Choose a reason for hiding this comment

trasc left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 9, 2023

Choose a reason for hiding this comment

alculquicondor left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 10, 2023

netlify bot commented Oct 1, 2023 •

edited

Loading

Gekko0114 commented Oct 1, 2023 •

edited

Loading