Skip to content

Commit 7e6da65

Browse files
authored
Merge pull request #54126 from apinnick/CNV-18880-update-vm-network-sriov
CNV-18880: Update virt SR-IOV network
2 parents 181de00 + 5792fc0 commit 7e6da65

15 files changed

+48
-108
lines changed

_topic_maps/_topic_map.yml

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3442,26 +3442,22 @@ Topics:
34423442
- Name: Virtual machine networking
34433443
Dir: vm_networking
34443444
Topics:
3445-
- Name: Configuring the virtual machine for the default pod network
3445+
- Name: Configuring a virtual machine for the default pod network
34463446
File: virt-using-the-default-pod-network-with-virt
34473447
Distros: openshift-enterprise
3448-
- Name: Configuring the virtual machine for the default pod network with OKD Virtualization
3448+
- Name: Configuring a virtual machine for the default pod network with OKD Virtualization
34493449
File: virt-using-the-default-pod-network-with-virt
34503450
Distros: openshift-origin
34513451
- Name: Creating a service to expose a virtual machine
34523452
File: virt-creating-service-vm
3453-
- Name: Attaching a virtual machine to a Linux bridge network
3453+
- Name: Connecting a virtual machine to a Linux bridge network
34543454
File: virt-attaching-vm-multiple-networks
3455+
- Name: Connecting a virtual machine to an SR-IOV network
3456+
File: virt-attaching-vm-to-sriov-network
3457+
- Name: Connecting a virtual machine to a service mesh
3458+
File: virt-connecting-vm-to-service-mesh
34553459
- Name: Configuring IP addresses for virtual machines
34563460
File: virt-configuring-ip-for-vms
3457-
- Name: Configuring an SR-IOV network device for virtual machines
3458-
File: virt-configuring-sriov-device-for-vms
3459-
- Name: Connecting virtual machines to a service mesh
3460-
File: virt-connecting-vm-to-service-mesh
3461-
- Name: Defining an SR-IOV network
3462-
File: virt-defining-an-sriov-network
3463-
- Name: Attaching a virtual machine to an SR-IOV network
3464-
File: virt-attaching-vm-to-sriov-network
34653461
- Name: Viewing the IP address of NICs on a virtual machine
34663462
File: virt-viewing-ip-of-vm-nic
34673463
- Name: Using a MAC address pool for virtual machines

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
@@ -19,7 +19,7 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
1919

2020
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
2121
* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
22-
* xref:../../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring an SR-IOV network device for virtual machines]
22+
* 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]
2323

2424
[id="choosing-a-method-to-install-ocp-on-bare-metal"]
2525
== Choosing a method to install {product-title} on bare metal

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-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring an SR-IOV network device for virtual machines]
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]
3232
3333
include::modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc[leveloffset=+1]
3434

modules/nw-sriov-configuring-device.adoc

Lines changed: 2 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/node_network/virt-configuring-sriov-device-for-vms.adoc
4+
// * virt/vm_networking/virt-attaching-vm-to-sriov-network.adoc
55

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

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

modules/nw-sriov-network-attachment.adoc

Lines changed: 8 additions & 15 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-defining-an-sriov-network.adoc
4+
// * virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.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-defining-an-sriov-network"]
20+
ifeval::["{context}" == "virt-attaching-vm-to-sriov-network"]
2121
:rs: SriovNetwork
2222
:virt-sriov-net:
2323
:object: pods or virtual machines
@@ -28,16 +28,12 @@ ifdef::ocp-sriov-net[]
2828
[id="nw-sriov-network-attachment_{context}"]
2929
= Configuring SR-IOV additional network
3030

31-
You can configure an additional network that uses SR-IOV hardware by creating a `{rs}` object.
32-
When you create a `{rs}` object, the SR-IOV Operator automatically creates a `NetworkAttachmentDefinition` object.
33-
34-
ifdef::virt-sriov-net[]
35-
Users can then attach virtual machines to the SR-IOV network by specifying the network in the virtual machine configurations.
36-
endif::virt-sriov-net[]
31+
You can configure an additional network that uses SR-IOV hardware by creating an `{rs}` object.
32+
When you create an `{rs}` object, the SR-IOV Network Operator automatically creates a `NetworkAttachmentDefinition` object.
3733

3834
[NOTE]
3935
=====
40-
Do not modify or delete a `{rs}` object if it is attached to any {object} in the `running` state.
36+
Do not modify or delete an `{rs}` object if it is attached to any {object} in a `running` state.
4137
=====
4238

4339
.Prerequisites
@@ -91,16 +87,13 @@ ifdef::virt-sriov-net[]
9187
[id="nw-sriov-network-attachment_{context}"]
9288
= Configuring SR-IOV additional network
9389

94-
You can configure an additional network that uses SR-IOV hardware by creating a `SriovNetwork` object.
95-
When you create a `SriovNetwork` object, the SR-IOV Operator automatically creates a `NetworkAttachmentDefinition` object.
90+
You can configure an additional network that uses SR-IOV hardware by creating an `{rs}` object.
9691

97-
ifdef::virt-sriov-net[]
98-
Users can then attach virtual machines to the SR-IOV network by specifying the network in the virtual machine configurations.
92+
When you create an `{rs}` object, the SR-IOV Network Operator automatically creates a `NetworkAttachmentDefinition` object.
9993

100-
endif::virt-sriov-net[]
10194
[NOTE]
10295
=====
103-
Do not modify or delete a `SriovNetwork` object if it is attached to any {object} in the `running` state.
96+
Do not modify or delete an `{rs}` object if it is attached to {object} in a `running` state.
10497
=====
10598

10699
.Prerequisites

modules/virt-attaching-vm-to-sriov-network.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
:_content-type: PROCEDURE
66
[id="virt-attaching-vm-to-sriov-network_{context}"]
7-
= Attaching a virtual machine to an SR-IOV network
7+
= Connecting a virtual machine to an SR-IOV network
88

9-
You can attach the virtual machine to the SR-IOV network by including the network details in the virtual machine configuration.
9+
You can connect the virtual machine (VM) to the SR-IOV network by including the network details in the VM configuration.
1010

1111
.Procedure
1212

13-
. Include the SR-IOV network details in the `spec.domain.devices.interfaces` and `spec.networks` of the virtual machine configuration:
13+
. Include the SR-IOV network details in the `spec.domain.devices.interfaces` and `spec.networks` of the VM configuration:
1414
+
1515
[source,yaml]
1616
----

networking/hardware_networks/about-sriov.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,6 @@ include::modules/nw-sriov-huge-pages.adoc[leveloffset=+2]
8989
* xref:../../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
9090
* Optional: xref:../../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
9191
* xref:../../networking/hardware_networks/configuring-sriov-device.adoc#configuring-sriov-device[Configuring an SR-IOV network device]
92-
* If you use {VirtProductName}: xref:../../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring an SR-IOV network device for virtual machines]
92+
* If you use {VirtProductName}: 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]
9393
* xref:../../networking/hardware_networks/configuring-sriov-net-attach.adoc#configuring-sriov-net-attach[Configuring an SR-IOV network attachment]
9494
* xref:../../networking/hardware_networks/add-pod.adoc#add-pod[Adding a pod to an SR-IOV additional network]

virt/virt-getting-started.adoc

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,6 @@ Plan and install {VirtProductName} on an {product-title} cluster:
3333
* xref:../virt/virtual_machines/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines].
3434
* xref:../virt/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[`Virtctl` commands].
3535

36-
[id='configuring-networks_{context}']
37-
=== Configuring secondary networks
38-
39-
Configuring a secondary network is optional. VMs are connected to the default pod network.
40-
41-
Configure a Linux bridge network:
42-
43-
* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nncp_virt-attaching-vm-multiple-networks[Create a node network configuration policy].
44-
* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-creating-linux-bridge-nad-web_virt-attaching-vm-multiple-networks[Create a network attachment definition for the Linux bridge network].
45-
* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-vm-creating-nic-web_virt-attaching-vm-multiple-networks[Attach a VM to the Linux bridge network].
46-
47-
Configure an SR-IOV network:
48-
49-
* xref:../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[Install the SR-IOV Operator].
50-
* xref:../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configure an SR-IOV network device].
51-
* xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Attach a VM to the SR-IOV network].
52-
5336
[id="creating-and-managing-vms_{context}"]
5437
== Creating and managing virtual machines
5538

@@ -64,14 +47,24 @@ Connect to the VMs:
6447
* xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vmi-ssh_virt-accessing-vm-consoles[Connect to a VM by using SSH].
6548
* xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-rdp-console-web_virt-accessing-vm-consoles[Connect to a Windows VM by using RDP].
6649

67-
Manage VM states:
50+
Manage the VMs:
6851

6952
* xref:../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Stop, start, pause, and restart a VM by using the web console].
7053
* xref:../virt/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[Manage a VM, expose a port, or connect to the serial console by using the `virtctl` CLI tool].
7154

7255
[id="next-steps"]
7356
== Next steps
7457

58+
* Connect the VMs to secondary networks:
59+
60+
** xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-attaching-vm-multiple-networks[Connect a VM to a Linux bridge network].
61+
** xref:../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Connect a VM to an SR-IOV network].
62+
+
63+
[NOTE]
64+
====
65+
VMs are connected to the pod network by default. You must configure a secondary network, such as Linux bridge or SR-IOV, and then add the network to the VM configuration.
66+
====
67+
7568
* xref:../virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc#virt-reviewing-virtualization-overview[Monitor resources, details, status, and top consumers by using the web console].
7669
* xref:../virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc#virt-viewing-information-about-vm-workloads[View high-level information about VM workloads by using the web console].
7770
* xref:../virt/logging_events_monitoring/virt-logs.adoc#virt-logs[View {VirtProductName} logs by using the CLI].

virt/virtual_machines/virt-create-vms.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,4 @@ The KubeVirt API Reference is the upstream project reference and might contain p
7373
* See xref:../../virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc#virt-using-container-disks-with-vms[Prepare a container disk] before adding it to a virtual machine as a `containerDisk` volume.
7474
* See xref:../../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-about_deploying-machine-health-checks[Deploying machine health checks] for further details on deploying and enabling machine health checks.
7575
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Installer-provisioned infrastructure overview] for further details on installer-provisioned infrastructure.
76-
* See xref:../../virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc#virt-configuring-sriov-device-for-vms[Configuring the SR-IOV Network Operator] for further details on the SR-IOV Network Operator.
7776
* xref:../../virt/virtual_machines/virtual_disks/virt-creating-data-volumes.adoc#virt-customizing-storage-profile_virt-creating-data-volumes[Customizing the storage profile]

virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="virt-attaching-vm-multiple-networks"]
3-
= Attaching a virtual machine to a Linux bridge network
3+
= Connecting a virtual machine to a Linux bridge network
44
include::_attributes/common-attributes.adoc[]
55
:context: virt-attaching-vm-multiple-networks
66

0 commit comments

Comments
 (0)