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.

Sign up for GitHub

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

Jump to bottom

Add docs for pod integration #1103

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Add docs for pod integration #1103

merged 4 commits into from
Sep 29, 2023

Conversation

achernevskii
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Added documentation for pod integration.

Which issue(s) this PR fixes:

Related issue: #976

Special notes for your reviewer:

Does this PR introduce a user-facing change?

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 8, 2023
@netlify
Copy link

netlify bot commented Sep 8, 2023 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit d0b2efd
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6516fb9fe7c4b0000895d1a0
😎 Deploy Preview https://deploy-preview-1103--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 the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 8, 2023
@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 8, 2023
@alculquicondor
Copy link
Contributor

/ok-to-test

@k8s-ci-robot 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 Sep 8, 2023
@alculquicondor
Copy link
Contributor

Please change the target of the PR to the main branch. #1109

@alculquicondor
Copy link
Contributor

We changed the process here. Please rebase and target the main branch.

@alculquicondor
Copy link
Contributor

/release-note-none

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Sep 20, 2023
@alculquicondor alculquicondor changed the title Add docs for pod integration WIP Add docs for pod integration Sep 20, 2023
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 20, 2023
@achernevskii achernevskii changed the base branch from website-release-0.5 to main September 21, 2023 19:12
@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 Sep 27, 2023
tenzen-y
tenzen-y reviewed Sep 28, 2023
View reviewed changes
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.

@achernevskii Is this still WIP?

@achernevskii achernevskii changed the title WIP Add docs for pod integration Add docs for pod integration Sep 28, 2023
@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 Sep 28, 2023
@achernevskii
Copy link
Contributor Author

@achernevskii Is this still WIP?

Nope. Removed the WIP prefix

alculquicondor
alculquicondor reviewed Sep 28, 2023
View reviewed changes
site/content/en/docs/tasks/run_plain_pods.md
- key: kueue-job
operator: In
values: [ "true", "True", "yes" ]
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention that Pods that belong to some CRDs that we manage are excluded from being queued.

And that kueue adds a label to indicate which nodes are managed.

site/content/en/docs/tasks/run_plain_pods.md Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md
and enable the `pod` integration.

Example `integrations` section of manager configuration with enabled pod integration:
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

Add the top level fields, like kind

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I create a minimal working configuration, or just add some of the top level fields?

Should we do the same thing for the following pages?
run_mpijobs.md
run_jobsets.md

Copy link
Contributor

Choose a reason for hiding this comment

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

just the top level fields, to have a good context of where in the configuration integrations fit.

Yes, we should probably do the same for others. You can do that in a follow up.

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 example configuration in adfe10d

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

### c. Limitations

- A Kueue managed Pod cannot be created in `kube-system` or `kueue-system` namespaces.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention that preemption actually terminates and deletes the pod.

When mentioning preemption, link to the documentation related to it.

site/static/examples/pods-kueue/prios.yaml Outdated Show resolved Hide resolved
site/content/en/docs/tasks/run_plain_pods.md Show resolved Hide resolved
alculquicondor
alculquicondor reviewed Sep 29, 2023
View reviewed changes
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
alculquicondor
alculquicondor reviewed Sep 29, 2023
View reviewed changes
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

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: achernevskii, 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 29, 2023
@alculquicondor
Copy link
Contributor

/lgtm

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

LGTM label has been added.

Git tree hash: 686746bba80c6e095c95eb347ba271a5cc240ff2

@k8s-ci-robot k8s-ci-robot merged commit ab8924c into kubernetes-sigs:main Sep 29, 2023
@k8s-ci-robot k8s-ci-robot added this to the v0.5 milestone Sep 29, 2023
@achernevskii achernevskii mentioned this pull request Oct 26, 2023
Closed
9 tasks
@trasc trasc deleted the doc/pod_support branch March 12, 2024 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tenzen-y tenzen-y tenzen-y left review comments

@alculquicondor alculquicondor alculquicondor left review comments

@ArangoGutierrez ArangoGutierrez Awaiting requested review from ArangoGutierrez

@denkensk denkensk Awaiting requested review from denkensk

Assignees

@alculquicondor alculquicondor

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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
Milestone
v0.5
Development

Successfully merging this pull request may close these issues.
4 participants
@achernevskii @k8s-ci-robot @alculquicondor @tenzen-y