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 c265b8569 [YUNIKORN-956] Remove deprecated REST API methods (#152)
c265b8569 is described below
commit c265b856938ff44e9ef8fcdac03ddbd1bf254fbe
Author: Craig Condit <[email protected]>
AuthorDate: Mon Apr 11 10:37:22 2022 -0500
[YUNIKORN-956] Remove deprecated REST API methods (#152)
Closes: #152
---
docs/api/cluster.md | 54 ------
docs/api/scheduler.md | 499 +-------------------------------------------------
2 files changed, 1 insertion(+), 552 deletions(-)
diff --git a/docs/api/cluster.md b/docs/api/cluster.md
index cf9e4c8da..524bfb069 100644
--- a/docs/api/cluster.md
+++ b/docs/api/cluster.md
@@ -83,57 +83,3 @@ As an example, here is a response from a 2-node cluster with
3 applications and
"description": "system error message. for example, json: invalid UTF-8 in
string: .."
}
```
-
-## Clusters utilization
-
-Returns statistical data related the cluster resource utilization
-
-**Status** : Deprecated since v0.12.2, replaced by
[Partitions](scheduler.md#partitions)
-
-**URL** : `/ws/v1/clusters/utilization`
-
-**Method** : `GET`
-
-**Auth required** : NO
-
-### Success response
-
-**Code** : `200 OK`
-
-**Content examples**
-
-```json
-[
- {
- "partition": "default",
- "utilization": [
- {
- "type": "memory",
- "total": 6442450944,
- "used": 1648361472,
- "usage": "26%"
- },
- {
- "type": "vcore",
- "total": 4000,
- "used": 300,
- "usage": "7%"
- }
- ]
- }
-]
-```
-
-### Error response
-
-**Code** : `500 Internal Server Error`
-
-**Content examples**
-
-```json
-{
- "status_code": 500,
- "message": "system error message. for example, json: invalid UTF-8 in
string: ..",
- "description": "system error message. for example, json: invalid UTF-8 in
string: .."
-}
-```
diff --git a/docs/api/scheduler.md b/docs/api/scheduler.md
index 18d75a502..55c2ea08e 100644
--- a/docs/api/scheduler.md
+++ b/docs/api/scheduler.md
@@ -245,93 +245,6 @@ For the default queue hierarchy (only `root.default` leaf
queue exists) a simila
}
```
-### All Queues
-
-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.
-
-**Status** : Deprecated since v0.12.1, replaced by [Partition
Queues](#partition-queues)
-
-**URL** : `/ws/v1/queues`
-
-**Method** : `GET`
-
-**Auth required** : NO
-
-### Success response
-
-**Code** : `200 OK`
-
-**Content examples**
-
-For the default queue hierarchy (only `root.default` leaf queue exists) a
similar response to the following is sent back to the client:
-
-```json
-{
- "partitionName": "default",
- "capacity": {
- "capacity": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 80000000000,
- "pods": 110,
- "vcore": 60000
- },
- "usedCapacity": {
- "memory": 100000000,
- "vcore": 100
- },
- "utilization": {
- "memory": 1,
- "vcore": 0
- }
- },
- "nodes": null,
- "queues": {
- "queuename": "root",
- "status": "Active",
- "capacities": {
- "capacity": {},
- "maxCapacity": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 80000000000,
- "pods": 110,
- "vcore": 60000
- },
- "usedCapacity": {
- "memory": 8000000000,
- "vcore": 8000
- },
- "absUsedCapacity": {
- "memory": 54,
- "vcore": 80
- }
- },
- "queues": [
- {
- "queuename": "default",
- "status": "Active",
- "capacities": {
- "capacity": {},
- "maxCapacity": {},
- "usedCapacity": {
- "memory": 8000000000,
- "vcore": 8000,
- },
- "absUsedCapacity": {}
- },
- "queues": null,
- "properties": {}
- }
- ],
- "properties": {}
- }
-}
-```
-
## Applications
### Queue applications
@@ -537,200 +450,6 @@ In the example below there are three allocations
belonging to two applications.
}
```
-### All applications
-
-Fetch all Applications across different Partitions and displays general
information about the applications like used resources, queue name, submission
time and allocations.
-
-**Status** : Deprecated since v0.12.1, replaced by [Queue
Applications](#queue-applications)
-
-**URL** : `/ws/v1/apps`
-
-**Method** : `GET`
-
-**Query Params** :
-
-1. queue=<fully qualified queue name\>
-
-The fully qualified queue name used to filter the applications that run within
the given queue. For example, "/ws/v1/apps?queue=root.default" returns the
applications running in "root.default" queue.
-
-**Auth required** : NO
-
-### Success response
-
-**Code** : `200 OK`
-
-**Content examples**
-
-In the example below there are three allocations belonging to two applications
and one rejected application.
-
-```json
-[
- {
- "applicationID": "application-0001",
- "usedResource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "maxUsedResource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "partition": "default",
- "queueName": "root.default",
- "submissionTime": 1648754032076020293,
- "allocations": [
- {
- "allocationKey": "deb12221-6b56-4fe9-87db-ebfadce9aa20",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId": "application-0001",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task1"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "9af35d44-2d6f-40d1-b51d-758859e6b8a8",
- "resource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0001",
- "applicationId": "application-0001",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- }
- ],
- "applicationState": "Running",
- "user": "nobody",
- "rejectedMessage": "",
- "stateLog": [
- {
- "time": 1648741409145224000,
- "applicationState": "Accepted"
- },
- {
- "time": 1648741409145509400,
- "applicationState": "Starting"
- },
- {
- "time": 1648741409147432100,
- "applicationState": "Running"
- }
- ],
- "placeholderData": []
- },
- {
- "applicationID": "application-0002",
- "usedResource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "maxUsedResource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "partition": "default",
- "queueName": "root.default",
- "submissionTime": 1648754032076020293,
- "allocations": [
- {
- "allocationKey": "54e5d77b-f4c3-4607-8038-03c9499dd99d",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId": "application-0002",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task0"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "08033f9a-4699-403c-9204-6333856b41bd",
- "resource": {
- "memory": 2000000000,
- "vcore": 2000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0001",
- "applicationId": "application-0002",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- },
- {
- "allocationKey": "af3bd2f3-31c5-42dd-8f3f-c2298ebdec81",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId": "application-0002",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task1"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "96beeb45-5ed2-4c19-9a83-2ac807637b3b",
- "resource": {
- "memory": 2000000000,
- "vcore": 2000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0002",
- "applicationId": "application-0002",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- }
- ],
- "applicationState": "Running",
- "user": "nobody",
- "rejectedMessage": "",
- "stateLog": [
- {
- "time": 1648741409145224000,
- "applicationState": "Accepted"
- },
- {
- "time": 1648741409145509400,
- "applicationState": "Starting"
- },
- {
- "time": 1648741409147432100,
- "applicationState": "Running"
- }
- ],
- "placeholderData": []
- },
- {
- "applicationID": "application-0003",
- "usedResource": {},
- "maxUsedResource": {},
- "partition": "default",
- "queueName": "",
- "submissionTime": 1646757410878163500,
- "finishedTime": 1646757410878225400,
- "allocations": {},
- "applicationState": "Rejected",
- "user": "nobody",
- "rejectedMessage": "failed to place application application-0003:
application rejected: no placement rule matched",
- "stateLog": [
- {
- "time": 1648741409145224000,
- "applicationState": "Rejected"
- }
- ],
- "placeholderData": []
- }
-]
-```
-
## Nodes
### Partition nodes
@@ -930,222 +649,6 @@ Here you can see an example response from a 2-node
cluster having 3 allocations.
}
```
-### All nodes
-
-Fetch all Nodes across different Partitions and displays general information
about the nodes managed by YuniKorn.
-Node details include host and rack name, capacity, resources and allocations.
-
-**Status** : Deprecated since v0.12.1, replaced by [Partition
Nodes](#partition-nodes)
-
-**URL** : `/ws/v1/nodes`
-
-**Method** : `GET`
-
-**Auth required** : NO
-
-### Success response
-
-**Code** : `200 OK`
-
-**Content examples**
-
-Here you can see an example response from a 2-node cluster having 3
allocations.
-
-```json
-[
- {
- "partitionName": "default",
- "nodesInfo": [
- {
- "nodeID": "node-0001",
- "hostName": "",
- "rackName": "",
- "capacity": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 14577000000,
- "pods": 110,
- "vcore": 10000
- },
- "allocated": {
- "memory": 6000000000,
- "vcore": 6000
- },
- "occupied": {
- "memory": 154000000,
- "vcore" :750
- },
- "available": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 6423000000,
- "pods": 110,
- "vcore": 1250
- },
- "utilized": {
- "memory": 3,
- "vcore": 13
- },
- "allocations": [
- {
- "allocationKey":
"54e5d77b-f4c3-4607-8038-03c9499dd99d",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId":
"application-0001",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task0"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "08033f9a-4699-403c-9204-6333856b41bd",
- "resource": {
- "memory": 2000000000,
- "vcore": 2000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0001",
- "applicationId": "application-0001",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- },
- {
- "allocationKey":
"deb12221-6b56-4fe9-87db-ebfadce9aa20",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId":
"application-0002",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task0"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "9af35d44-2d6f-40d1-b51d-758859e6b8a8",
- "resource": {
- "memory": 4000000000,
- "vcore": 4000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0001",
- "applicationId": "application-0002",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- }
- ],
- "schedulable": true
- },
- {
- "nodeID": "node-0002",
- "hostName": "",
- "rackName": "",
- "capacity": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 14577000000,
- "pods": 110,
- "vcore": 10000
- },
- "allocated": {
- "memory": 2000000000,
- "vcore": 2000
- },
- "occupied": {
- "memory": 154000000,
- "vcore" :750
- },
- "available": {
- "ephemeral-storage": 75850798569,
- "hugepages-1Gi": 0,
- "hugepages-2Mi": 0,
- "memory": 6423000000,
- "pods": 110,
- "vcore": 1250
- },
- "utilized": {
- "memory": 8,
- "vcore": 38
- },
- "allocations": [
- {
- "allocationKey":
"af3bd2f3-31c5-42dd-8f3f-c2298ebdec81",
- "allocationTags": {
- "kubernetes.io/label/app": "sleep",
- "kubernetes.io/label/applicationId":
"application-0001",
- "kubernetes.io/label/queue": "root.default",
- "kubernetes.io/meta/namespace": "default",
- "kubernetes.io/meta/podName": "task1"
- },
- "requestTime": 1648754034098912461,
- "allocationTime": 1648754035973982920,
- "allocationDelay": 1875070459,
- "uuid": "96beeb45-5ed2-4c19-9a83-2ac807637b3b",
- "resource": {
- "memory": 2000000000,
- "vcore": 2000
- },
- "priority": "0",
- "queueName": "root.default",
- "nodeId": "node-0002",
- "applicationId": "application-0001",
- "partition": "default",
- "placeholder": false,
- "placeholderUsed": false
- }
- ],
- "schedulable": true
- }
- ]
- }
-]
-```
-
-## Nodes utilization
-
-Shows how nodes are distributed with regarding the utilization
-
-**Status** : Deprecated since v0.12.2, replaced by [Partition
Nodes](#partition-nodes)
-
-**URL** : `/ws/v1/nodes/utilization`
-
-**Method** : `GET`
-
-**Auth required** : NO
-
-**Code** : `200 OK`
-
-**Content examples**
-
-```text
-[
- {
- partition: default,
- utilization: [ {
- type: "cpu",
- total: 100,
- used: 50,
- usage: 50%
- },
- {
- type: "memory",
- total: 1000,
- used: 500,
- usage: 50%
- }
- ]
- },
- ...
-]
-```
-
## Goroutines info
Dumps the stack traces of the currently running goroutines.
@@ -1778,7 +1281,7 @@ The output of this REST query can be rather large and it
is a combination of tho
**Code**: `500 Internal Server Error`
-## Enable or disable periodic state dump to an external file inside the
container which runs Yunikorn
+## Enable or disable periodic state dump
Endpoint to enable a state dump to be written periodically. By default, it is
60 seconds. The output goes to a file called `yunikorn-state.txt`. In the
current version, the file is located in the current working directory of
Yunikorn and it is not configurable.
