Skip to content

CNV-62386: Updated VM NIC hot plug/unplug docs #96190

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −8
Open

CNV-62386: Updated VM NIC hot plug/unplug docs #96190

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
12 changes: 7 additions & 5 deletions modules/virt-hot-plugging-bridge-network-interface-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ Hot plug a secondary network interface to a virtual machine (VM) while the VM is

* A network attachment definition is configured in the same namespace as your VM.
* You have installed the `virtctl` tool.
* You have installed the OpenShift CLI (`oc`).
* You have permission to create and list `VirtualMachineInstanceMigration` objects.
* You have installed the {oc-first}.

.Procedure

Expand Down Expand Up @@ -61,13 +60,16 @@ template:
<2> Specifies the name of the network. This must be the same as the `name` of the new network interface that you defined in the `template.spec.domain.devices.interfaces` list.
<3> Specifies the name of the `NetworkAttachmentDefinition` object.


. To attach the network interface to the running VM, live migrate the VM by running the following command:
. Run the following command for the new configuration to take effect. Applying the changes triggers automatic VM live migration and attaches the network interface to the running VM.
+
[source,terminal]
----
$ virtctl migrate <vm_name>
$ oc apply -f <filename>.yaml
----
+
where:

<filename>:: Specifies the name of your `VirtualMachine` manifest YAML file.

.Verification

Expand Down
9 changes: 6 additions & 3 deletions modules/virt-hot-unplugging-bridge-network-interface-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Hot unplugging is not supported for Single Root I/O Virtualization (SR-IOV) inte
* Your VM must be running.
* The VM must be created on a cluster running {VirtProductName} 4.14 or later.
* The VM must have a bridge network interface attached.
* You have permission to create and list `VirtualMachineInstanceMigration` objects.
* You have installed the {oc-first}.

.Procedure
Expand Down Expand Up @@ -58,9 +57,13 @@ template:
----
<1> Set the interface state to `absent` to detach it from the running VM. Removing the interface details from the VM specification does not hot unplug the secondary network interface.

. Remove the interface from the pod by migrating the VM:
. Run the following command for the new configuration to take effect. Applying the changes triggers automatic VM live migration and removes the interface from the pod.
+
[source,terminal]
----
$ virtctl migrate <vm_name>
$ oc apply -f <filename>.yaml
----
+
where:

<filename>:: Specifies the name of your `VirtualMachine` manifest YAML file.