Skip to content

Commit c68175e

Browse files
committed
Document labels, annotations and taints for JobSet
1 parent a224b8b commit c68175e

File tree

1 file changed

+105
-0
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+105
-0
lines changed

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

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2551,6 +2551,111 @@ Starting in v1.16, this annotation was removed in favor of
25512551
[Pod Priority](/docs/concepts/scheduling-eviction/pod-priority-preemption/).
25522552
{{< /note >}}
25532553

2554+
### jobset.sigs.k8s.io/jobset-name
2555+
2556+
Type: Label, Annotation
2557+
2558+
Example: `jobset.sigs.k8s.io/jobset-name: "my-jobset"`
2559+
2560+
Used on: Jobs, Pods
2561+
2562+
This label/annotation is used to store the name of the JobSet that a Job or Pod belongs to.
2563+
[JobSet](https://jobset.sigs.k8s.io) is an extension API that you can deploy into your Kubernetes cluster.
2564+
2565+
### jobset.sigs.k8s.io/replicatedjob-replicas
2566+
2567+
Type: Label, Annotation
2568+
2569+
Example: `jobset.sigs.k8s.io/replicatedjob-replicas: "5"`
2570+
2571+
Used on: Jobs, Pods
2572+
2573+
This label/annotation specifies the number of replicas for a ReplicatedJob.
2574+
2575+
### jobset.sigs.k8s.io/replicatedjob-name
2576+
2577+
Type: Label, Annotation
2578+
2579+
Example: `jobset.sigs.k8s.io/replicatedjob-name: "my-replicatedjob"`
2580+
2581+
Used on: Jobs, Pods
2582+
2583+
This label or annotation stores the name of the replicated job that this Job or Pod is part of.
2584+
2585+
### jobset.sigs.k8s.io/job-index
2586+
2587+
Type: Label, Annotation
2588+
2589+
Example: `jobset.sigs.k8s.io/job-index: "0"`
2590+
2591+
Used on: Jobs, Pods
2592+
2593+
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.
2594+
2595+
### jobset.sigs.k8s.io/job-key
2596+
2597+
Type: Label, Annotation
2598+
2599+
Example: `jobset.sigs.k8s.io/job-key: "0f1e93893c4cb372080804ddb9153093cb0d20cefdd37f653e739c232d363feb"`
2600+
2601+
Used on: Jobs, Pods
2602+
2603+
The JobSet controller sets this label (and also an annotation with the same key) on child Jobs and
2604+
Pods of a JobSet. The value is the SHA256 hash of the namespaced Job name.
2605+
2606+
### alpha.jobset.sigs.k8s.io/exclusive-topology
2607+
2608+
Type: Label, Annotation
2609+
2610+
Example: `alpha.jobset.sigs.k8s.io/exclusive-topology: "zone"`
2611+
2612+
Used on: JobSets, Jobs
2613+
2614+
You can set this label/annotation on a [JobSet](https://jobset.sigs.k8s.io) to ensure exclusive Job
2615+
placement per topology group. You can also define this label or annotation on a replicated job
2616+
template. Read the documentation for JobSet to learn more.
2617+
2618+
### alpha.jobset.sigs.k8s.io/node-selector
2619+
2620+
Type: Label, Annotation
2621+
2622+
Example: `alpha.jobset.sigs.k8s.io/node-selector: "true"`
2623+
2624+
Used on: Jobs, Pods
2625+
2626+
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.
2627+
2628+
### alpha.jobset.sigs.k8s.io/namespaced-job
2629+
2630+
Type: Label
2631+
2632+
Example: `alpha.jobset.sigs.k8s.io/namespaced-job: "default_myjobset-replicatedjob-0"`
2633+
2634+
Used on: Nodes
2635+
2636+
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.
2637+
2638+
### alpha.jobset.sigs.k8s.io/no-schedule
2639+
2640+
Type: Taint
2641+
2642+
Example: `alpha.jobset.sigs.k8s.io/no-schedule: "NoSchedule"`
2643+
2644+
Used on: Nodes
2645+
2646+
The [JobSet](https://jobset.sigs.k8s.io) controller uses this taint to support its node labeling exclusive placement strategy.
2647+
2648+
### jobset.sigs.k8s.io/coordinator
2649+
2650+
Type: Annotation, Label
2651+
2652+
Example: `jobset.sigs.k8s.io/coordinator: "myjobset-workers-0-0.headless-svc"`
2653+
2654+
Used on: Jobs, Pods
2655+
2656+
This annotation/label is used on Jobs and Pods to store a stable network endpoint where the coordinator
2657+
pod can be reached if the [JobSet](https://jobset.sigs.k8s.io) spec defines the `.spec.coordinator` field.
2658+
25542659
## Annotations used for audit
25552660

25562661
<!-- sorted by annotation -->

0 commit comments

Comments
 (0)