lxd-metadata: update metadata

Signed-off-by: Gabriel Mougard <[email protected]>
canonical · Aug 23, 2024 · 893687a · 893687a
1 parent ced5baa
commit 893687a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/doc/metadata.txt b/doc/metadata.txt
@@ -275,9 +275,15 @@ You can omit the `MIG-` prefix when specifying this option.
 ```
 
 ```{config:option} id device-gpu-physical-device-conf
-:shortdesc: "DRM card ID of the GPU device"
+:shortdesc: "ID of the GPU device"
 :type: "string"
+The ID can either be the DRM card ID of the GPU device (container or VM) or a fully-qualified Container Device Interface (CDI) name (container only).
+Here are some examples of fully-qualified CDI names:
 
+- `nvidia.com/gpu=0`: Instructs LXD to operate a discrete GPU (dGPU) pass-through of brand NVIDIA with the first discovered GPU on your system. You can use the `nvidia-smi` tool on your host to find out which identifier to use.
+- `nvidia.com/gpu=1833c8b5-9aa0-5382-b784-68b7e77eb185`: Instructs LXD to operate a discrete GPU (dGPU) pass-through of brand NVIDIA with a given GPU unique identifier. This identifier should also appear with `nvidia-smi -L`.
+- `nvidia.com/igpu=all`: Instructs LXD to pass all the host integrated GPUs (iGPU) of brand NVIDIA. The concept of an index does not currently map to iGPUs. It is possible to list them with the `nvidia-smi -L` command. A special `nvgpu` mention should appear in the generated list to indicate a device to be an iGPU.
+- `nvidia.com/gpu=all`: Instructs LXD to pass all the host GPUs of brand NVIDIA through to the container.
 ```
 
 ```{config:option} mode device-gpu-physical-device-conf

diff --git a/lxd/metadata/configuration.json b/lxd/metadata/configuration.json
@@ -315,8 +315,8 @@
 					},
 					{
 						"id": {
-							"longdesc": "",
-							"shortdesc": "DRM card ID of the GPU device",
+							"longdesc": "The ID can either be the DRM card ID of the GPU device (container or VM) or a fully-qualified Container Device Interface (CDI) name (container only).\nHere are some examples of fully-qualified CDI names:\n\n- `nvidia.com/gpu=0`: Instructs LXD to operate a discrete GPU (dGPU) pass-through of brand NVIDIA with the first discovered GPU on your system. You can use the `nvidia-smi` tool on your host to find out which identifier to use.\n- `nvidia.com/gpu=1833c8b5-9aa0-5382-b784-68b7e77eb185`: Instructs LXD to operate a discrete GPU (dGPU) pass-through of brand NVIDIA with a given GPU unique identifier. This identifier should also appear with `nvidia-smi -L`.\n- `nvidia.com/igpu=all`: Instructs LXD to pass all the host integrated GPUs (iGPU) of brand NVIDIA. The concept of an index does not currently map to iGPUs. It is possible to list them with the `nvidia-smi -L` command. A special `nvgpu` mention should appear in the generated list to indicate a device to be an iGPU.\n- `nvidia.com/gpu=all`: Instructs LXD to pass all the host GPUs of brand NVIDIA through to the container.",
+							"shortdesc": "ID of the GPU device",
 							"type": "string"
 						}
 					},