-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Document labels, annotations and taints for JobSet #47383
Open
Adarsh-verma-14
wants to merge
6
commits into
kubernetes:main
Choose a base branch
from
Adarsh-verma-14:adding-labels-annotations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+102
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
099e386
adding labels and annotation for JobSet
Adarsh-verma-14 0d815b6
update description for labels/annotaionand taint also
Adarsh-verma-14 1be0ff2
update description for labels/annotaionan
Adarsh-verma-14 eabf9c1
update types and description for labels/annotation
Adarsh-verma-14 1fb8971
update some changes regarding ReplicatedJob
Adarsh-verma-14 d21c85e
Modified some sentence
Adarsh-verma-14 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -2332,6 +2332,108 @@ Starting in v1.16, this annotation was removed in favor of | |||||||||
[Pod Priority](/docs/concepts/scheduling-eviction/pod-priority-preemption/). | ||||||||||
{{< /note >}} | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/jobset-name | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/jobset-name: "my-jobset"` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
This label/annotation is used to store the name of the JobSet that a Job or Pod belongs to. | ||||||||||
[JobSet](https://jobset.sigs.k8s.io) is an extension API that you can deploy into your Kubernetes cluster. | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/replicatedjob-replicas | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/replicatedjob-replicas: "5"` | ||||||||||
|
||||||||||
Used on: ReplicatedJobs | ||||||||||
|
||||||||||
This label/annotation specifies the number of replicas for a ReplicatedJob. | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/replicatedjob-name | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/replicatedjob-name: "my-replicatedjob"` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of. | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/job-index | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/job-index: "0"` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
This label/annotation is set by the JobSet controller on child Jobs and Pods. It contains the index of the Job replica within its parent ReplicatedJob. | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/job-key | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/job-key=0f1e93893c4cb372080804ddb9153093cb0d20cefdd37f653e739c232d363feb` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
This label/annotation is set by the JobSet controller on child Jobs and Pods of a JobSet. The value will be the SHA256 hash of the namespaced Job name. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
### alpha.jobset.sigs.k8s.io/exclusive-topology | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `alpha.jobset.sigs.k8s.io/exclusive-topology: "zone"` | ||||||||||
|
||||||||||
Used on: JobSets, ReplicatedJobs | ||||||||||
|
||||||||||
You can set this label/annotation on a [JobSet](https://jobset.sigs.k8s.io) or a ReplicatedJob template to ensure exclusive job placement per topology group. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
### alpha.jobset.sigs.k8s.io/node-selector | ||||||||||
|
||||||||||
Type: Label, Annotation | ||||||||||
|
||||||||||
Example: `alpha.jobset.sigs.k8s.io/node-selector-strategy=true` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
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 | ||||||||||
|
||||||||||
Type: Annotation, Label | ||||||||||
|
||||||||||
Example: `alpha.jobset.sigs.k8s.io/default_myjobset-replicatedjob-0` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
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 | ||||||||||
|
||||||||||
Type: Taint | ||||||||||
|
||||||||||
Example: `alpha.jobset.sigs.k8s.io/no-schedule: NoSchedule` | ||||||||||
|
||||||||||
Used on: Nodes | ||||||||||
|
||||||||||
The [JobSet](https://jobset.sigs.k8s.io) controller uses this taint to support its node labeling exclusive placement strategy. | ||||||||||
|
||||||||||
### jobset.sigs.k8s.io/coordinator | ||||||||||
|
||||||||||
Type: Annotation, Label | ||||||||||
Adarsh-verma-14 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
Example: `jobset.sigs.k8s.io/coordinator: "myjobset-workers-0-0.headless-svc"` | ||||||||||
|
||||||||||
Used on: Jobs, Pods | ||||||||||
|
||||||||||
This annotation/label is used on Jobs and Pods to store a stable network endpoint where the coordinator | ||||||||||
pod can be reached if the [JobSet](https://jobset.sigs.k8s.io) spec defines the `.spec.coordinator` field. | ||||||||||
|
||||||||||
## Annotations used for audit | ||||||||||
|
||||||||||
<!-- sorted by annotation --> | ||||||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.