[YUNIKORN-2847] Documentation: Update new label/annotation changes before 1.6.0 release #468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…fore 1.6.0 release
craigcondit
requested changes
Sep 9, 2024
| YuniKorn utilizes several Kubernetes labels and annotations to support various features. | ||
|
|
||
| Since YuniKorn 1.6.0, we have provided canonical representations for defining applicationID and queue in labels under the namespace `yunikorn.apache.org`. Using these labels can benefit from the Kubernetes filtering and grouping capabilities. | ||
| The non-canonical(Classic) representation will not be deprecated and will continue to be supported in future releases. |
There was a problem hiding this comment.
Nit: space before parenthesis.
Suggestion: Perhaps "legacy" is a better descriptor; it's a bit more negative. Not quite deprecated, but also not preferred. So: "The non-canonical (legacy) representations will not be deprecated..."
| | `spark-app-selector` | Alternative method of specifying `applicationId` used by Spark Operator if the label `applicationId` and annotation `yunikorn.apache.org/app-id` are unset. | | ||
| | Name | Description | | ||
| |-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `yunikorn.apache.org/app-id` | Associates this pod with an application. This is the canonical representation and it is recommended to use it.<br/><br/>The priority of applicationID is determined in the following order: <ol><li>Label `yunikorn.apache.org/app-id`</li><li>Annotation `yunikorn.apache.org/app-id`</li><li>Label `applicationId`</li><li>Label `spark-app-selector`</li></ol>**Note**: Pod has inconsistent application metadata will be rejected in 1.7.0. | | |
There was a problem hiding this comment.
Nit: "The priority of applicationID" -> "The priority of application ID" (add space as this is now a generic term referring to all the various representations).
Grammar: "Pod has inconsistent application metadata" -> "Pods with inconsistent application metadata"
| | Name | Description | | ||
| |-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `yunikorn.apache.org/app-id` | Associates this pod with an application. This is the canonical representation and it is recommended to use it.<br/><br/>The priority of applicationID is determined in the following order: <ol><li>Label `yunikorn.apache.org/app-id`</li><li>Annotation `yunikorn.apache.org/app-id`</li><li>Label `applicationId`</li><li>Label `spark-app-selector`</li></ol>**Note**: Pod has inconsistent application metadata will be rejected in 1.7.0. | | | ||
| | `yunikorn.apache.org/queue` | Selects the YuniKorn queue this application should be scheduled in. This is the canonical representation and it is recommended to use it.<br/><br/>Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues). This may be ignored if a placement policy is in effect.<br/><br/>The priority of queue name is determined in the following order: <ol><li>Label `yunikorn.apache.org/queue`</li><li>Annotation `yunikorn.apache.org/queue`</li><li>Label `queue`</li></ol>**Note**: Pod has inconsistent queue metadata will be rejected in 1.7.0. | |
There was a problem hiding this comment.
Grammar: "Pod has inconsistent queue metadata" -> "Pods with inconsistent queue metadata"
| |-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `yunikorn.apache.org/app-id` | Associates this pod with an application. This is the canonical representation and it is recommended to use it.<br/><br/>The priority of applicationID is determined in the following order: <ol><li>Label `yunikorn.apache.org/app-id`</li><li>Annotation `yunikorn.apache.org/app-id`</li><li>Label `applicationId`</li><li>Label `spark-app-selector`</li></ol>**Note**: Pod has inconsistent application metadata will be rejected in 1.7.0. | | | ||
| | `yunikorn.apache.org/queue` | Selects the YuniKorn queue this application should be scheduled in. This is the canonical representation and it is recommended to use it.<br/><br/>Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues). This may be ignored if a placement policy is in effect.<br/><br/>The priority of queue name is determined in the following order: <ol><li>Label `yunikorn.apache.org/queue`</li><li>Annotation `yunikorn.apache.org/queue`</li><li>Label `queue`</li></ol>**Note**: Pod has inconsistent queue metadata will be rejected in 1.7.0. | | ||
| | [Classic]<br/>`applicationId` | It is equivalent to the label `yunikorn.apache.org/app-id`, and we recommend using it. | |
There was a problem hiding this comment.
Let's switch from "[Classic] to [LEGACY], and reword descriptions as follows:
Equivalent to the preferred label yunikorn.apache.org/app-id.
| | `yunikorn.apache.org/app-id` | Associates this pod with an application. This is the canonical representation and it is recommended to use it.<br/><br/>The priority of applicationID is determined in the following order: <ol><li>Label `yunikorn.apache.org/app-id`</li><li>Annotation `yunikorn.apache.org/app-id`</li><li>Label `applicationId`</li><li>Label `spark-app-selector`</li></ol>**Note**: Pod has inconsistent application metadata will be rejected in 1.7.0. | | | ||
| | `yunikorn.apache.org/queue` | Selects the YuniKorn queue this application should be scheduled in. This is the canonical representation and it is recommended to use it.<br/><br/>Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues). This may be ignored if a placement policy is in effect.<br/><br/>The priority of queue name is determined in the following order: <ol><li>Label `yunikorn.apache.org/queue`</li><li>Annotation `yunikorn.apache.org/queue`</li><li>Label `queue`</li></ol>**Note**: Pod has inconsistent queue metadata will be rejected in 1.7.0. | | ||
| | [Classic]<br/>`applicationId` | It is equivalent to the label `yunikorn.apache.org/app-id`, and we recommend using it. | | ||
| | [Classic]<br/>`queue` | It is equivalent to the label `yunikorn.apache.org/queue`, and we recommend using it. | |
There was a problem hiding this comment.
Let's switch from "[Classic] to [LEGACY], and reword descriptions as follows:
Equivalent to the preferred label yunikorn.apache.org/queue.
| | `yunikorn.apache.org/queue` | Selects the YuniKorn queue this application should be scheduled in. This is the canonical representation and it is recommended to use it.<br/><br/>Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues). This may be ignored if a placement policy is in effect.<br/><br/>The priority of queue name is determined in the following order: <ol><li>Label `yunikorn.apache.org/queue`</li><li>Annotation `yunikorn.apache.org/queue`</li><li>Label `queue`</li></ol>**Note**: Pod has inconsistent queue metadata will be rejected in 1.7.0. | | ||
| | [Classic]<br/>`applicationId` | It is equivalent to the label `yunikorn.apache.org/app-id`, and we recommend using it. | | ||
| | [Classic]<br/>`queue` | It is equivalent to the label `yunikorn.apache.org/queue`, and we recommend using it. | | ||
| | `spark-app-selector` | It is equivalent to the label `yunikorn.apache.org/app-id`.<br/><br/>It is automatically attached by third-party Spark jobs triggered by the [Spark Operator](https://github.com/kubeflow/spark-operator). YuniKorn internally supports this label as one of the sources of applicationID. | |
There was a problem hiding this comment.
Wording: "YuniKorn internally supports this label as one of the sources of applicationID." -> "YuniKorn uses this label to define application ID if no other metadata exists."
This more clearly conveys what we intend to do in 1.7.
|
|
||
| | Name | Description | | ||
| |-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | [Classic]<br/>`yunikorn.apache.org/app-id` | It is equivalent to the label `yunikorn.apache.org/app-id`, and we recommend using it. | |
There was a problem hiding this comment.
Let's switch from "[Classic] to [LEGACY], and reword descriptions as follows:
Equivalent to the preferred label yunikorn.apache.org/app-id.
| | Name | Description | | ||
| |-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | [Classic]<br/>`yunikorn.apache.org/app-id` | It is equivalent to the label `yunikorn.apache.org/app-id`, and we recommend using it. | | ||
| | [Classic]<br/>`yunikorn.apache.org/queue` | It is equivalent to the label `yunikorn.apache.org/queue`, and we recommend using it. | |
There was a problem hiding this comment.
Let's switch from "[Classic] to [LEGACY], and reword descriptions as follows:
Equivalent to the preferred label yunikorn.apache.org/queue.
|
@craigcondit Thanks for the review. Updated this PR with the suggestions. |
github-actions bot
pushed a commit
that referenced
this pull request
Sep 10, 2024
…ion changes before 1.6.0 release (#468)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR for?
Add below descriptions:
yunikorn.apache.org/app-id,yunikorn.apache.org/queue, also update to the latest prioirty. Add note for inconsistent pod rejection in 1.7.0.task-groupstoyunikorn.apache.org/task-groups)spark-app-selector. Add a link to SparkOperator.What type of PR is it?
What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2847
How should this be tested?
Questions:
NA