This is an automated email from the ASF dual-hosted git repository.
ccondit 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 045b155 [YUNIKORN-1131] Document behavior of resource in REST API
(#140)
045b155 is described below
commit 045b1552d2af46da08291caf65641a4eb8e1bf45
Author: Craig Condit <[email protected]>
AuthorDate: Mon Mar 28 11:22:00 2022 -0500
[YUNIKORN-1131] Document behavior of resource in REST API (#140)
Closes: #140
---
docs/api/scheduler.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 340c6a9..386cb4b 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -22,6 +22,15 @@ specific language governing permissions and limitations
under the License.
-->
+# Overview
+
+The scheduler REST API returns information about various objects used by the
YuniKorn Scheduler.
+
+Many of these APIs return collections of resources. Internally, all resources
are represented as raw
+64-bit signed integer types. When interpreting responses from the REST API,
resources of type `memory`
+are returned in units of bytes while resources of type `vcore` are returned in
units of millicores
+(thousands of a core). All other resource types have no specific unit assigned.
+
## Partitions
Displays general information about the partition like name, state, capacity,
used capacity, utilization, and node sorting policy.
