From 3df055e3c81884b6c51ce65a827c714842895e89 Mon Sep 17 00:00:00 2001 From: "favour.lawrence" Date: Tue, 1 Sep 2026 23:49:35 +0100 Subject: [PATCH 1/2] docs: update NVIDIA registration format Signed-off-by: favour.lawrence --- docs/developers/protocol.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developers/protocol.md b/docs/developers/protocol.md index 3932766ec..0f190094a 100644 --- a/docs/developers/protocol.md +++ b/docs/developers/protocol.md @@ -13,10 +13,10 @@ hami.io/node-handshake-\{device-type\}: Reported_\{device_node_current_timestamp hami.io/node-\{device-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\} ``` -The definition of each device is in the following format: +The device registration format depends on the device plugin. For NVIDIA devices, the registration annotation uses JSON with fields such as: ```text -\{Device UUID\},\{device split count\},\{device memory limit\},\{device core limit\},\{device type\},\{device numa\},\{healthy\} +{"id":"GPU-...","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true} ``` An example is shown below: @@ -25,7 +25,7 @@ An example is shown below: hami.io/node-handshake-nvidia: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895 hami.io/node-handshake-mlu: Requesting_2024.01.10 04:06:57 hami.io/node-mlu-register: MLU-45013011-2257-0000-0000-000000000000,10,23308,0,MLU-MLU370-X4,0,false:MLU-54043011-2257-0000-0000-000000000000,10,23308,0, -hami.io/node-nvidia-register: GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec,10,32768,100,NVIDIA-Tesla V100-PCIE-32GB,0,true:GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448,10,32768,100,NVIDIA-Tesla V100-PCIE-32GB,0,true: +hami.io/node-nvidia-register: [{"id":"GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true},{"id":"GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448","index":1,"count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true}] ``` From d5f885d298730ed5c65ef4c9181834fbf21a035f Mon Sep 17 00:00:00 2001 From: "favour.lawrence" Date: Tue, 8 Sep 2026 10:51:29 +0100 Subject: [PATCH 2/2] docs: fix NVIDIA registration format, numa field, and handshake annotation key Signed-off-by: favour.lawrence --- docs/developers/protocol.md | 6 +++--- docs/faq/faq.md | 2 +- versioned_docs/version-v2.9.0/developers/protocol.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/developers/protocol.md b/docs/developers/protocol.md index 0f190094a..7d2b8a22e 100644 --- a/docs/developers/protocol.md +++ b/docs/developers/protocol.md @@ -16,16 +16,16 @@ hami.io/node-\{device-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\} The device registration format depends on the device plugin. For NVIDIA devices, the registration annotation uses JSON with fields such as: ```text -{"id":"GPU-...","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true} +{"id":"GPU-...","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","numa":0,"mode":"hami-core","health":true} ``` An example is shown below: ```text -hami.io/node-handshake-nvidia: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895 +hami.io/node-handshake: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895 hami.io/node-handshake-mlu: Requesting_2024.01.10 04:06:57 hami.io/node-mlu-register: MLU-45013011-2257-0000-0000-000000000000,10,23308,0,MLU-MLU370-X4,0,false:MLU-54043011-2257-0000-0000-000000000000,10,23308,0, -hami.io/node-nvidia-register: [{"id":"GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true},{"id":"GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448","index":1,"count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true}] +hami.io/node-nvidia-register: [{"id":"GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","numa":0,"mode":"hami-core","health":true},{"id":"GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448","index":1,"count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","numa":0,"mode":"hami-core","health":true}] ``` diff --git a/docs/faq/faq.md b/docs/faq/faq.md index 69cf5654e..05a3bd773 100644 --- a/docs/faq/faq.md +++ b/docs/faq/faq.md @@ -145,7 +145,7 @@ Device Plugins can only report a single resource type. GPU memory and compute in - Example annotation: ```yaml - hami.io/node-nvidia-register: GPU-fc28df76-54d2-c387-e52e-5f0a9495968c,10,49140,100,NVIDIA-NVIDIA L40S,0,true:GPU-b97db201-0442-8531-56d4-367e0c7d6edd,10,49140,100,... + hami.io/node-nvidia-register: [{"id":"GPU-fc28df76-54d2-c387-e52e-5f0a9495968c","count":10,"devmem":49140,"devcore":100,"type":"NVIDIA-NVIDIA L40S","numa":0,"mode":"hami-core","health":true},{"id":"GPU-b97db201-0442-8531-56d4-367e0c7d6edd","index":1,"count":10,"devmem":49140,"devcore":100,"type":"NVIDIA-NVIDIA L40S","numa":0,"mode":"hami-core","health":true}] ``` ### Follow-Up diff --git a/versioned_docs/version-v2.9.0/developers/protocol.md b/versioned_docs/version-v2.9.0/developers/protocol.md index 36c77acc7..d8abf6b89 100644 --- a/versioned_docs/version-v2.9.0/developers/protocol.md +++ b/versioned_docs/version-v2.9.0/developers/protocol.md @@ -13,10 +13,10 @@ hami.io/node-handshake-\{device-type\}: Reported_\{device_node_current_timestamp hami.io/node-\{device-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\} ``` -The definition of each device is in the following format: +The device registration format depends on the device plugin. For NVIDIA devices, the registration annotation uses JSON with fields such as: ```text -\{Device UUID\},\{device split count\},\{device memory limit\},\{device core limit\},\{device type\},\{device numa\},\{healthy\} +{"id":"GPU-...","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true} ``` An example is shown below: @@ -25,7 +25,7 @@ An example is shown below: hami.io/node-handshake-nvidia: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895 hami.io/node-handshake-mlu: Requesting_2024.01.10 04:06:57 hami.io/node-mlu-register: MLU-45013011-2257-0000-0000-000000000000,10,23308,0,MLU-MLU370-X4,0,false:MLU-54043011-2257-0000-0000-000000000000,10,23308,0, -hami.io/node-nvidia-register: GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec,10,32768,100,NVIDIA-Tesla V100-PCIE-32GB,0,true:GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448,10,32768,100,NVIDIA-Tesla V100-PCIE-32GB,0,true: +hami.io/node-nvidia-register: [{"id":"GPU-00552014-5c87-89ac-b1a6-7b53aa24b0ec","count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true},{"id":"GPU-0fc3eda5-e98b-a25b-5b0d-cf5c855d1448","index":1,"count":10,"devmem":32768,"devcore":100,"type":"NVIDIA-Tesla V100-PCIE-32GB","mode":"hami-core","health":true}] ```