Skip to content

docs: add VM restart and addon management warnings for PCI devices #973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yu-Jack wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add VM restart and addon management warnings for PCI devices #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/advanced/addons/nvidiadrivertoolkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ On pod startup, the ENTRYPOINT script will download the NVIDIA driver from the s

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

Copy link
Member

@w13915984028 w13915984028 Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar, L34 about the new check when disabling addon

:::warning

**Always restart the VM immediately after attaching or detaching vGPU devices.**

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.
Copy link
Member

@w13915984028 w13915984028 Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instant rebooting helps check on addon rebooting, also avoids potential resources conflicts even when addon is still enabled


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.

:::

## Install Different NVIDIA Driver Versions

_Available as of v1.7.0_
Expand Down
9 changes: 9 additions & 0 deletions docs/advanced/addons/pcidevices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ Select **PCI Devices** and use the **Available PCI Devices** drop-down. Select t

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

:::warning

**Always restart the VM immediately after adding or removing PCI devices.**

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.

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.

:::

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

Expand Down