[YUNIKORN-2501] [UMBRELLA] Establish consistent usage guidelines for Labels and Annotations

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.6.0
• Component/s: core - common, documentation, shim - kubernetes
• Target Version: 1.6.0
• Assignee: Yu-Lin Chen
• Reporter: Yu-Lin Chen
• Created: 19/Mar/24 14:50
• Updated: 10/Sep/24 20:35
• Resolved: 10/Sep/24 20:35

Description

Currently, we have very inconsistent usage for labels and annotations in YuniKorn.
The inconsistenies including:

1. Inconsistent use of Labels and Annotation
2. Inconsistent precedence rules between Labels and Annotation
3. Inconsistent Naming of Label and Annotation

To establish a consistency view, we have defined a policy in YUNIKORN-1351, explaining when and how to utilize Labels/Annotations in YuniKorn.

This umbrella consolidates all the follow-up tasks.

Issue Links

• relates to: YUNIKORN-2811 Reject task if a pod has inconsistent metadata in the shim

Sub-Tasks

• Define policy for when to use annotations vs. labels: Resolved
• Add YuniKorn internal domain name to yunikorn-scheduler-interface: Resolved
• Use internal annotation prefix for placeholder pod: Resolved
• Remove internal labels and annotation from User Guide: Resolved
• Support canonical labels for queue/applicationId in Admission Controller: Resolved
• Support canonical labels and align metadata retrieving order in shim: Resolved
• Throw a warning if a pod has inconsistent metadata: Resolved
• Throw a warning if a pod has inconsistent metadata in admission controller: Closed
• Documentation: Update new label/annotation changes before 1.6.0 release: Resolved