[YUNIKORN-165] API response fields can be returned as proper data structure rather than free text

• Type: Improvement
• Status: Closed
• Priority: Critical
• Resolution: Fixed
• Fix Version/s: 1.0.0
• Component/s: core - common, webapp
• Labels: pull-request-available
• Target Version: 1.0.0
• Assignee: Craig Condit
• Reporter: Ayub Pathan
• Created: 18/May/20 00:25
• Updated: 04/May/22 23:52
• Resolved: 21/Mar/22 15:53

Description

For most of the APIs, some of the fields are recorded as free text, this can be improved by sending them as proper data structure like map etc. This helps in easy consumption of the REST aPI response.

For example:

• Some fields from Apps API like resource,usedResource, partition can be returned as maps..

      {
          "allocations": [
              {
                  "allocationKey": "1e5225f7-4d60-400f-8b9b-5b7027b4c394",
                  "allocationTags": null,
                  "applicationId": "abcd",
                  "nodeId": "docker-desktop",
                  "partition": "default",
                  "priority": "<nil>",
                  "queueName": "root.development",
                  "resource": "[memory:100 vcore:200]",
                  "uuid": "b1b89eaf-81fb-4b2b-b20a-bf7bd96d3430"
              }
          ],
          "applicationID": "abcd",
          "applicationState": "Running",
          "partition": "[mycluster]default",
          "queueName": "root.development",
          "submissionTime": 1589740021170274400,
          "usedResource": "[memory:100 vcore:200]"
      }, 

   

•  same for nodes API response(fields like available, capacity, occupied, allocated) as well.

      [
      {
          "nodesInfo": [
              {
                  "RackName": "/rack-default",
                  "allocated": "[memory:0 vcore:0]",
                  "allocations": null,
                  "available": "[ephemeral-storage:56450230179 hugepages-1Gi:0 hugepages-2Mi:0 memory:1824 pods:110 vcore:3250]",
                  "capacity": "[ephemeral-storage:56450230179 hugepages-1Gi:0 hugepages-2Mi:0 memory:1982 pods:110 vcore:4000]",
                  "hostName": "docker-desktop",   
                  "nodeID": "docker-desktop",
                  "occupied": "[memory:158 vcore:750]",
                  "schedulable": true
              }
          ],
          "partitionName": "[mycluster]default"
      }
  ] 

 

Issue Links

• is duplicated by: YUNIKORN-1094 Split resources in the REST API
• is related to: YUNIKORN-1132 Document changes from YUNIKORN-165
• is related to: YUNIKORN-1105 Rethink memory resource conversion to MB
• is required by: YUNIKORN-1134 Use new resource format in web app
• is required by: YUNIKORN-1140 Update e2e tests to work with new REST API changes
• relates to: YUNIKORN-1120 Allow unit specifiers in core configs
• supercedes: YUNIKORN-797 testing `DAOString` with multiple resources is unstable
• links to: GitHub Pull Request #389
• links to: GitHub Pull Request #391