Skip to content

Commit ea581c7

Browse files
committed
Move VM network docs
Signed-off-by: Avital Pinnick <[email protected]>
1 parent fa52eea commit ea581c7

File tree

77 files changed

+618
-530
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+618
-530
lines changed

_topic_maps/_topic_map.yml

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3711,32 +3711,6 @@ Topics:
37113711
File: virt-cloning-vm-using-datavolumetemplate
37123712
- Name: Cloning a virtual machine disk into a new block storage persistent volume claim
37133713
File: virt-cloning-vm-disk-into-new-block-storage-pvc
3714-
# Virtual machine networking
3715-
- Name: Virtual machine networking
3716-
Dir: vm_networking
3717-
Topics:
3718-
- Name: Configuring a virtual machine for the default pod network
3719-
File: virt-using-the-default-pod-network-with-virt
3720-
Distros: openshift-enterprise
3721-
- Name: Configuring a virtual machine for the default pod network with OKD Virtualization
3722-
File: virt-using-the-default-pod-network-with-virt
3723-
Distros: openshift-origin
3724-
- Name: Creating a service to expose a virtual machine
3725-
File: virt-creating-service-vm
3726-
- Name: Connecting a virtual machine to a Linux bridge network
3727-
File: virt-attaching-vm-multiple-networks
3728-
- Name: Connecting a virtual machine to an SR-IOV network
3729-
File: virt-attaching-vm-to-sriov-network
3730-
- Name: Connecting a virtual machine to a service mesh
3731-
File: virt-connecting-vm-to-service-mesh
3732-
- Name: Configuring IP addresses for virtual machines
3733-
File: virt-configuring-ip-for-vms
3734-
- Name: Viewing the IP address of NICs on a virtual machine
3735-
File: virt-viewing-ip-of-vm-nic
3736-
- Name: Accessing a virtual machine on a secondary network by using the cluster domain name
3737-
File: virt-accessing-vm-secondary-network-fqdn
3738-
- Name: Using a MAC address pool for virtual machines
3739-
File: virt-using-mac-address-pool-for-vms
37403714
#A BETTER NAME THAN 'STORAGE 4 U'
37413715
- Name: Virtual machine disks
37423716
Dir: virtual_disks
@@ -3777,6 +3751,29 @@ Topics:
37773751
File: virt-reusing-statically-provisioned-persistent-volumes
37783752
- Name: Expanding a virtual machine disk
37793753
File: virt-expanding-vm-disk
3754+
- Name: Networking
3755+
Dir: vm_networking
3756+
Topics:
3757+
- Name: Connecting a VM to the default pod network
3758+
File: virt-connecting-vm-to-default-pod-network
3759+
- Name: Exposing a VM by using a service
3760+
File: virt-exposing-vm-with-service
3761+
- Name: Connecting a VM to a Linux bridge network
3762+
File: virt-connecting-vm-to-linux-bridge
3763+
- Name: Connecting a VM to an SR-IOV network
3764+
File: virt-connecting-vm-to-sriov
3765+
- Name: Using DPDK with SR-IOV
3766+
File: virt-using-dpdk-with-sriov
3767+
- Name: Connecting a VM to a service mesh
3768+
File: virt-connecting-vm-to-service-mesh
3769+
- Name: Configuring a dedicated network for live migration
3770+
File: virt-dedicated-network-live-migration
3771+
- Name: Configuring and viewing IP addresses
3772+
File: virt-configuring-viewing-ips-for-vms
3773+
- Name: Accessing a VM by using the cluster FQDN
3774+
File: virt-accessing-vm-secondary-network-fqdn
3775+
- Name: Managing MAC address pools for network interfaces
3776+
File: virt-using-mac-address-pool-for-vms
37803777
# Templates
37813778
- Name: Virtual machine templates
37823779
Dir: vm_templates
@@ -3806,8 +3803,6 @@ Topics:
38063803
File: virt-live-migration-limits
38073804
- Name: Migrating a virtual machine instance to another node
38083805
File: virt-migrate-vmi
3809-
- Name: Migrating a virtual machine over a dedicated additional network
3810-
File: virt-migrating-vm-on-secondary-network
38113806
- Name: Cancelling the live migration of a virtual machine instance
38123807
File: virt-cancel-vmi-migration
38133808
- Name: Configuring virtual machine eviction strategy
@@ -3833,7 +3828,7 @@ Topics:
38333828
Topics:
38343829
- Name: Monitoring overview
38353830
File: virt-monitoring-overview
3836-
- Name: OpenShift cluster checkup framework
3831+
- Name: Cluster checkup framework
38373832
File: virt-running-cluster-checkups
38383833
- Name: Prometheus queries for virtual resources
38393834
File: virt-prometheus-queries

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
2020
* xref:../../virt/getting_started/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}]
2121
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
2222
* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
23-
* 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]
23+
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
2424

2525
include::modules/nw-sriov-dual-nic-con.adoc[leveloffset=+1]
2626

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
2828

2929
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
3030
* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
31-
* 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]
31+
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
3232
3333
include::modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc[leveloffset=+1]
3434

modules/nw-multus-ipam-object.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * networking/multiple_networks/configuring-additional-network.adoc
44
// * networking/hardware_networks/configuring-sriov-net-attach.adoc
5-
// * virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc
5+
// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
66

77
// Because the Cluster Network Operator abstracts the configuration for
88
// Macvlan, including IPAM configuration, this must be provided as YAML
@@ -242,20 +242,20 @@ ifdef::sr-iov[]
242242
endif::[]
243243

244244
[id="nw-multus-creating-whereabouts-reconciler-daemon-set_{context}"]
245-
== Creating a Whereabouts reconciler daemon set
245+
== Creating a Whereabouts reconciler daemon set
246246

247247
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.
248248

249249
[NOTE]
250250
====
251-
You can also use a `NetworkAttachmentDefinition` custom resource for dynamic IP address assignment.
251+
You can also use a `NetworkAttachmentDefinition` custom resource for dynamic IP address assignment.
252252
====
253253

254-
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.
254+
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.
255255

256256
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.
257257

258-
Use the following procedure to deploy the Whereabouts reconciler daemonset.
258+
Use the following procedure to deploy the Whereabouts reconciler daemonset.
259259

260260
.Procedure
261261

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * virt/node_network/virt-configuring-sr-iov-network.adoc
4-
// * virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc
4+
// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
55

66
// Deprecating in OCP; This is identical in practice to adding a pod
77
// to an additional network.

modules/nw-sriov-configuring-device.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/hardware_networks/configuring-sriov-device.adoc
4-
// * virt/vm_networking/virt-attaching-vm-to-sriov-network.adoc
4+
// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
55

66
ifeval::["{context}" == "configuring-sriov-device"]
77
:ocp-sriov:
88
endif::[]
99

10-
ifeval::["{context}" == "virt-attaching-vm-to-sriov-network"]
10+
ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
1111
:virt-sriov:
1212
endif::[]
1313

@@ -105,3 +105,11 @@ After applying the configuration update, all the pods in `sriov-network-operator
105105
----
106106
$ oc get sriovnetworknodestates -n openshift-sriov-network-operator <node_name> -o jsonpath='{.status.syncStatus}'
107107
----
108+
109+
ifdef::virt-sriov[]
110+
:!virt-sriov:
111+
endif::[]
112+
113+
ifdef::ocp-sriov[]
114+
:!ocp-sriov:
115+
endif::[]

modules/nw-sriov-device-discovery.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/hardware_networks/about-sriov.adoc
4-
// * virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc
4+
// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
55

66
[id="discover-sr-iov-devices_{context}"]
77
= Automated discovery of SR-IOV network devices

modules/nw-sriov-network-attachment.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/hardware_networks/configuring-sriov-net-attach.adoc
4-
// * virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc
4+
// * virt/vm_networking/virt-connecting-vm-to-sriov.adoc
55

66
// Note: IB does not support ipam with `type=dhcp`.
77

@@ -17,7 +17,7 @@ ifeval::["{context}" == "configuring-sriov-ib-attach"]
1717
:object: pods
1818
endif::[]
1919

20-
ifeval::["{context}" == "virt-attaching-vm-to-sriov-network"]
20+
ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
2121
:rs: SriovNetwork
2222
:virt-sriov-net:
2323
:object: pods or virtual machines
@@ -191,10 +191,10 @@ ifdef::rs[]
191191
:!rs:
192192
endif::[]
193193

194-
ifdef::virt-sriov-net[]
194+
ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
195195
:!virt-sriov-net:
196196
endif::[]
197197

198-
ifdef::ocp-sriov-net[]
198+
ifeval::["{context}" == "configuring-sriov-net-attach"]
199199
:!ocp-sriov-net:
200200
endif::[]

modules/nw-sriov-network-object.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ifeval::["{context}" == "configuring-sriov-net-attach"]
1313
:object: pods
1414
endif::[]
1515

16-
ifeval::["{context}" == "virt-defining-an-sriov-network"]
16+
ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
1717
:virt-sriov-net:
1818
:object: pods or virtual machines
1919
endif::[]
@@ -85,9 +85,9 @@ endif::ocp-sriov-net[]
8585
ifdef::object[]
8686
:object!:
8787
endif::[]
88-
ifdef::ocp-sriov-net[]
88+
ifeval::["{context}" == "configuring-sriov-net-attach"]
8989
:ocp-sriov-net!:
9090
endif::[]
91-
ifdef::virt-sriov-net[]
91+
ifeval::["{context}" == "virt-connecting-vm-to-sriov"]
9292
:virt-sriov-net!:
9393
endif::[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/support/virt-running-cluster-checkups.adoc
3+
// * virt/monitoring/virt-running-cluster-checkups.adoc
44

55
:_content-type: CONCEPT
66
[id="virt-about-cluster-checkup-framework_{context}"]
7-
= About the {product-title} cluster checkup framework
7+
= About the {VirtProductName} cluster checkup framework
88

99
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.
1010

0 commit comments

Comments
 (0)