You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by "stu01509 (via GitHub)" <gi...@apache.org> on 2023/11/27 14:53:44 UTC
[PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
stu01509 opened a new pull request, #372:
URL: https://github.com/apache/yunikorn-site/pull/372
### What is this PR for?
Add `/ws/v1/scheduler/node-utilization` endpoint doc.
### What type of PR is it?
* [ ] - Bug Fix
* [ ] - Improvement
* [ ] - Feature
* [x] - Documentation
* [ ] - Hot Fix
* [ ] - Refactoring
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2194
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* [ ] - The licenses files need update.
* [ ] - There is breaking changes for older versions.
* [ ] - It needs documentation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "stu01509 (via GitHub)" <gi...@apache.org>.
stu01509 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413819090
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Shows how node are distributed with regarding the utilization
Review Comment:
Thanks for your review, updated in https://github.com/apache/yunikorn-site/pull/372/commits/04a691566a14f80efdce742b470665b704fd809b
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "steinsgateted (via GitHub)" <gi...@apache.org>.
steinsgateted commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413007096
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,58 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
Review Comment:
@stu01509 @wilfred-s Thank you.
I would like some clarifications.
Should we consider removing s (nodes --> node)?
Because our api is `node-utilization`
Then currently, `Nodes utilization` is placed after Node, instead of Nodes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chenyulin0719 (via GitHub)" <gi...@apache.org>.
chenyulin0719 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1417812953
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to utilization.
+
Review Comment:
Sorry for late review, but I think we should emphasize the utilization type is 'dominant' resource type only.
Some thing like:
"Show how every node is distributed with regard to dominant resource utilization."
(Dominant resource is defined as the highest utilised resource type on the root queue based on the registered resources.)
https://github.com/apache/yunikorn-core/blob/master/pkg/webservice/handlers.go#L353-L356
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "steinsgateted (via GitHub)" <gi...@apache.org>.
steinsgateted commented on PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#issuecomment-1839010863
LGTM
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 closed pull request #372: [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc
URL: https://github.com/apache/yunikorn-site/pull/372
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "steinsgateted (via GitHub)" <gi...@apache.org>.
steinsgateted commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413006145
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,58 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
+
+Shows how nodes are distributed with regarding the utilization
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
Review Comment:
missing `### Success response`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "stu01509 (via GitHub)" <gi...@apache.org>.
stu01509 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413121296
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,58 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
+
+Shows how nodes are distributed with regarding the utilization
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
Review Comment:
Thanks for your mention, I fixed it in this commit https://github.com/apache/yunikorn-site/pull/372/commits/19df5336f561eac8047c7859fa4ecd5657c78f87
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "stu01509 (via GitHub)" <gi...@apache.org>.
stu01509 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413121443
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,58 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
Review Comment:
Ok, Let me adjust the `Nodes` to `Node`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "steinsgateted (via GitHub)" <gi...@apache.org>.
steinsgateted commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413150031
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Shows how node are distributed with regarding the utilization
Review Comment:
There are grammatical errors, maybe change it to this:
`Show how every node is distributed with regard to utilization.`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1446938701
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
it should be json
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "stu01509 (via GitHub)" <gi...@apache.org>.
stu01509 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1409227006
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,55 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
+
+Shows how nodes are distributed with regarding the utilization
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
+{
+ "type": "vcore",
+ "utilization": [
+ {
+ "bucketName": "0-10%",
+ "numOfNodes": 1,
+ "nodeNames": [
+ "aethergpu"
+ ]
+ },
+ {
+ "bucketName": "10-20%",
+ "numOfNodes": 3,
+ "nodeNames": null
Review Comment:
Hi @wilfred-s
Thanks for your review, I modified the `numOfNodes` to 2, and some example nodes data.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "stu01509 (via GitHub)" <gi...@apache.org>.
stu01509 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1418663072
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to utilization.
+
Review Comment:
Thanks for your review, updated the commit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chenyulin0719 (via GitHub)" <gi...@apache.org>.
chenyulin0719 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1448975796
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
Hi @chia7712 ,
I will fix it in [YUNIKORN-2316](https://issues.apache.org/jira/browse/YUNIKORN-2316).
Could you merge this PR first.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chenyulin0719 (via GitHub)" <gi...@apache.org>.
chenyulin0719 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1448975796
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
Hi @chia7712 , I will fix in [YUNIKORN-2316](https://issues.apache.org/jira/browse/YUNIKORN-2316).
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
Hi @chia7712 , I will fix it in [YUNIKORN-2316](https://issues.apache.org/jira/browse/YUNIKORN-2316).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chenyulin0719 (via GitHub)" <gi...@apache.org>.
chenyulin0719 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1448975796
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
Hi @chia7712 , I will fix it in [YUNIKORN-2316](https://issues.apache.org/jira/browse/YUNIKORN-2316).
Could you merge this PR first.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1448978621
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,60 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Node utilization
+
+Show how every node is distributed with regard to dominant resource utilization.
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
Review Comment:
merge into master, @chenyulin0719 please fix this trivial comment in the follow-up.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "wilfred-s (via GitHub)" <gi...@apache.org>.
wilfred-s commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1408723766
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,55 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
+
+Shows how nodes are distributed with regarding the utilization
+
+**URL** : `/ws/v1/scheduler/node-utilization`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+**Code** : `200 OK`
+
+**Content examples**
+
+```text
+{
+ "type": "vcore",
+ "utilization": [
+ {
+ "bucketName": "0-10%",
+ "numOfNodes": 1,
+ "nodeNames": [
+ "aethergpu"
+ ]
+ },
+ {
+ "bucketName": "10-20%",
+ "numOfNodes": 3,
+ "nodeNames": null
Review Comment:
If we show 3 nodes we should have a list of 3 nodes in the nodeNames also for consistency.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [YUNIKORN-2194] docs: add `/ws/v1/scheduler/node-utilization` endpoint doc [yunikorn-site]
Posted by "steinsgateted (via GitHub)" <gi...@apache.org>.
steinsgateted commented on code in PR #372:
URL: https://github.com/apache/yunikorn-site/pull/372#discussion_r1413007096
##########
docs/api/scheduler.md:
##########
@@ -1361,6 +1361,58 @@ Node details include host and rack name, capacity, resources, utilization, and a
}
```
+## Nodes utilization
Review Comment:
@stu01509 @wilfred-s Thank you.
I would like some clarifications.
Should we consider removing s (nodes --> node)?
Because our api is `node-utilization`
Then currently, Nodes utilization is placed after Node, instead of Nodes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org