[YUNIKORN-1131] Document behaviour of resource in REST API

• Type: Sub-task
• Status: Closed
• Priority: Critical
• Resolution: Fixed
• Fix Version/s: 1.0.0
• Component/s: documentation
• Labels: pull-request-available
• Target Version: 1.0.0
• Assignee: Craig Condit
• Reporter: Wilfred Spiegelenburg
• Created: 17/Mar/22 23:54
• Updated: 05/May/22 02:52
• Resolved: 28/Mar/22 19:22

Description

With the changes from YUNIKORN-1105 a flow on change has been introduced in the REST API: memory is now send in Bytes always and not in Mega Bytes. What used to be 1 is now 1000000.

We need to document the behaviour on how to interpret the Resource values in the REST API:

• memory: bytes
• vcores: milli cores
• other resources: no units

Issue Links

• is a child of: YUNIKORN-1105 Rethink memory resource conversion to MB
• links to: GitHub Pull Request #140
• links to: GitHub Pull Request #140