Skip to content

Commit

Permalink
[YUNIKORN-2619] Remove internal labels and annotation from User Guide (…
Browse files Browse the repository at this point in the history 
…apache#428)

Remove below internal labels and annotation from User Guide:
1. (Label) disableStateAware
2. (Label) placeholder
3. (Annotation) yunikorn.apache.org/placeholder

Closes: apache#428

Signed-off-by: Yu-Lin Chen <[email protected]>
  • Loading branch information
@chenyulin0719
chenyulin0719 committed May 10, 2024
1 parent b08f759 commit 0d4247b
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/user_guide/labels_and_annotations_in_yunikorn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ YuniKorn utilizes several Kubernetes labels and annotations to support various f
| `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. |
| `spark-app-selector` | Alternative method of specifying `applicationId` used by Spark Operator if the label `applicationId` and annotation `yunikorn.apache.org/app-id` unset. |
| [DEPRECATED] `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. |

### Annotations in YuniKorn
All annotations are under the namespace `yunikorn.apache.org`. For example `yunikorn.apache.org/app-id`.
Expand All @@ -43,7 +41,6 @@ All annotations are under the namespace `yunikorn.apache.org`. For example `yuni
| `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. |
| `allow-preemption` | The `allow-preemption` annotation can be set on the Pod or PriorityClass object. The annotation in Pod takes priority over PriorityClass. It will trigger opt out of preemption for pods. Further details can be found in the [DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor) documentation. |
| `parentqueue` | Define a parent queue for a set of K8s namespaces. Further details can be found in the [ Resource Quota Management](resource_quota_management#parent-queue-mapping-for-namespaces) documentation. |
| `namespace.quota` | Set the maximum capacity of the queue mapped to this namespace. Further details can be found in the [ Resource Quota Management](resource_quota_management#namespace-quota) documentation. |
Expand Down

0 comments on commit 0d4247b

Please sign in to comment.