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 57958649a [YUNIKORN-1384] Document new objects in REST API (#255)
57958649a is described below
commit 57958649a3c2af089151cede967ab338e51fb937
Author: Ryan Lo <[email protected]>
AuthorDate: Mon Jan 30 10:44:39 2023 +1100
[YUNIKORN-1384] Document new objects in REST API (#255)
Document pendingResources for queue and app in REST API
Includes YUNIKORN-1157: reservation in REST objects
Closes: #255
Signed-off-by: Wilfred Spiegelenburg <[email protected]>
---
docs/api/scheduler.md | 36 ++++++++++++++++++++++++++++++++----
1 file changed, 32 insertions(+), 4 deletions(-)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index c230240fb..873ca04cb 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -179,6 +179,10 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
"memory": 54000000,
"vcore": 80
},
+ "pendingResource": {
+ "memory": 54000000,
+ "vcore": 80
+ },
"isLeaf": "false",
"isManaged": "false",
"properties": {
@@ -215,6 +219,10 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
"memory": 54000000,
"vcore": 80
},
+ "pendingResource": {
+ "memory": 54000000,
+ "vcore": 80
+ },
"isLeaf": "true",
"isManaged": "false",
"properties": {
@@ -289,6 +297,10 @@ In the example below there are three allocations belonging
to two applications,
"memory": 4000000000,
"vcore": 4000
},
+ "pendingResource": {
+ "memory": 4000000000,
+ "vcore": 4000
+ },
"partition": "default",
"queueName": "root.default",
"submissionTime": 1648754032076020293,
@@ -388,7 +400,9 @@ In the example below there are three allocations belonging
to two applications,
"replaced": 1,
"timedout": 1
}
- ]
+ ],
+ "hasReserved": false,
+ "reservations": []
},
{
"applicationID": "application-0002",
@@ -400,6 +414,10 @@ In the example below there are three allocations belonging
to two applications,
"memory": 4000000000,
"vcore": 4000
},
+ "pendingResource": {
+ "memory": 4000000000,
+ "vcore": 4000
+ },
"partition": "default",
"queueName": "root.default",
"submissionTime": 1648754032076020293,
@@ -471,7 +489,9 @@ In the example below there are three allocations belonging
to two applications,
"applicationState": "Running"
}
],
- "placeholderData": []
+ "placeholderData": [],
+ "hasReserved": false,
+ "reservations": []
}
]
```
@@ -519,6 +539,10 @@ Fetch an Application given a Partition, Queue and
Application ID and displays ge
"memory": 4000000000,
"vcore": 4000
},
+ "pendingResource": {
+ "memory": 4000000000,
+ "vcore": 4000
+ },
"partition": "default",
"queueName": "root.default",
"submissionTime": 1648754032076020293,
@@ -618,7 +642,9 @@ Fetch an Application given a Partition, Queue and
Application ID and displays ge
"replaced": 1,
"timedout": 1
}
- ]
+ ],
+ "hasReserved": false,
+ "reservations": []
}
```
@@ -801,7 +827,9 @@ Here you can see an example response from a 2-node cluster
having 3 allocations.
"placeholderUsed": false
}
],
- "schedulable": true
+ "schedulable": true,
+ "isReserved": false,
+ "reservations": []
}
]
```
