Labels and Annotations
This page serves as a reference for all labels and annotations in Kueue.
kueue.x-k8s.io/is-group-workload
Type: Annotation
Example: kueue.x-k8s.io/is-group-workload: "true"
Used on: Workload.
The annotation key indicates that this workload is used for a group of Pods.
kueue.x-k8s.io/job-completions-equal-parallelism
Type: Annotation
Example: kueue.x-k8s.io/job-completions-equal-parallelism: "true"
Used on: batch/Job.
The annotation key is used to keep completions
and parallelism
in sync
kueue.x-k8s.io/job-min-parallelism
Type: Annotation
Example: kueue.x-k8s.io/job-min-parallelism: "5"
Used on: batch/Job.
The annotation key indicates the minimum parallelism
acceptable for the job in the case of partial admission.
kueue.x-k8s.io/job-uid
Type: Label
Example: kueue.x-k8s.io/job-uid: "46ef6b23-a7d9-42b1-b0f8-071bbb29a94d"
Used on: Workload.
The label key in the workload resource holds the UID of the owner job.
kueue.x-k8s.io/managed
Type: Label
Example: kueue.x-k8s.io/managed: "true"
Used on: Plain Pods and ProvisioningRequest.
The label key that indicates which pods and ProvisioningRequest are managed by Kueuue.
kueue.x-k8s.io/max-exec-time-seconds
Type: Label
Example: kueue.x-k8s.io/max-exec-time-seconds: "120"
Used on: Kueue-managed Jobs.
The value of this label is passed in the Job’s Workload spec.maximumExecutionTimeSeconds
and used by the Maximum execution time feature.
kueue.x-k8s.io/multikueue-origin
Type: Label
Example: kueue.x-k8s.io/multikueue-origin: "true"
Used on: MultiKueue.
The label key is used to track the creator of MultiKueue remote objects in Worker Cluster.
kueue.x-k8s.io/pod-group-fast-admission
Type: Annotation
Example: kueue.x-k8s.io/pod-group-fast-admission: "true"
Used on: Plain Pods.
The annotation key is used to allow admitting a PodGroup as soon as the first pod in the group is created.
kueue.x-k8s.io/pod-group-name
Type: Label
Example: kueue.x-k8s.io/pod-group-name: "my-pod-group-name"
Used on: Plain Pods.
The label key indicates the name of the group of Pods that should be admitted together.
kueue.x-k8s.io/pod-group-total-count
Type: Annotation
Example: kueue.x-k8s.io/pod-group-total-count: "2"
Used on: Plain Pods.
The annotation key is used to indicate how many Pods to expect in the group.
kueue.x-k8s.io/prebuilt-workload-name
Type: Label
Example: kueue.x-k8s.io/prebuilt-workload-name: "my-prebuild-workload-name"
Used on: Kueue-managed Jobs.
The label key of the job holds the name of the pre-built workload to be used. The intended use of prebuilt workload is to create the Job once the workload is created. In other scenarios the behavior is undefined.
kueue.x-k8s.io/priority-class
Type: Label
Example: kueue.x-k8s.io/priority-class: "my-priority-class-name"
Used on: Kueue-managed Jobs.
The label key in the workload holds the workloadPriorityClass
name.
This label is always mutable, as it may be useful for preemption.
For more details, see Workload Priority Class.
kueue.x-k8s.io/queue-name
Type: Label
Example: kueue.x-k8s.io/queue-name: "my-local-queue"
Used on: Kueue-managed Jobs.
The label key in the workload holds the queue name.
kueue.x-k8s.io/queue-name (deprecated)
Type: Annotation
Example: kueue.x-k8s.io/queue-name: "my-local-queue"
Used on: Kueue-managed Jobs.
The annotation key in the workload holds the queue name.
Warning
Starting fromv1beta1
this annotation is deprecated.
Please use kueue.x-k8s.io/queue-name label instead.kueue.x-k8s.io/retriable-in-group
Type: Annotation
Example: kueue.x-k8s.io/retriable-in-group: "false"
Used on: Plain Pods.
The annotation key is used to finalize the group if at least one terminated Pod (either Failed or Succeeded)
has the retriable-in-group: false
annotation.
kueue.x-k8s.io/role-hash
Type: Annotation
Example: kueue.x-k8s.io/role-hash: "b54683bb"
Used on: Plain Pods.
The annotation key is used as the name for a Workload podSet.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.