Document labels, annotations and taints for JobSet #47383

Adarsh-verma-14 · 2024-08-07T17:11:44Z

Adding labels and annotation for JobSet in https://github.com/kubernetes/website/blob/main/content/en/docs/reference/labels-annotations-taints/_index.md

Fixes #47373

/language en

k8s-ci-robot · 2024-08-07T17:11:59Z

[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 assign divya-mohan0209 for approval. 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:

content/en/docs/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Adarsh-verma-14 · 2024-08-07T17:14:41Z

Hi @sftim ,could you review on these changes if anythings need to change let me know .

netlify · 2024-08-07T17:19:44Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`d21c85e`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66f907bb451f1900080cd109
😎 Deploy Preview	https://deploy-preview-47383--kubernetes-io-main-staging.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.

kannon92 · 2024-08-08T16:03:22Z

cc @ahg-g @danielvegamyhre

kannon92 · 2024-08-08T16:04:42Z

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

+
+This label provides a unique key for the job.
+
+### job-name


This is already defined as part of the job api labels/annotations.

sftim · 2024-08-08T16:07:57Z

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

+### job-name
+
+Type: Label
+
+Example: `job-name: "my-job"`
+
+Used on: Jobs
+
+This label stores the name of the job.


Suggested change

### job-name

Type: Label

Example: `job-name: "my-job"`

Used on: Jobs

This label stores the name of the job.

This is not in the namespace kubernetes.io or k8s.io, so we'd omit it.

I have removed it in case any need to change let me know.

sftim · 2024-08-08T16:09:14Z

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

+
+Used on: Jobs, Pods
+
+This label is used to store the name of the JobSet to which a job or pod belongs.


Suggested change

This label is used to store the name of the JobSet to which a job or pod belongs.

This label is used to store the name of the JobSet to which a Job or Pod belongs.

JobSet is an extension API that you can deploy into your Kubernetes cluster.

I have done this change as suggested.

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

sftim · 2024-08-08T16:09:47Z

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

+
+Used on: Jobs
+
+This label is used to index into a job's labels and retrieve the name of the parent ReplicatedJob.


Suggested change

This label is used to index into a job's labels and retrieve the name of the parent ReplicatedJob.

This label is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.

ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.

I have done this change as suggested

sftim · 2024-08-08T16:11:05Z

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

+
+Used on: Jobs
+
+ This annotation stores the index of the job within the ReplicatedJob.


Suggested change

This annotation stores the index of the job within the ReplicatedJob.

This annotation stores the index of the Job within the ReplicatedJob.

ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.

I have done this change as suggested

sftim · 2024-08-08T16:15:00Z

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

+
+Used on: JobSets, ReplicatedJobs
+
+ This annotation can be set on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.


Suggested change

This annotation can be set on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.

You can set this annotation on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.

JobSet and ReplicaSet are extension APIs that you can deploy into your Kubernetes cluster.

I have done this change as suggested.

sftim · 2024-08-08T16:15:42Z

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

+
+Used on: JobSets
+
+This annotation acts as a flag. When set, the JobSet controller injects nodeSelectors for the JobSetNameKey label to ensure exclusive job placement per topology.


What's a JobSetNameKey?

JobSetNameKey is the label key that identifies the JobSet to which a job belongs. Specifically, it is the label jobset.sigs.k8s.io/jobset-name.

I have update this if need to improvement let me know.

sftim · 2024-08-08T16:18:43Z

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

+### alpha.jobset.sigs.k8s.io/no-schedule
+
+Type: Annotation
+
+Example: `alpha.jobset.sigs.k8s.io/no-schedule: "true"`
+
+Used on: Jobs
+
+This annotation prevents the job from being scheduled.


I'm not sure this is right. You can suspend a Job or set scheduling gates on a Pod, but I don't see how or whether this annotation influences those things.

This is used as a taint for the node labeling exclusive placement strategy (link)

sftim · 2024-08-08T16:19:06Z

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

+
+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 spec defines the `.spec.coordinator` field.


Suggested change

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 spec defines the `.spec.coordinator` field.

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 spec defines the `.spec.coordinator` field.

JobSet is an extension API that you can deploy into your Kubernetes cluster.

I have done this change as suggested.

sftim · 2024-08-08T16:19:44Z

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

+### jobset.sigs.k8s.io/jobset-controller
+
+Type: Label
+
+Example: `jobset.sigs.k8s.io/jobset-controller: "jobset-controller"`
+
+Used on: Jobs
+
+This label is used for the `managedBy` field to indicate that the job is managed by the built-in JobSet controller.


Suggested change

### jobset.sigs.k8s.io/jobset-controller

Type: Label

Example: `jobset.sigs.k8s.io/jobset-controller: "jobset-controller"`

Used on: Jobs

This label is used for the `managedBy` field to indicate that the job is managed by the built-in JobSet controller.

This is not a label, it's a value for managedBy.

Tim is correct, we can remove this.

I have remove this change as suggested.

danielvegamyhre

Thanks for working on this @kannon92, I added a couple comments

danielvegamyhre · 2024-08-08T16:39:26Z

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

+### jobset.sigs.k8s.io/jobset-controller
+
+Type: Label
+
+Example: `jobset.sigs.k8s.io/jobset-controller: "jobset-controller"`
+
+Used on: Jobs
+
+This label is used for the `managedBy` field to indicate that the job is managed by the built-in JobSet controller.


Tim is correct, we can remove this.

danielvegamyhre · 2024-08-08T16:41:26Z

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

+### alpha.jobset.sigs.k8s.io/no-schedule
+
+Type: Annotation
+
+Example: `alpha.jobset.sigs.k8s.io/no-schedule: "true"`
+
+Used on: Jobs
+
+This annotation prevents the job from being scheduled.


This is used as a taint for the node labeling exclusive placement strategy (link)

kannon92 · 2024-08-08T17:07:11Z

Thanks for working on this @kannon92, I added a couple comments

@Adarsh-verma-14 is the one who worked on this.

sftim · 2024-08-08T17:07:20Z

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

+Type: Annotation
+
+Example: `alpha.jobset.sigs.k8s.io/no-schedule: "true"`
+
+Used on: Jobs
+
+This annotation prevents the job from being scheduled.


Suggested change

Type: Annotation

Example: `alpha.jobset.sigs.k8s.io/no-schedule: "true"`

Used on: Jobs

This annotation prevents the job from being scheduled.

Type: Taint

Example: `alpha.jobset.sigs.k8s.io/no-schedule: NoSchedule`

Used on: Nodes

The JobSet controller uses this taint to support its node labeling exclusive placement strategy.

JobSet is an extension API that you can deploy into your Kubernetes cluster.

(aside: I'd rename this to jobset.sigs.k8s.io/exclusive-use or jobset.kubernetes.io/exclusive-use)

I have done this changes but is there need to change name (jobset.sigs.k8s.io/exclusive-use or jobset.kubernetes.io/exclusive-use) let me know.

sftim · 2024-08-08T17:08:58Z

There is also one taint, so:

/retitle Document labels, annotations and taints for JobSet

sftim · 2024-08-08T17:09:07Z

/sig apps

danielvegamyhre · 2024-08-08T21:04:09Z

Thanks for working on this @kannon92, I added a couple comments

@Adarsh-verma-14 is the one who worked on this.

Woops, sorry about that @Adarsh-verma-14! Thanks for the contribution :)

sftim · 2024-08-19T14:21:22Z

Tide, is this OK to merge?

Adarsh-verma-14 · 2024-08-22T15:52:33Z

Tide, is this OK to merge?

@sftim , I am not getting this, could you give more clarification ?

sftim · 2024-08-22T15:57:03Z

I am not getting this, could you give more clarification ?

I wanted to nudge Tide to recheck the PR status (it did).

danielvegamyhre · 2024-08-28T02:02:22Z

@sftim any blockers here? Scanning through it looks like comments have been addressed

sftim · 2024-08-28T09:44:11Z

This PR is ready for a review (any reviewer for English).

danielvegamyhre · 2024-09-08T18:11:04Z

This PR is ready for a review (any reviewer for English).

Thanks! Would you mind tagging a reviewer for this? I'm not sure who to add.

sftim · 2024-09-09T09:08:40Z

#47383 (comment) shows the suggested reviewers. I'll take a look if I get time.

sftim

Thanks; this needs more work though. For example, there's no such thing as a cluster-scoped Job.

Ideally, get a tech review from SIG Apps after making the next set up updates.

sftim · 2024-09-09T15:26:54Z

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

+
+Used on: JobSets
+
+This annotation acts as a flag. When set, the JobSet controller injects nodeSelectors for the `JobSetNameKey` label (e.g., `jobset.sigs.k8s.io/jobset-name`) to ensure exclusive job placement per topology.


What does the JobSet controller mutate based on this annotation?

JobSets

Jobs

Pods
?

It's not clear.

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

sftim · 2024-09-09T15:27:38Z

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

+
+Used on: Jobs
+
+This annotation indicates that the job is namespaced.


Are any Jobs not namespaced?

This annoation is actually used to store the namespaced Job name - @Adarsh-verma-14 can you fix this?

sure I will fix it @danielvegamyhre

I have fixed it cloud you check it is fine now ?

sftim · 2024-09-11T08:51:20Z

Waiting on author updates and then on tech LGTM.

danielvegamyhre · 2024-09-12T02:07:20Z

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

+
+Type: Annotation, Label
+
+Example: `jobset.sigs.k8s.io/coordinator: "coordinator-endpoint"`


Suggested change

Example: `jobset.sigs.k8s.io/coordinator: "coordinator-endpoint"`

Example: `jobset.sigs.k8s.io/coordinator: "myjobset-workers-0-0.headless-svc"`

okay i will replace with endpoint.

danielvegamyhre · 2024-09-12T02:07:53Z

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

+
+Example: `alpha.jobset.sigs.k8s.io/node-selector-strategy=true`
+
+Used on: JObs ,Pods


Suggested change

Used on: JObs ,Pods

Used on: Jobs ,Pods

uff my bad!! i will fix it.

danielvegamyhre · 2024-09-12T02:09:08Z

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

+Used on: Nodes
+
+The JobSet controller uses this taint to support its node labeling exclusive placement strategy.
+JobSet is an extension API that you can deploy into your Kubernetes cluster.


I notice here you mention "JobSet is an extension API that you can deploy into your Kubernetes cluster" but not in any other taint/label/annotation descriptions.

I think it would make more sense to delete this and instead make the word "JobSet" a link to https://github.com/kubernetes-sigs/jobset

sure i will add link for Jobset

danielvegamyhre · 2024-09-12T02:12:37Z

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

+
+Type: Annotation, Label
+
+Example: `alpha.jobset.sigs.k8s.io/namespaced-job:my-jobset-replicatedjob-A-0`


Suggested change

Example: `alpha.jobset.sigs.k8s.io/namespaced-job:my-jobset-replicatedjob-A-0`

Example: `alpha.jobset.sigs.k8s.io/default_myjobset-replicatedjob-0`

see https://github.com/kubernetes-sigs/jobset/blob/main/pkg/controllers/jobset_controller.go#L804

Also, the format of child job names for JobSets is: {jobset}-{replicatedJob}-{jobIndex}

danielvegamyhre · 2024-09-12T02:14:01Z

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

+Used on: JobSets, ReplicatedJobs
+
+You can set this annotation on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.
+JobSet and ReplicaSet are extension APIs that you can deploy into your Kubernetes cluster.


remove this sentence and make the word JobSet a link to the jobset repo

danielvegamyhre · 2024-09-12T02:16:45Z

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

+This annotation stores the index of the Job within the ReplicatedJob.
+ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.


Suggested change

This annotation stores the index of the Job within the ReplicatedJob.

ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.

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.

danielvegamyhre · 2024-09-12T02:17:00Z

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

+
+### jobset.sigs.k8s.io/job-key
+
+Type: Label


Also used as annotation

okay i will register this as annotation also

danielvegamyhre · 2024-09-12T02:17:42Z

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

@@ -2332,6 +2332,114 @@ 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


All of these are used as both labels and annotations (except the taint).

okay i will register for both labels and annotation

danielvegamyhre · 2024-09-12T02:18:09Z

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

+Used on: ReplicatedJobs
+
+This annotation specifies the number of replicas for a ReplicatedJob.
+ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.


Remove this sentence, it is not accurate

okay i will remove it

danielvegamyhre · 2024-09-12T02:18:32Z

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

+Used on: Jobs, Pods
+
+This label is used to store the name of the JobSet to which a Job or Pod belongs.
+JobSet is an extension API that you can deploy into your Kubernetes cluster.


Make the word "JobSet" a link to the JobSet github repo for readers who are unfamiliar with it

sure I will link that.

danielvegamyhre · 2024-09-14T17:21:35Z

Thanks @Adarsh-verma-14, please tag me when this is ready for another review

Adarsh-verma-14 · 2024-09-14T17:36:55Z

Thanks @Adarsh-verma-14, please tag me when this is ready for another review

Sure

Adarsh-verma-14 · 2024-09-20T05:38:02Z

Hi @danielvegamyhre , I have updated changes as suggested now you can review on it .

danielvegamyhre · 2024-09-20T05:55:15Z

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

+Used on: Jobs, Pods
+
+This label/annotation is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.
+ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.


remove this sentence please, ReplicatedJob is not an extension API that can be installed on your cluster, that is JobSet :)

ohh sorry, i missed it !!

I have removed it. PTAL!!

danielvegamyhre · 2024-09-21T19:50:49Z

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

+
+Example: `alpha.jobset.sigs.k8s.io/node-selector-strategy=true`
+
+Used on: Jobs ,Pods


Suggested change

Used on: Jobs ,Pods

Used on: Jobs, Pods

I have updated it also PTAL!!

tengqm · 2024-09-22T02:35:50Z

Sorry, I'm against this change because

JobSet is not something we can get from vanilla Kubernetes. Yes. The mentioned labels or annotations all carry the k8s.io domain name, which is reserved. But this doesn't mean that they are "official".
We could add notes (or warnings) to all these labels or annotations -- you can use them only when you deployed the jobset related manifests. They are not available by default on your cluster.
Or, better yet, document these labels/annotations on a different page. The current page is already lengthy (>2400 lines). Without differentiating builtin labels/annotations from those from other projects, we will end up with a huge file pretty soon.

sftim · 2024-09-22T11:48:27Z

Thanks for the comment @tengqm, but JobSet is part of the Kubernetes project. I don't think we should force SIG Apps to reorganize a long page just to register their labels and annotations, even if that work is a good idea for the long term.

danielvegamyhre

Looks good, just a couple more small changes

danielvegamyhre · 2024-09-27T01:40:58Z

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

+
+Used on: Jobs, Pods
+
+This label/annotation is used to store the name of the JobSet to which a Job or Pod belongs.


Suggested change

This label/annotation is used to store the name of the JobSet to which a Job or Pod belongs.

This label/annotation is used to store the name of the JobSet that a Job or Pod belongs to.

danielvegamyhre · 2024-09-27T01:43:40Z

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

+
+Used on: Jobs, Pods
+
+This label/annotation is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.


Suggested change

This label/annotation is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.

This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of.

Sure, I will update this.

done. PTAL !!

danielvegamyhre · 2024-09-29T16:09:19Z

/lgtm for JobSet

@sftim this is ready for SIG docs review

sftim

There's no API kind called ReplicatedJob, right?

If that's true, try these changes. We main use the UpperCamelCase notation for actual API kinds.

/lgtm cancel

sftim · 2024-09-29T20:25:47Z

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

+
+Used on: Jobs, Pods
+
+This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of.


Suggested change

This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of.

This label or annotation stores the name of the replicated job that this Job or Pod is part of.

sftim · 2024-09-29T20:26:43Z

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

+
+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.


Suggested change

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.

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.

sftim · 2024-09-29T20:27:46Z

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

+
+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.


Suggested change

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.

You can set this label/annotation on a [JobSet](https://jobset.sigs.k8s.io) to ensure exclusive Job

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.

adding labels and annotation for JobSet

099e386

k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 7, 2024

k8s-ci-robot requested review from salaxander and sftim August 7, 2024 17:11

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 7, 2024

kannon92 reviewed Aug 8, 2024

View reviewed changes

sftim reviewed Aug 8, 2024

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

sftim reviewed Aug 8, 2024

View reviewed changes

danielvegamyhre reviewed Aug 8, 2024

View reviewed changes

sftim reviewed Aug 8, 2024

View reviewed changes

k8s-ci-robot changed the title ~~Adding labels and annotation for JobSet~~ Document labels, annotations and taints for JobSet Aug 8, 2024

k8s-ci-robot added the sig/apps Categorizes an issue or PR as relevant to SIG Apps. label Aug 8, 2024

update description for labels/annotaionand taint also

0d815b6

johnnyboystar22 mentioned this pull request Aug 12, 2024

Rad54s kubernetes #47464

Closed

kannon92 mentioned this pull request Aug 19, 2024

Register labels/annotations on Kubernetes Website kubernetes-sigs/jobset#639

Open

andreyvelich mentioned this pull request Aug 22, 2024

KEP-2170: Add TrainJob and TrainingRuntime APIs kubeflow/training-operator#2223

Merged

kannon92 mentioned this pull request Aug 25, 2024

Register JobSet labels, annotations, and taints #47666

Closed

danielvegamyhre mentioned this pull request Sep 8, 2024

Blog Post: Introducing JobSet #45759

Open

sftim reviewed Sep 9, 2024

View reviewed changes

update description for labels/annotaionan

1be0ff2

danielvegamyhre reviewed Sep 12, 2024

View reviewed changes

update types and description for labels/annotation

eabf9c1

danielvegamyhre reviewed Sep 21, 2024

View reviewed changes

update some changes regarding ReplicatedJob

1fb8971

drackpack mentioned this pull request Sep 22, 2024

Add a desc #48035

Closed

danielvegamyhre reviewed Sep 27, 2024

View reviewed changes

Modified some sentence

d21c85e

sftim reviewed Sep 29, 2024

View reviewed changes

k8s-ci-robot assigned sftim Sep 29, 2024


		Used on: Jobs, Pods

		This label is used to store the name of the JobSet to which a job or pod belongs.

	This label is used to store the name of the JobSet to which a job or pod belongs.
	This label is used to store the name of the JobSet to which a Job or Pod belongs.
	JobSet is an extension API that you can deploy into your Kubernetes cluster.


		Used on: Jobs

		This label is used to index into a job's labels and retrieve the name of the parent ReplicatedJob.

	This label is used to index into a job's labels and retrieve the name of the parent ReplicatedJob.
	This label is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.
	ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.


		Used on: Jobs

		This annotation stores the index of the job within the ReplicatedJob.


		Used on: JobSets, ReplicatedJobs

		This annotation can be set on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.

	This annotation can be set on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.
	You can set this annotation on a JobSet or a ReplicatedJob template to ensure exclusive job placement per topology group.
	JobSet and ReplicaSet are extension APIs that you can deploy into your Kubernetes cluster.


		Used on: JobSets

		This annotation acts as a flag. When set, the JobSet controller injects nodeSelectors for the JobSetNameKey label to ensure exclusive job placement per topology.


		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 spec defines the `.spec.coordinator` field.


		Used on: Jobs

		This annotation indicates that the job is namespaced.


		Type: Annotation, Label

		Example: `jobset.sigs.k8s.io/coordinator: "coordinator-endpoint"`


		Example: `alpha.jobset.sigs.k8s.io/node-selector-strategy=true`

		Used on: JObs ,Pods


		Type: Annotation, Label

		Example: `alpha.jobset.sigs.k8s.io/namespaced-job:my-jobset-replicatedjob-A-0`

	Example: `alpha.jobset.sigs.k8s.io/namespaced-job:my-jobset-replicatedjob-A-0`
	Example: `alpha.jobset.sigs.k8s.io/default_myjobset-replicatedjob-0`

	This annotation stores the index of the Job within the ReplicatedJob.
	ReplicatedJob is an extension API that you can deploy into your Kubernetes cluster.
	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.


		Used on: Jobs, Pods

		This label/annotation is used to store the name of the JobSet to which a Job or Pod belongs.


		Used on: Jobs, Pods

		This label/annotation is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.

	This label/annotation is used to index into a Job's labels and retrieve the name of the parent ReplicatedJob.

	This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of.

	This label/annotation stores the name of the ReplicatedJob that this Job or Pod is part of.
	This label or annotation stores the name of the replicated job that this Job or Pod is part of.

	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.
	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.

Document labels, annotations and taints for JobSet #47383

Are you sure you want to change the base?

Document labels, annotations and taints for JobSet #47383

Conversation

Adarsh-verma-14 commented Aug 7, 2024

k8s-ci-robot commented Aug 7, 2024

Adarsh-verma-14 commented Aug 7, 2024

netlify bot commented Aug 7, 2024 • edited Loading

✅ Pull request preview available for checking

kannon92 commented Aug 8, 2024

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

Choose a reason for hiding this comment

sftim Aug 8, 2024 • edited Loading

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

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

danielvegamyhre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kannon92 commented Aug 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Aug 8, 2024

sftim commented Aug 8, 2024

danielvegamyhre commented Aug 8, 2024

sftim commented Aug 19, 2024

Adarsh-verma-14 commented Aug 22, 2024

sftim commented Aug 22, 2024

danielvegamyhre commented Aug 28, 2024

sftim commented Aug 28, 2024

danielvegamyhre commented Sep 8, 2024

sftim commented Sep 9, 2024

sftim left a 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

sftim commented Sep 11, 2024

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielvegamyhre commented Sep 14, 2024

Adarsh-verma-14 commented Sep 14, 2024

Adarsh-verma-14 commented Sep 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Aug 7, 2024 •

edited

Loading

sftim Aug 8, 2024 •

edited

Loading


		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.

-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.
+You can set this label/annotation on a [JobSet](https://jobset.sigs.k8s.io) to ensure exclusive Job
+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.