Merge pull request #71695 from openshift-cherrypick-robot/cherry-pick-71247-to-enterprise-4.15

[enterprise-4.15] CNV#30165: Updated hot plug NIC docs

Author: sjhala-ccs

modules/virt-hot-plugging-bridge-network-interface-cli.adoc

@@ -4,14 +4,15 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="virt-hot-plugging-bridge-network-interface_{context}"]
-= Hot plugging a bridge network interface using the CLI
+= Hot plugging a secondary network interface by using the CLI
 
-Hot plug a bridge network interface to a virtual machine (VM) while the VM is running.
+Hot plug a secondary network interface to a virtual machine (VM) while the VM is running.
 
 .Prerequisites
 
 * 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`).
 
 .Procedure
 
@@ -22,21 +23,45 @@ Hot plug a bridge network interface to a virtual machine (VM) while the VM is ru
 $ virtctl start <vm_name>
 ----
 
-. Use the following command to hot plug a new network interface to the running VM. The `virtctl addinterface` command adds the new network interface to the VM and virtual machine instance (VMI) specification but does not attach it to the running VM.
+. Use the following command to add the new network interface to the running VM. Editing the VM specification adds the new network interface to the VM and virtual machine instance (VMI) configuration but does not attach it to the running VM.
 +
 [source,terminal]
 ----
-$ virtctl addinterface <vm_name> --network-attachment-definition-name <net_attach_def_name> --name <interface_name>
+$ oc edit vm <vm_name>
 ----
 +
-where:
-
-<vm_name>:: Specifies the name of the `VirtualMachine` object.
-<net_attach_def_name>::  Specifies the name of `NetworkAttachmentDefinition` object.
-<interface_name>:: Specifies the name of the new network interface.
+.Example VM configuration
+[source,yaml]
+----
+apiVersion: kubevirt.io/v1
+kind: VirtualMachine
+metadata:
+  name: vm-fedora
+template:
+  spec:
+    domain:
+      devices:
+        interfaces:
+        - name: defaultnetwork
+          masquerade: {}
+        # new interface
+        - name: <secondary_nic> # <1>
+          bridge: {}
+    networks:
+    - name: defaultnetwork
+      pod: {}
+    # new network
+    - name: <secondary_nic> # <2>
+      multus:
+        networkName: <nad_name> # <3>
+# ...
+----
+<1> Specifies the name of the new network interface.
+<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 using the following command:
+. To attach the network interface to the running VM, live migrate the VM by running the following command:
 +
 [source,terminal]
 ----

modules/virt-hot-unplugging-bridge-network-interface-cli.adoc

@@ -4,9 +4,14 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="virt-hot-unplugging-bridge-network-interface_{context}"]
-= Hot unplugging a bridge network interface using the CLI
+= Hot unplugging a secondary network interface by using the CLI
 
-You can remove a bridge network interface from a running virtual machine (VM).
+You can remove a secondary network interface from a running virtual machine (VM).
+
+[NOTE]
+====
+Hot unplugging is not supported for Single Root I/O Virtualization (SR-IOV) interfaces.
+====
 
 .Prerequisites
 
@@ -16,12 +21,40 @@ You can remove a bridge network interface from a running virtual machine (VM).
 
 .Procedure
 
-. Hot unplug a bridge network interface by running the following command. The `virtctl removeinterface` command detaches the network interface from the guest, but the interface still exists in the pod.
+. Edit the VM specification to hot unplug a secondary network interface. Setting the interface state to `absent` detaches the network interface from the guest, but the interface still exists in the pod.
 +
 [source,terminal]
 ----
-$ virtctl removeinterface <vm_name> --name <interface_name>
+$ oc edit vm <vm_name>
+----
++
+.Example VM configuration
+[source,yaml]
+----
+apiVersion: kubevirt.io/v1
+kind: VirtualMachine
+metadata:
+  name: vm-fedora
+template:
+  spec:
+    domain:
+      devices:
+        interfaces:
+          - name: defaultnetwork
+            masquerade: {}
+          # set the interface state to absent 
+          - name: <secondary_nic>
+            state: absent # <1>
+            bridge: {}
+    networks:
+      - name: defaultnetwork
+        pod: {}
+      - name: <secondary_nic>
+        multus:
+          networkName: <nad_name>
+# ...
 ----
+<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:
 +

virt/vm_networking/virt-hot-plugging-network-interfaces.adoc

@@ -6,10 +6,12 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can add or remove secondary network interfaces without stopping your virtual machine (VM). {VirtProductName} supports hot plugging and hot unplugging for Linux bridge interfaces that use the VirtIO device driver.
+You can add or remove secondary network interfaces without stopping your virtual machine (VM). {VirtProductName} supports hot plugging for secondary interfaces that use the VirtIO device driver. 
 
-:FeatureName: Hot plugging and hot unplugging bridge network interfaces
-include::snippets/technology-preview.adoc[]
+[NOTE]
+====
+Hot unplugging is not supported for Single Root I/O Virtualization (SR-IOV) interfaces.
+====
 
 [id="virtio-limitations_virt-hot-plugging-network-interfaces"]
 == VirtIO limitations
@@ -31,4 +33,7 @@ include::modules/virt-hot-unplugging-bridge-network-interface-cli.adoc[leveloffs
 == Additional resources
 
 * xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Installing virtctl]
-* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#creating-linux-bridge-nad[Creating a Linux bridge network attachment definition]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#creating-linux-bridge-nad[Creating a Linux bridge network attachment definition]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#configuring-vm-network-interface[Connecting a virtual machine to a Linux bridge network]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-network-attachment_virt-connecting-vm-to-sriov[Creating an SR-IOV network attachment definition]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-attaching-vm-to-sriov-network_virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]