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

Document labels, annotations and taints for JobSet #49217

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document labels, annotations and taints for JobSet #49217

wants to merge 2 commits into from
+105 −0

Conversation

ahg-g
Copy link
Member

@ahg-g ahg-g commented Dec 23, 2024

This is a followup to #47383

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language labels Dec 23, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 23, 2024
@ahg-g ahg-g mentioned this pull request Dec 23, 2024
Open
@ahg-g
Copy link
Member Author

ahg-g commented Dec 23, 2024

/assign @sftim

sftim
sftim reviewed Dec 23, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks.

One mistake, but even so
/lgtm

content/en/docs/reference/labels-annotations-taints/_index.md
placement per topology group. You can also define this label or annotation on a replicated job
template. Read the documentation for JobSet to learn more.

### alpha.jobset.sigs.k8s.io/node-selector
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we can mark this deprecated (it should be), but: can wait for a follow up PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

we will deprecate when we graduate to stable

content/en/docs/reference/labels-annotations-taints/_index.md
The JobSet controller sets this label (and also an annotation with the same key) on child Jobs and
Pods of a JobSet. The value is the SHA256 hash of the namespaced Job name.

### alpha.jobset.sigs.k8s.io/exclusive-topology
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we can mark this deprecated (it should be), but: can wait for a follow up PR.

content/en/docs/reference/labels-annotations-taints/_index.md

The JobSet controller adds this label/annotation to Jobs and Pods that are part of a JobSet. It stores the namespaced Job name, which is used for logging and event management within the JobSet context.

### alpha.jobset.sigs.k8s.io/no-schedule
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we can mark this deprecated (it should be), but: can wait for a follow up PR.

content/en/docs/reference/labels-annotations-taints/_index.md

This label/annotation can be applied to a JobSet. When it's set, the JobSet controller modifies the Jobs and their corresponding Pods by adding node selectors. This ensures exclusive job placement per topology domain, restricting the scheduling of these Pods to specific nodes based on the strategy.

### alpha.jobset.sigs.k8s.io/namespaced-job
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we can mark this deprecated (it should be), but: can wait for a follow up PR.

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: c147a634d16794eb5b6e45ad418f3fcc4f456c53

@netlify Netlify
Copy link

netlify bot commented Dec 23, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit a94c5e7
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6769a776c664ce0008aff99f
😎 Deploy Preview https://deploy-preview-49217--kubernetes-io-main-staging.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.

@kannon92
Copy link
Contributor

LGTM from jobset side.

@ahg-g
Copy link
Member Author

ahg-g commented Dec 23, 2024

Thanks @sftim for the review? who can approve this?

@sftim
Copy link
Contributor

sftim commented Dec 23, 2024

This represents a change to the live site. If this gets formal LGTM (ie, use the /lgtm Prow command) or formal approval from someone other than me, I can approve it.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2024
@k8s-ci-robot k8s-ci-robot requested a review from sftim December 23, 2024 17:50
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@sftim
Copy link
Contributor

sftim commented Dec 23, 2024 •
edited
Loading

c68175e doesn't make sense to me @ahg-g. It's a label, and it both is and isn't an annotation? It's used on Nodes, but it's also used on Jobs and Pods but not Nodes? Clarify if you can.

See the force push diff for a clearer view on this.

@ahg-g ahg-g force-pushed the jobset branch 2 times, most recently from bb62bef to 04fb6be Compare December 23, 2024 18:08
@sftim
Copy link
Contributor

sftim commented Dec 23, 2024

/lgtm

There is clearly more to fix; we can address that in a follow-up good-first-issue (we actually really like good first issues!)

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

LGTM label has been added.

Git tree hash: 9d45544f1ac8686deff047d975875ec39253eedc

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2024
@ahg-g
Copy link
Member Author

ahg-g commented Dec 23, 2024 •
edited
Loading

/lgtm

There is clearly more to fix; we can address that in a follow-up good-first-issue (we actually really like good first issues!)

Fixed the wording, can you approve this too?

@sftim
Copy link
Contributor

sftim commented Dec 23, 2024

It's still a change to the live site. By convention, we get two reviews on these unless they are tiny @ahg-g. Do you know any Kubernetes contributors who can provide the other review?

@ahg-g
Copy link
Member Author

ahg-g commented Dec 23, 2024

@kannon92 just lgtmed above; or do we need a docs owner to review?

@sftim
Copy link
Contributor

sftim commented Dec 27, 2024

This represents a change to the live site. If this gets formal LGTM (ie, use the /lgtm Prow command) or formal approval from someone other than me, I can approve it.

If I add the formal LGTM, then by convention I should not also approve it.

@kannon92
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 Dec 27, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: b7cdd44076055a0375903544499ddc3a76b01ffa

@kannon92
Copy link
Contributor

@sftim can you approve now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natalisucks natalisucks Awaiting requested review from natalisucks

@reylejano reylejano Awaiting requested review from reylejano

@sftim sftim Awaiting requested review from sftim

Assignees

@kannon92 kannon92

@sftim sftim

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ahg-g @k8s-ci-robot @kannon92 @sftim