This is an automated email from the ASF dual-hosted git repository.
wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 192189446 [YUNIKORN-1587] document resource quota annotations (#280)
192189446 is described below
commit 19218944677196e9ed7e99c0e4f3199d12706ced
Author: 0yukali0 <[email protected]>
AuthorDate: Thu Mar 23 17:04:51 2023 +1100
[YUNIKORN-1587] document resource quota annotations (#280)
Add missing quota annotations and deprecate old ones in the doc.
Format the tables correctly
Closes: #280
Signed-off-by: Wilfred Spiegelenburg <[email protected]>
---
.../labels_and_annotations_in_yunikorn.md | 27 +++++++++++++---------
1 file changed, 16 insertions(+), 11 deletions(-)
diff --git a/docs/user_guide/labels_and_annotations_in_yunikorn.md
b/docs/user_guide/labels_and_annotations_in_yunikorn.md
index fa38f746a..f5da6fc7a 100644
--- a/docs/user_guide/labels_and_annotations_in_yunikorn.md
+++ b/docs/user_guide/labels_and_annotations_in_yunikorn.md
@@ -25,24 +25,29 @@ under the License.
YuniKorn utilizes several Kubernetes labels and annotations to support various
features:
### Labels in YuniKorn
-| Name | Description
|
-|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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. |
+| `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.
|
### Annotations in 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.<br/>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.<br/>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.
|
+| Name | Description
|
+| ----------------------------------- |
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| `app-id` | Assoiates this pod with an
application.<br/>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.<br/>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.
|
+| `allow-preemption` | The `allow-preemption` annotation can
only be set on the PriorityClass object. It will trigger opt out of preemption
for pods with that specific priority class. 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.
|
+| [DEPRECATED] `namespace.max.cpu` | Replaced with ``namespace.quota``
since version 1.2.0
|
+| [DEPRECATED] `namespace.max.memory` | Replaced with `namespace.quota` since
version 1.2.0
|
For more details surrounding gang-scheduling labels and annotations, please
refer to the documentation on [gang scheduling](user_guide/gang_scheduling.md).
