(yunikorn-site) branch master updated: [YUNIKORN-2108] Document preemption.enabled setting (#362)

[wi...@apache.org]

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 d5fcd39294 [YUNIKORN-2108] Document preemption.enabled setting (#362)
d5fcd39294 is described below

commit d5fcd39294e7c3a1f6032ea579a3d256693f984e
Author: Craig Condit <cc...@apache.org>
AuthorDate: Mon Nov 13 19:05:28 2023 +1100

    [YUNIKORN-2108] Document preemption.enabled setting (#362)
    
    Closes: #362
    
    Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
 docs/user_guide/queue_config.md | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/docs/user_guide/queue_config.md b/docs/user_guide/queue_config.md
index 5b2eab830d..ca1712010c 100644
--- a/docs/user_guide/queue_config.md
+++ b/docs/user_guide/queue_config.md
@@ -65,22 +65,26 @@ Optionally the following keys can be defined for a partition:
 * [statedumpfilepath](#statedump-filepath) (deprecated since v1.2.0)
 * [limits](#limits)
 * nodesortpolicy
-* preemption (deprecated since v1.3.0)
+* preemption
 
 Placement rules and limits are explained in their own chapters
 
 The `nodesortpolicy` key defines the way the nodes are sorted for the partition.
 Details on the values that can be used are in the [sorting policy](sorting_policies.md#node-sorting) documentation.
 
-The `preemption` key can have only one sub key: _enabled_. NOTE: This property
-has been deprecated since v1.3.0 and will be ignored. Preemption policies are
-now configured per-queue.
+The `preemption` key can have only one sub key: _enabled_.
+This boolean value defines the preemption behavior for the whole partition.
 
-Example `partition` yaml entry with a `nodesortpolicy` of _fair_:
+The default value for _enabled_ is _true_.
+Allowed values: _true_ or _false_, any other value will cause a parse error.
+
+Example `partition` yaml entry with a `nodesortpolicy` of _fair_ and preemption disabled:
 ```yaml
 partitions:
   - name: <name of the partition>
     nodesortpolicy: fair
+    preemption:
+      enabled: false
 ```
 NOTE:
 Currently the Kubernetes unique shim does not support any other partition than the `default` partition..


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: issues-help@yunikorn.apache.org