Skip to content

Commit 3491ca6

Browse files
committed
doc: fill in the content
Signed-off-by: Tim Liou <[email protected]>
1 parent 27cbad8 commit 3491ca6

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

docs/vm/nic-hotplug.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ keywords:
99
- virtual machine
1010
- Hotplug
1111
- NIC
12-
description: Create VM with CPU / Memory Hotplug
12+
description: Hotplug and hotunplug network interfaces to a running VM.
1313
---
1414

1515
<head>
@@ -20,11 +20,50 @@ _Available as of v1.7.0_
2020

2121
:::note
2222

23+
The virtual machine must be [live-migratable](./live-migration.md#live-migratable-virtual-machines).
24+
25+
For virtual machine created prior to v1.7.0, they are not allowed to perform NIC hotplug or hotunplug if there is a network interface configured without settings MAC address explicitly. Restart is required for them to enable NIC hotplug since the observed MAC addresses would be backfilled to the virtual machine configuration during the corresponding reconciliation steps.
26+
27+
Besides, virtual machines created by [Harvester node driver](../rancher/node/node-driver.md) are not allowed for hotplugging and hotunplugging.
28+
2329
:::
2430

2531
Harvester supports hotplugging and hotunplugging NICs to a live-migratable virtual machine. This feature allows you to add and remove NICs to a running virtual machine without requiring a reboot.
2632

2733
## Hotplug NICs to a Running VM
2834

35+
:::note
36+
37+
Only [VLAN network](../../networking/harvester-network.md#vlan-network), [untagged network](../../networking/harvester-network.md#untagged-network), [VLAN trunk network](../../networking/harvester-network.md#vlan-trunk-network) are supported for hotplugging.
38+
39+
:::
40+
41+
You can hotplug an interface to a network using the **Hotplug Network Interface** button.
42+
43+
![Hotplug Network Interface](/img/v1.7/nic-hotplug/hotplug-network-interface.png)
44+
45+
46+
Once you click **Apply**, Harvester [migrates the virtual machine](./live-migration.md#prerequisites) and the new `virtio` model interface would be connected through bridge binding.
47+
48+
49+
:::note
50+
51+
Be aware that there are limitations to the number of hotplugged interfaces. Please refer to [this KubeVirt documentation](https://kubevirt.io/user-guide/network/hotplug_interfaces/#virtio-limitations).
52+
53+
:::
2954

3055
## Hotunplug NICs from a Running VM
56+
57+
:::note
58+
59+
Hot-unplug is only supported for interfaces connected through bridge binding.
60+
If there is only single network interface left, it's not allowed to be hotunplugged.
61+
62+
:::
63+
64+
Navigate to the **Networks** tab of the detail page of a virtual machine. **Detach Network Interface** button can be used to hotunplug the interface.
65+
66+
67+
![Hotunplug Network Interface](/img/v1.7/nic-hotplug/hotunplug-network-interface.png)
68+
69+
Once you click it, Harvester [migrates the virtual machine](./live-migration.md#prerequisites) and the interface would be detached.
29.3 KB
Loading
130 KB
Loading

0 commit comments

Comments
 (0)