Merge pull request #62619 from apinnick/cnv-network-reorganization

Move VM network docs

Author: apinnick

_topic_maps/_topic_map.yml

@@ -3723,32 +3723,6 @@ Topics:
       File: virt-cloning-vm-using-datavolumetemplate
     - Name: Cloning a virtual machine disk into a new block storage persistent volume claim
       File: virt-cloning-vm-disk-into-new-block-storage-pvc
-# Virtual machine networking
-  - Name: Virtual machine networking
-    Dir: vm_networking
-    Topics:
-    - Name: Configuring a virtual machine for the default pod network
-      File: virt-using-the-default-pod-network-with-virt
-      Distros: openshift-enterprise
-    - Name: Configuring a virtual machine for the default pod network with OKD Virtualization
-      File: virt-using-the-default-pod-network-with-virt
-      Distros: openshift-origin
-    - Name: Creating a service to expose a virtual machine
-      File: virt-creating-service-vm
-    - Name: Connecting a virtual machine to a Linux bridge network
-      File: virt-attaching-vm-multiple-networks
-    - Name: Connecting a virtual machine to an SR-IOV network
-      File: virt-attaching-vm-to-sriov-network
-    - Name: Connecting a virtual machine to a service mesh
-      File: virt-connecting-vm-to-service-mesh
-    - Name: Configuring IP addresses for virtual machines
-      File: virt-configuring-ip-for-vms
-    - Name: Viewing the IP address of NICs on a virtual machine
-      File: virt-viewing-ip-of-vm-nic
-    - Name: Accessing a virtual machine on a secondary network by using the cluster domain name
-      File: virt-accessing-vm-secondary-network-fqdn
-    - Name: Using a MAC address pool for virtual machines
-      File: virt-using-mac-address-pool-for-vms
 #A BETTER NAME THAN 'STORAGE 4 U'
   - Name: Virtual machine disks
     Dir: virtual_disks
@@ -3789,6 +3763,29 @@ Topics:
       File: virt-reusing-statically-provisioned-persistent-volumes
     - Name: Expanding a virtual machine disk
       File: virt-expanding-vm-disk
+- Name: Networking
+  Dir: vm_networking
+  Topics:
+  - Name: Connecting a VM to the default pod network
+    File: virt-connecting-vm-to-default-pod-network
+  - Name: Exposing a VM by using a service
+    File: virt-exposing-vm-with-service
+  - Name: Connecting a VM to a Linux bridge network
+    File: virt-connecting-vm-to-linux-bridge
+  - Name: Connecting a VM to an SR-IOV network
+    File: virt-connecting-vm-to-sriov
+  - Name: Using DPDK with SR-IOV
+    File: virt-using-dpdk-with-sriov
+  - Name: Connecting a VM to a service mesh
+    File: virt-connecting-vm-to-service-mesh
+  - Name: Configuring a dedicated network for live migration
+    File: virt-dedicated-network-live-migration
+  - Name: Configuring and viewing IP addresses
+    File: virt-configuring-viewing-ips-for-vms
+  - Name: Accessing a VM by using the cluster FQDN
+    File: virt-accessing-vm-secondary-network-fqdn
+  - Name: Managing MAC address pools for network interfaces
+    File: virt-using-mac-address-pool-for-vms
 # Templates
 - Name: Virtual machine templates
   Dir: vm_templates
@@ -3818,8 +3815,6 @@ Topics:
     File: virt-live-migration-limits
   - Name: Migrating a virtual machine instance to another node
     File: virt-migrate-vmi
-  - Name: Migrating a virtual machine over a dedicated additional network
-    File: virt-migrating-vm-on-secondary-network
   - Name: Cancelling the live migration of a virtual machine instance
     File: virt-cancel-vmi-migration
   - Name: Configuring virtual machine eviction strategy
@@ -3845,7 +3840,7 @@ Topics:
   Topics:
   - Name: Monitoring overview
     File: virt-monitoring-overview
-  - Name: OpenShift cluster checkup framework
+  - Name: Cluster checkup framework
     File: virt-running-cluster-checkups
   - Name: Prometheus queries for virtual resources
     File: virt-prometheus-queries

installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc

@@ -20,7 +20,7 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
 * xref:../../virt/getting_started/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}]
 * xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
 * xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
-* xref:../../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Connecting a virtual machine to an SR-IOV network]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
 
 include::modules/nw-sriov-dual-nic-con.adoc[leveloffset=+1]
 

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

@@ -28,7 +28,7 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
 
 * xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
 * xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
-* xref:../../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Connecting a virtual machine to an SR-IOV network]
+* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
 
 include::modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc[leveloffset=+1]
 

modules/nw-multus-ipam-object.adoc

@@ -2,7 +2,7 @@
 //
 // * networking/multiple_networks/configuring-additional-network.adoc
 // * networking/hardware_networks/configuring-sriov-net-attach.adoc
-// * virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc
+// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
 
 // Because the Cluster Network Operator abstracts the configuration for
 // Macvlan, including IPAM configuration, this must be provided as YAML
@@ -242,20 +242,20 @@ ifdef::sr-iov[]
 endif::[]
 
 [id="nw-multus-creating-whereabouts-reconciler-daemon-set_{context}"]
-== Creating a Whereabouts reconciler daemon set 
+== Creating a Whereabouts reconciler daemon set
 
 The Whereabouts reconciler is responsible for managing dynamic IP address assignments for the pods within a cluster using the Whereabouts IP Address Management (IPAM) solution. It ensures that each pods gets a unique IP address from the specified IP address range. It also handles IP address releases when pods are deleted or scaled down.
 
 [NOTE]
 ====
-You can also use a `NetworkAttachmentDefinition` custom resource for dynamic IP address assignment. 
+You can also use a `NetworkAttachmentDefinition` custom resource for dynamic IP address assignment.
 ====
 
-The Whereabouts reconciler daemon set is automatically created when you configure an additional network through the Cluster Network Operator. It is not automatically created when you configure an additional network from a YAML manifest. 
+The Whereabouts reconciler daemon set is automatically created when you configure an additional network through the Cluster Network Operator. It is not automatically created when you configure an additional network from a YAML manifest.
 
 To trigger the deployment of the Whereabouts reconciler daemonset, you must manually create a `whereabouts-shim` network attachment by editing the Cluster Network Operator custom resource file.
 
-Use the following procedure to deploy the Whereabouts reconciler daemonset. 
+Use the following procedure to deploy the Whereabouts reconciler daemonset.
 
 .Procedure
 

modules/nw-sriov-add-pod-runtimeconfig.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/node_network/virt-configuring-sr-iov-network.adoc
-// * virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc
+// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
 
 // Deprecating in OCP; This is identical in practice to adding a pod
 // to an additional network.

modules/nw-sriov-configuring-device.adoc

@@ -1,13 +1,13 @@
 // Module included in the following assemblies:
 //
 // * networking/hardware_networks/configuring-sriov-device.adoc
-// * virt/vm_networking/virt-attaching-vm-to-sriov-network.adoc
+// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
 
 ifeval::["{context}" == "configuring-sriov-device"]
 :ocp-sriov:
 endif::[]
 
-ifeval::["{context}" == "virt-attaching-vm-to-sriov-network"]
+ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
 :virt-sriov:
 endif::[]
 
@@ -105,3 +105,11 @@ After applying the configuration update, all the pods in `sriov-network-operator
 ----
 $ oc get sriovnetworknodestates -n openshift-sriov-network-operator <node_name> -o jsonpath='{.status.syncStatus}'
 ----
+
+ifdef::virt-sriov[]
+:!virt-sriov:
+endif::[]
+
+ifdef::ocp-sriov[]
+:!ocp-sriov:
+endif::[]

modules/nw-sriov-device-discovery.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * networking/hardware_networks/about-sriov.adoc
-// * virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc
+// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
 
 [id="discover-sr-iov-devices_{context}"]
 = Automated discovery of SR-IOV network devices

modules/nw-sriov-network-attachment.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * networking/hardware_networks/configuring-sriov-net-attach.adoc
-// * virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc
+// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
 
 // Note: IB does not support ipam with `type=dhcp`.
 
@@ -17,7 +17,7 @@ ifeval::["{context}" == "configuring-sriov-ib-attach"]
 :object: pods
 endif::[]
 
-ifeval::["{context}" == "virt-attaching-vm-to-sriov-network"]
+ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
 :rs: SriovNetwork
 :virt-sriov-net:
 :object: pods or virtual machines
@@ -191,10 +191,10 @@ ifdef::rs[]
 :!rs:
 endif::[]
 
-ifdef::virt-sriov-net[]
+ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
 :!virt-sriov-net:
 endif::[]
 
-ifdef::ocp-sriov-net[]
+ifeval::["{context}" == "configuring-sriov-net-attach"]
 :!ocp-sriov-net:
 endif::[]

modules/nw-sriov-network-object.adoc

@@ -13,7 +13,7 @@ ifeval::["{context}" == "configuring-sriov-net-attach"]
 :object: pods
 endif::[]
 
-ifeval::["{context}" == "virt-defining-an-sriov-network"]
+ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
 :virt-sriov-net:
 :object: pods or virtual machines
 endif::[]
@@ -85,9 +85,9 @@ endif::ocp-sriov-net[]
 ifdef::object[]
 :object!:
 endif::[]
-ifdef::ocp-sriov-net[]
+ifeval::["{context}" == "configuring-sriov-net-attach"]
 :ocp-sriov-net!:
 endif::[]
-ifdef::virt-sriov-net[]
+ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
 :virt-sriov-net!:
 endif::[]

modules/virt-about-cluster-checkup-framework.adoc

@@ -1,10 +1,10 @@
 // Module included in the following assemblies:
 //
-// * virt/support/virt-running-cluster-checkups.adoc
+// * virt/monitoring/virt-running-cluster-checkups.adoc
 
 :_content-type: CONCEPT
 [id="virt-about-cluster-checkup-framework_{context}"]
-= About the {product-title} cluster checkup framework
+= About the {VirtProductName} cluster checkup framework
 
 A _checkup_ is an automated test workload that allows you to verify if a specific cluster functionality works as expected. The cluster checkup framework uses native Kubernetes resources to configure and execute the checkup.