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

Extend documentation on pod group support [pod groups] #1684

Merged
merged 5 commits into from
Feb 9, 2024

Conversation

mimowo
Copy link
Contributor

@mimowo mimowo commented Feb 5, 2024

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

Part of #976

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. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. labels Feb 5, 2024
Copy link

netlify bot commented Feb 5, 2024

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit aa9fb10
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/65c5f6512795bc0008e1c113
😎 Deploy Preview https://deploy-preview-1684--kubernetes-sigs-kueue.netlify.app/docs/tasks/run_plain_pods
📱 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.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 5, 2024
@mimowo mimowo changed the title WIP: Extend documentation on pod group support [pod groups] Extend documentation on pod group support [pod groups] Feb 5, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 5, 2024
@mimowo
Copy link
Contributor Author

mimowo commented Feb 5, 2024

/assign @tenzen-y @alculquicondor

@yaroslava-serdiuk
Copy link
Contributor

lgtm

Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

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

Also, should we rephrase Line 97 with "Example single Pod"?

site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
Comment on lines 133 to 138
Note that, this design choice impacts the scenario of
[preemption](/docs/concepts/cluster_queue/#preemption).
When a workload represented by the pod group is preempted all of its pods
are killed by Kueue (by delete requests). However, later, when the workload is
re-admitted, Kueue will not re-create the terminated pods. This task is left to
the user (or the external controller).
Copy link
Member

Choose a reason for hiding this comment

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

Great note

site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
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.

I forgot to send my comments yesterday :(

site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
@mimowo mimowo force-pushed the pod-groups-docs branch 6 times, most recently from 466c735 to eee3acf Compare February 8, 2024 09:55
@k8s-ci-robot 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 Feb 8, 2024
mimowo and others added 2 commits February 8, 2024 11:25
Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

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

Otherwise, lgtm

/approve
leave lgtm on @alculquicondor

Comment on lines 142 to 143
**NOTE:** We recommend using the kubernetes Job API or similar CRDs such as
JobSet, MPIJob, RayJob, etc.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. PTAL.

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 8, 2024
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.

/approve
/hold for comments

site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
@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 Feb 8, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, mimowo, 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

@mimowo
Copy link
Contributor Author

mimowo commented Feb 9, 2024

/hold for comments

/hold cancel

Comments addressed, PTAL.

@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 Feb 9, 2024
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 Feb 9, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 17e670abb3552cbea3c6a5e1c15d760489a2c931

@k8s-ci-robot k8s-ci-robot merged commit 1296c45 into kubernetes-sigs:main Feb 9, 2024
14 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.6 milestone Feb 9, 2024
@mimowo mimowo deleted the pod-groups-docs branch February 10, 2024 11:47
kannon92 pushed a commit to openshift-kannon92/kubernetes-sigs-kueue that referenced this pull request Nov 19, 2024
…gs#1684)

* Extend documentation on pod group support

* Review remarks

Co-authored-by: Yuki Iwai <[email protected]>
Co-authored-by: Patryk Bundyra <[email protected]>

* Align casing of pods and pod groups for consistency

* review remarks

* Fix indentation

---------

Co-authored-by: Yuki Iwai <[email protected]>
Co-authored-by: Patryk Bundyra <[email protected]>
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants