Skip to content

Commit 83822b5

Browse files
committed
docs: add VM restart and addon management warnings for PCI devices
- Add warning to restart VMs immediately after modifying PCI/vGPU devices - Document annotation to skip addon disable check when VMs are stopped with devices attached - Explain synchronization importance between VM spec and running state Signed-off-by: Jack Yu <[email protected]>
1 parent b47668b commit 83822b5

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/advanced/addons/nvidiadrivertoolkit.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ On pod startup, the ENTRYPOINT script will download the NVIDIA driver from the s
3232

3333
The `PCIDevices` addon can now leverage this addon to manage the lifecycle of the vGPU devices on nodes containing supported GPU [devices](../vgpusupport.md).
3434

35+
:::warning
36+
37+
**Always restart the VM immediately after attaching or detaching vGPU devices.**
38+
39+
Although rebooting the VM after editing its spec is not mandatory, we strongly recommend doing so to ensure proper synchronization. Without an immediate reboot, the addon disable check might not accurately detect devices in use.
40+
41+
If you need to disable and re-enable the `nvidia-driver-toolkit` addon while VMs are stopped with host devices attached, you can annotate the addon with `harvesterhci.io/skipNvidiaDriverToolkitAddonWebhookCheck` to skip the addon disable check.
42+
43+
:::
44+
3545
## Install Different NVIDIA Driver Versions
3646

3747
_Available as of v1.7.0_

docs/advanced/addons/pcidevices.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ Select **PCI Devices** and use the **Available PCI Devices** drop-down. Select t
5353

5454
![](/img/v1.2/pcidevices/vm-pcidevices-attach.png)
5555

56+
:::warning
57+
58+
**Always restart the VM immediately after adding or removing PCI devices.**
59+
60+
Although rebooting the VM after editing its spec is not mandatory, we strongly recommend doing so to ensure proper synchronization. Without an immediate reboot, the addon disable check might not accurately detect devices in use.
61+
62+
If you need to disable and re-enable the `pcidevices-controller` addon while VMs are stopped with host devices attached, you can annotate the addon with `harvesterhci.io/skipPCIDevicesControllerAddonWebhookCheck` to skip the addon disable check.
63+
64+
:::
5665

5766
## Using a passed-through PCI Device inside the VM
5867

0 commit comments

Comments
 (0)