You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by ww...@apache.org on 2021/07/25 04:57:14 UTC
[incubator-yunikorn-site] branch master updated: [YUNIKORN-763]:
Backport YUNIKORN-746 to 0.11 version doc (#67)
This is an automated email from the ASF dual-hosted git repository.
wwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 12af4b1 [YUNIKORN-763]: Backport YUNIKORN-746 to 0.11 version doc (#67)
12af4b1 is described below
commit 12af4b1e31802cb1f4ff362958152119f112283e
Author: manirajv06 <ma...@gmail.com>
AuthorDate: Sun Jul 25 10:27:06 2021 +0530
[YUNIKORN-763]: Backport YUNIKORN-746 to 0.11 version doc (#67)
---
versioned_docs/version-0.11.0/api/scheduler.md | 34 +++++++++++++++-----------
1 file changed, 20 insertions(+), 14 deletions(-)
diff --git a/versioned_docs/version-0.11.0/api/scheduler.md b/versioned_docs/version-0.11.0/api/scheduler.md
index 524fef2..481b06a 100644
--- a/versioned_docs/version-0.11.0/api/scheduler.md
+++ b/versioned_docs/version-0.11.0/api/scheduler.md
@@ -88,10 +88,12 @@ Displays general information about the partition like name, state, capacity, use
}
```
-## Queues (Newer Version)
+## Queues
-Displays general information about the queues like name, status, capacities and properties.
-The queues' hierarchy is kept in the response json.
+### Partition queues
+
+Fetch all Queues associated with given Partition and displays general information about the queues like name, status, capacities and properties.
+The queues' hierarchy is kept in the response json.
**URL** : `/ws/v1/partition/{partitionName}/queues`
@@ -162,9 +164,9 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
}
```
-## Queues (Deprecated)
+### All Queues
-Displays general information about the queues like name, status, capacities and properties.
+Fetch all Queues across different Partitions and displays general information about the queues like name, status, capacities and properties.
The queues' hierarchy is kept in the response json.
**URL** : `/ws/v1/queues`
@@ -217,9 +219,11 @@ For the default queue hierarchy (only `root.default` leaf queue exists) a simila
}
```
-## Applications (Newer Version)
+## Applications
-Displays general information about the applications like used resources, queue name, submission time and allocations.
+### Queue applications
+
+Fetch all Applications for the given Partition Queue combination and displays general information about the applications like used resources, queue name, submission time and allocations.
**URL** : `/ws/v1/partition/{partitioName}/queue/{queueName}/applications`
@@ -319,9 +323,9 @@ In the example below there are three allocations belonging to two applications.
}
```
-## Applications (Deprecated)
+### All applications
-Displays general information about the applications like used resources, queue name, submission time and allocations.
+Fetch all Applications across different Partitions and displays general information about the applications like used resources, queue name, submission time and allocations.
**URL** : `/ws/v1/apps`
@@ -401,9 +405,11 @@ In the example below there are three allocations belonging to two applications.
]
```
-## Nodes (Newer Version)
+## Nodes
+
+### Partition nodes
-Displays general information about the nodes managed by YuniKorn.
+Fetch all Nodes associated with given Partition and displays general information about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
**URL** : `/ws/v1/partition/{partitionName}/nodes`
@@ -508,9 +514,9 @@ Here you can see an example response from a 2-node cluster having 3 allocations.
}
```
-## Nodes (Deprecated)
+### All nodes
-Displays general information about the nodes managed by YuniKorn.
+Fetch all Nodes acrosss different Partitions and displays general information about the nodes managed by YuniKorn.
Node details include host and rack name, capacity, resources and allocations.
**URL** : `/ws/v1/nodes`
@@ -774,7 +780,7 @@ yunikorn_scheduler_vcore_nodes_usage{range="(90%,100%]"} 0
yunikorn_scheduler_vcore_nodes_usage{range="[0,10%]"} 0
```
-## Configuration validation (Deprecated)
+## Configuration validation
**URL** : `/ws/v1/validate-conf`