This is an automated email from the ASF dual-hosted git repository.

manirajv06 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 2a23b3e19e [YUNIKORN-3124] Add foreign allocation to rest 
documentation (#562)
2a23b3e19e is described below

commit 2a23b3e19e495630669b62fe3617f3a341cc7909
Author: Wilfred Spiegelenburg <[email protected]>
AuthorDate: Tue Jun 30 21:36:12 2026 +0530

    [YUNIKORN-3124] Add foreign allocation to rest documentation (#562)
    
    The node in the core exposes the allocation added to the node by a
    different scheduler than YuniKorn as a foreign allocation. Update the
    REST response with examples of foreign allocations on a node.
    
    Add `quotaPreemptionEnabled` flag to exposed values for partitions.
    Remove deprecated 'stateaware' references in rest output.
    
    Closes: #562
    
    Signed-off-by: Manikandan R <[email protected]>
---
 docs/api/scheduler.md | 80 +++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 65 insertions(+), 15 deletions(-)

diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 0c4e8dbd54..07fc307611 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -89,7 +89,8 @@ Returns general information and statistics about a partition.
         },
         "totalContainers": 0,
         "totalNodes": 2,
-        "preemptionEnabled": false
+        "preemptionEnabled": false,
+        "quotaPreemptionEnabled": false
     },
     {
         "clusterId": "mycluster",
@@ -125,7 +126,8 @@ Returns general information and statistics about a 
partition.
         },
         "totalContainers": 20,
         "totalNodes": 5,
-        "preemptionEnabled": false
+        "preemptionEnabled": false,
+        "quotaPreemptionEnabled": false
     }
 ]
 ```
@@ -225,7 +227,7 @@ For the default queue hierarchy (only `root.default` leaf 
queue exists) a simila
         "isLeaf": "false",
         "isManaged": "false",
         "properties": {
-            "application.sort.policy": "stateaware"
+            "application.sort.policy": "fifo"
         },
         "parent": "",
         "template": {
@@ -238,7 +240,7 @@ For the default queue hierarchy (only `root.default` leaf 
queue exists) a simila
                 "vcore": 80
             },
             "properties": {
-                "application.sort.policy": "stateaware"
+                "application.sort.policy": "fifo"
             }
         },
         "partition": "default",
@@ -265,7 +267,7 @@ For the default queue hierarchy (only `root.default` leaf 
queue exists) a simila
                 "isLeaf": "true",
                 "isManaged": "false",
                 "properties": {
-                    "application.sort.policy": "stateaware"
+                    "application.sort.policy": "fifo"
                 },
                 "parent": "root",
                 "template": null,
@@ -351,7 +353,7 @@ If the query parameter `subtree` is not set, the queue's 
children will not be re
     "isLeaf": "true",
     "isManaged": "false",
     "properties": {
-        "application.sort.policy": "stateaware"
+        "application.sort.policy": "fifo"
     },
     "parent": "root",
     "template": null,
@@ -1224,16 +1226,16 @@ Here you can see an example response from a 2-node 
cluster having 3 allocations.
             "vcore": 6000
         },
         "occupied": {
-            "memory": 154000000,
-            "vcore" :750
+            "memory": 6500000,
+            "vcore" : 250
         },
         "available": {
             "ephemeral-storage": 75850798569,
             "hugepages-1Gi": 0,
             "hugepages-2Mi": 0,
-            "memory": 6423000000,
-            "pods": 110,
-            "vcore": 1250
+            "memory": 8570500000,
+            "pods": 107,
+            "vcore": 3750
         },
         "utilized": {
             "memory": 3,
@@ -1291,7 +1293,31 @@ Here you can see an example response from a 2-node 
cluster having 3 allocations.
                 "placeholderUsed": false
             }
         ],
-        "schedulable": true
+        "foreignAllocations": [
+            {
+                "allocationKey": "02724936-4e80-4620-bf0c-6cf3bc4a2d36",
+                "allocationTags": {
+                    "creationTime": "1782105319",
+                    "foreign": "default",
+                    "kubernetes.io/label/app.kubernetes.io/instance": 
"coredns-updater",
+                    "kubernetes.io/label/app.kubernetes.io/name": 
"coredns-updater",
+                    "kubernetes.io/label/pod-template-hash": "5b94674f96",
+                    "kubernetes.io/meta/namespace": "kube-system",
+                    "kubernetes.io/meta/podName": 
"coredns-updater-5b94674f96-fhcn4"
+                },
+                "allocationTime": 1782105319000000000,
+                "resource": {
+                    "memory": 6500000,
+                    "pods": 1,
+                    "vcore": 250
+                },
+                "priority": "2000000000",
+                "nodeId": "node-0001",
+                "preemptable": true
+            }
+        ],
+        "schedulable": true,
+        "isReserved": false
     },
     {
         "nodeID": "node-0002",
@@ -1322,8 +1348,8 @@ Here you can see an example response from a 2-node 
cluster having 3 allocations.
             "vcore": 2000
         },
         "occupied": {
-            "memory": 154000000,
-            "vcore" :750
+            "memory": 0,
+            "vcore" :0
         },
         "available": {
             "ephemeral-storage": 75850798569,
@@ -1483,7 +1509,31 @@ Node details include host and rack name, capacity, 
resources, utilization, and a
          "placeholderUsed":false
       }
    ],
-   "schedulable":true
+   "foreignAllocations": [
+      {
+         "allocationKey": "02724936-4e80-4620-bf0c-6cf3bc4a2d36",
+         "allocationTags": {
+            "creationTime": "1782105319",
+            "foreign": "default",
+            "kubernetes.io/label/app.kubernetes.io/instance": 
"coredns-updater",
+            "kubernetes.io/label/app.kubernetes.io/name": "coredns-updater",
+            "kubernetes.io/label/pod-template-hash": "5b94674f96",
+            "kubernetes.io/meta/namespace": "kube-system",
+            "kubernetes.io/meta/podName": "coredns-updater-5b94674f96-fhcn4"
+         },
+         "allocationTime": 1782105319000000000,
+         "resource": {
+            "memory": 6500000,
+            "pods": 1,
+            "vcore": 250
+         },
+         "priority": "2000000000",
+         "nodeId": "node-0001",
+         "preemptable": true
+      }
+   ],
+   "schedulable":true,
+   "isReserved": false
 }
 ```
 


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to