pbacsko commented on code in PR #378: URL: https://github.com/apache/yunikorn-site/pull/378#discussion_r1418859328
########## docs/api/scheduler.md: ########## @@ -285,6 +285,10 @@ Fetch all Applications for the given Partition/Queue combination and displays ge **Code** : `200 OK` +**Deprecated**: + +Field `uuid` has been deprecated, would be removed from below response in YUNIKORN 1.7.0 release. `AllocationID` has replaced `uuid`. Both `uuid` and `AllocationID` fields has same value. `AllocationID` has extra suffix containing hypen and counter (-0, -1 and so on..) at the end. Review Comment: "have the same value" "and so on" (no "..") "hyphen" ########## docs/user_guide/troubleshooting.md: ########## @@ -23,6 +23,33 @@ title: Troubleshooting ## Scheduler logs +### Understanding the linkage between Pod UUID, Task TaskID, AllocationAsk AllocationKey and Allocation AllocationID + +Pod is always submitted with `UUID`, a unique identifier to differentiate various pods. When a pod is submitted, `Task` gets created in Shim +uses Pod's `UUID` as `TaskID` and passed as `AllocationAsk` request to core through SI. `AllocationAsk` uses `Task`'s Review Comment: Sounds better: "... a Task gets created in the Shim. It uses the UID of the POD as TaskID and passed as an AllocationAsk request to the core." ########## docs/user_guide/troubleshooting.md: ########## @@ -23,6 +23,33 @@ title: Troubleshooting ## Scheduler logs +### Understanding the linkage between Pod UUID, Task TaskID, AllocationAsk AllocationKey and Allocation AllocationID + +Pod is always submitted with `UUID`, a unique identifier to differentiate various pods. When a pod is submitted, `Task` gets created in Shim +uses Pod's `UUID` as `TaskID` and passed as `AllocationAsk` request to core through SI. `AllocationAsk` uses `Task`'s +`TaskID` as `AllocationKey` and passed onto core for further processing. On receiving the ask request, Core tries to find a suitable +`Allocation` using `AllocationAsk`'s `AllocationKey` as `AllocationID`. Understanding this flow and its linkage between different objects helps to debug the issues. + +An example has been described below to explain how pod's `UUID` is getting translated with different name and passed through different objects. Review Comment: UUID --> UID ########## docs/api/scheduler.md: ########## @@ -540,6 +547,10 @@ Fetch an Application given a Partition, Queue and Application ID and displays ge **Code** : `200 OK` +**Deprecated**: + +Field `uuid` has been deprecated, would be removed from below response in YUNIKORN 1.7.0 release. `AllocationID` has replaced `uuid`. Both `uuid` and `AllocationID` fields has same value. `AllocationID` has extra suffix containing hypen and counter (-0, -1 and so on..) at the end. Review Comment: "have the same value" "and so on" (no "..") "hyphen" -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
