Connecting a virtual machine to an SR-IOV network

You can connect a virtual machine (VM) to a Single Root I/O Virtualization (SR-IOV) network by performing the following steps:

Configuring SR-IOV network devices

The SR-IOV Network Operator adds the SriovNetworkNodePolicy.sriovnetwork.openshift.io custom resource definition (CRD) to OpenShift Container Platform. You can configure an SR-IOV network device by creating a SriovNetworkNodePolicy custom resource (CR).

Note

When applying the configuration specified in a SriovNetworkNodePolicy CR, the SR-IOV Operator might drain the nodes, and in some cases, reboot nodes. Reboot only happens in the following cases:

With Mellanox NICs (mlx5 driver) a node reboot happens every time the number of virtual functions (VFs) increase on a physical function (PF).
With Intel NICs, a reboot only happens if the kernel parameters do not include intel_iommu=on and iommu=pt.

It might take several minutes for a configuration change to apply.

Prerequisites

You installed the OpenShift CLI (oc).
You have access to the cluster as a user with the cluster-admin role.
You have installed the SR-IOV Network Operator.
You have enough available nodes in your cluster to handle the evicted workload from drained nodes.
You have not selected any control plane nodes for SR-IOV network device configuration.

Procedure

Create an SriovNetworkNodePolicy object, and then save the YAML in the <name>-sriov-node-network.yaml file. Replace <name> with the name for this configuration.
```
apiVersion: sriovnetwork.openshift.io/v1
kind: SriovNetworkNodePolicy
metadata:
  name: <name>
  namespace: openshift-sriov-network-operator
spec:
  resourceName: <sriov_resource_name>
  nodeSelector:
    feature.node.kubernetes.io/network-sriov.capable: "true"
  priority: <priority>
  mtu: <mtu>
  numVfs: <num>
  nicSelector:
    vendor: "<vendor_code>"
    deviceID: "<device_id>"
    pfNames: ["<pf_name>", ...]
    rootDevices: ["<pci_bus_id>", "..."]
  deviceType: vfio-pci
  isRdma: false
```
metadata.name

Specify a name for the SriovNetworkNodePolicy object.

metadata.namespace

Specify the namespace where the SR-IOV Network Operator is installed.

spec.resourceName

Specify the resource name of the SR-IOV device plugin. You can create multiple SriovNetworkNodePolicy objects for a resource name.

spec.nodeSelector.feature.node.kubernetes.io/network-sriov.capable

Specify the node selector to select which nodes are configured. Only SR-IOV network devices on selected nodes are configured. The SR-IOV Container Network Interface (CNI) plugin and device plugin are deployed only on selected nodes.

spec.priority

Optional: Specify an integer value between 0 and 99. A smaller number gets higher priority, so a priority of 10 is higher than a priority of 99. The default value is 99.

spec.mtu

Optional: Specify a value for the maximum transmission unit (MTU) of the virtual function. The maximum MTU value can vary for different NIC models.

spec.numVfs

Specify the number of the virtual functions (VF) to create for the SR-IOV physical network device. For an Intel network interface controller (NIC), the number of VFs cannot be larger than the total VFs supported by the device. For a Mellanox NIC, the number of VFs cannot be larger than 127.

spec.nicSelector

The nicSelector mapping selects the Ethernet device for the Operator to configure. You do not need to specify values for all the parameters.

Note

It is recommended to identify the Ethernet adapter with enough precision to minimize the possibility of selecting an Ethernet device unintentionally. If you specify rootDevices, you must also specify a value for vendor, deviceID, or pfNames.

If you specify both pfNames and rootDevices at the same time, ensure that they point to an identical device.

spec.nicSelector.vendor

Optional: Specify the vendor hex code of the SR-IOV network device. The only allowed values are either 8086 or 15b3.

spec.nicSelector.deviceID

Optional: Specify the device hex code of SR-IOV network device. The only allowed values are 158b, 1015, 1017.

spec.nicSelector.pfNames

Optional: The parameter accepts an array of one or more physical function (PF) names for the Ethernet device.

spec.nicSelector.rootDevices

The parameter accepts an array of one or more PCI bus addresses for the physical function of the Ethernet device. Provide the address in the following format: 0000:02:00.1.

spec.deviceType

The vfio-pci driver type is required for virtual functions in OpenShift Virtualization.

spec.isRdma

Optional: Specify whether to enable remote direct memory access (RDMA) mode. For a Mellanox card, set isRdma to false. The default value is false.

Note

If isRDMA flag is set to true, you can continue to use the RDMA enabled VF as a normal network device. A device can be used in either mode.
Optional: Label the SR-IOV capable cluster nodes with SriovNetworkNodePolicy.Spec.NodeSelector if they are not already labeled. For more information about labeling nodes, see "Understanding how to update labels on nodes".
Create the SriovNetworkNodePolicy object:
```
$ oc create -f <name>-sriov-node-network.yaml
```
where <name> specifies the name for this configuration.

After applying the configuration update, all the pods in sriov-network-operator namespace transition to the Running status.
To verify that the SR-IOV network device is configured, enter the following command. Replace <node_name> with the name of a node with the SR-IOV network device that you just configured.
```
$ oc get sriovnetworknodestates -n openshift-sriov-network-operator <node_name> -o jsonpath='{.status.syncStatus}'
```

Configuring SR-IOV additional network

You can configure an additional network that uses SR-IOV hardware by creating an SriovNetwork object.

When you create an SriovNetwork object, the SR-IOV Network Operator automatically creates a NetworkAttachmentDefinition object.

Note

Do not modify or delete an SriovNetwork object if it is attached to pods or virtual machines in a running state.

Prerequisites

Install the OpenShift CLI (oc).
Log in as a user with cluster-admin privileges.

Procedure

Create the following SriovNetwork object, and then save the YAML in the <name>-sriov-network.yaml file. Replace <name> with a name for this additional network.
```
apiVersion: sriovnetwork.openshift.io/v1
kind: SriovNetwork
metadata:
  name: <name>
  namespace: openshift-sriov-network-operator
spec:
  resourceName: <sriov_resource_name>
  networkNamespace: <target_namespace>
  vlan: <vlan>
  spoofChk: "<spoof_check>"
  linkState: <link_state>
  maxTxRate: <max_tx_rate>
  minTxRate: <min_rx_rate>
  vlanQoS: <vlan_qos>
  trust: "<trust_vf>"
  capabilities: <capabilities>
```
metadata.name

Specify a name for the SriovNetwork object. The SR-IOV Network Operator creates a NetworkAttachmentDefinition object with same name.

metadata.namespace

Specify the namespace where the SR-IOV Network Operator is installed.

spec.resourceName

Specify the value of the .spec.resourceName parameter in the SriovNetworkNodePolicy object that defines the SR-IOV hardware for this additional network.

spec.networkNamespace

Specify the target namespace for the SriovNetwork object. Only pods or virtual machines in the target namespace can attach to the SriovNetwork object.

spec.vlan

Optional: Specify a Virtual LAN (VLAN) ID for the additional network. The integer value must be from 0 to 4095. The default value is 0.

spec.spoofChk

Optional: Specify the spoof check mode of the VF. The allowed values are the strings "on" and "off".

Important

You must enclose the value you specify in quotes or the CR is rejected by the SR-IOV Network Operator.

spec.linkState

Optional: Specify the link state of virtual function (VF). Allowed values are enable, disable and auto.

spec.maxTxRate

Optional: Specify the maximum transmission rate, in Mbps, for the VF.

spec.minTxRate

Optional: Specify the minimum transmission rate, in Mbps, for the VF. This value should always be less than or equal to the maximum transmission rate.

Note

Intel NICs do not support the minTxRate parameter. For more information, see BZ#1772847.

spec.vlanQoS

Optional: Specify the IEEE 802.1p priority level for the VF. The default value is 0.

spec.trust

Optional: Specify the trust mode of the VF. The allowed values are the strings "on" and "off".

Important

You must enclose the value you specify in quotes or the CR is rejected by the SR-IOV Network Operator.

spec.capabilities

Optional: Specify the capabilities to configure for this network.

To create the object, enter the following command. Replace <name> with a name for this additional network.
```
$ oc create -f <name>-sriov-network.yaml
```
Optional: To confirm that the NetworkAttachmentDefinition object associated with the SriovNetwork object that you created in the previous step exists, enter the following command. Replace <namespace> with the namespace you specified in the SriovNetwork object.
```
$ oc get net-attach-def -n <namespace>
```