Version: 1.0.0

Labels and Annotations in YuniKorn

YuniKorn utilizes several Kubernetes labels and annotations to support various features:

Name	Description
`applicationId`	Associates this pod with an application.
`queue`	Selects the YuniKorn queue this application should be scheduled in. This may be ignored if a placement policy is in effect.
`SparkLabelAppID`	Alternative method of specifying `applicationId` used by Spark Operator if the label `applicationId` and annotation `yunikorn.apache.org/app-id` unset.
`disableStateAware`	If present, disables the YuniKorn state-aware scheduling policy for this pod. Set internally by the YuniKorn admission controller.
`placeholder`	Set if this pod represents a placeholder for gang scheduling. Set internally by YuniKorn.

All annotations are under the namespace yunikorn.apache.org. For example yunikorn.apache.org/app-id.

Name	Description
`app-id`	Assoiates this pod with an application. The priority of applicationID is determined by: annotation `yunikorn.apache.org/app-id` > label `applicationId` > label `SparkLabelAppID`.
`queue`	Selects the YuniKorn queue this application should be scheduled in. The priority of queue is determined by: label `queue` > annotation `yunikorn.apache.org/queue` > default.
`task-group-name`	Sets the task group name this pod belongs to for the purposes of gang scheduling. It must be listed within `task-groups`.
`task-groups`	Defines the set of task groups for this application for gang scheduling. Each pod within an application must define all task groups.
`schedulingPolicyParameters`	Arbitrary key-value pairs used to customize scheduling policies such as gang scheduling.
`placeholder`	Set if this pod represents a placeholder for gang scheduling. Set internally by YuniKorn.

For more details surrounding gang-scheduling labels and annotations, please refer to the documentation on gang scheduling.

Labels and Annotations in YuniKorn​