wilfred-s commented on code in PR #280:
URL: https://github.com/apache/yunikorn-site/pull/280#discussion_r1136455066
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
Review Comment:
Fix the table layout to line up the | markings. Most IDEs will do that for
you.
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
+| `parentqueue` | Define a parent queue for a set of K8s namespaces. More
informations are in the [ Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces).|
Review Comment:
replace: `More informations are in the [ Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces)`
with: `Further details can be found in the [Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces)
documentation.`
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
+| `parentqueue` | Define a parent queue for a set of K8s namespaces. More
informations are in the [ Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces).|
+| `namespace.quota` | Set the maximum capacity of the queue mapped to this
namespace.<br/> More informations are in the [ Resource Quota
Management](resource_quota_management#namespace-quota) |
Review Comment:
no line breaks in the text (remove <br\/>)
replace: `More informations are in the [ Resource Quota
Management](resource_quota_management#namespace-quota)`
with: `Further details can be found in the [Resource Quota
Management](resource_quota_management#namespace-quota) documentation.`
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
Review Comment:
no line breaks in the text (remove <br\/>)
The `allow-preemption` annotation can only be set on a PriorityClass object.
It will trigger opt out of preemption for pods with that specific priority
class. Can point to the design doc to explain.
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
+| `parentqueue` | Define a parent queue for a set of K8s namespaces. More
informations are in the [ Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces).|
+| `namespace.quota` | Set the maximum capacity of the queue mapped to this
namespace.<br/> More informations are in the [ Resource Quota
Management](resource_quota_management#namespace-quota) |
+| [DEPRECATED] `namespace.max.cpu` | Since vesrion 1.2.0, `namespace.quota`
has replaced this one.<br/> Set the maximum capacity of the CPU in the queue
mapped to this namespace. |
Review Comment:
no line breaks in the text (remove <br\/>)
move the deprecation text after the description
Replace the text `Since...` with:
`Replaced with ``namespace.quota`` since version 1.2.0`
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -44,5 +44,10 @@ All annotations are under the namespace
`yunikorn.apache.org`. For example `yuni
| `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` | `yunikorn.apache.org/allow-preemption: false` marks the
pod with Opt out (OP).<br/> When using preemptor, pods marked with OP be used
to choose victims as a last option.<br/> More informations are in the
[DaemonSet Scheduling using Simple Preemptor](./../design/simple_preemptor). |
+| `parentqueue` | Define a parent queue for a set of K8s namespaces. More
informations are in the [ Resource Quota
Management](resource_quota_management#parent-queue-mapping-for-namespaces).|
+| `namespace.quota` | Set the maximum capacity of the queue mapped to this
namespace.<br/> More informations are in the [ Resource Quota
Management](resource_quota_management#namespace-quota) |
+| [DEPRECATED] `namespace.max.cpu` | Since vesrion 1.2.0, `namespace.quota`
has replaced this one.<br/> Set the maximum capacity of the CPU in the queue
mapped to this namespace. |
+| [DEPRECATED] `namespace.max.memory` | After vesrion 1.2.0, `namespace.quota`
has replaced this one.<br/> Set the maximum capacity of the memory in the queue
mapped to this namespace. |
Review Comment:
Same as for the `cpu` change
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
