Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCPBUGS-3533 Adding note about vfio-pci #52851

Merged
merged 1 commit into from
Nov 17, 2022
Merged

OCPBUGS-3533 Adding note about vfio-pci #52851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions modules/nw-sriov-interface-level-sysctl-basic-node-policy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

:_content-type: PROCEDURE
[id="nw-basic-example-setting-one-sysctl-flag-node-policy_{context}"]
= Setting one sysctl flag on nodes with SR-IOV network devices
= Setting one sysctl flag on nodes with SR-IOV network devices

The SR-IOV Network Operator adds the `SriovNetworkNodePolicy.sriovnetwork.openshift.io` custom resource definition (CRD) to {product-title}. You can configure an SR-IOV network device by creating a `SriovNetworkNodePolicy` custom resource (CR).
The SR-IOV Network Operator adds the `SriovNetworkNodePolicy.sriovnetwork.openshift.io` custom resource definition (CRD) to {product-title}. You can configure an SR-IOV network device by creating a `SriovNetworkNodePolicy` custom resource (CR).

[NOTE]
====
Expand All @@ -15,11 +15,11 @@ When applying the configuration specified in a `SriovNetworkNodePolicy` object,
It can take several minutes for a configuration change to apply.
====

Follow this procedure to create a `SriovNetworkNodePolicy` custom resource (CR).
Follow this procedure to create a `SriovNetworkNodePolicy` custom resource (CR).

.Procedure

. Create an `SriovNetworkNodePolicy` custom resource (CR). For example, save the following YAML as the file `policyoneflag-sriov-node-network.yaml`:
. Create an `SriovNetworkNodePolicy` custom resource (CR). For example, save the following YAML as the file `policyoneflag-sriov-node-network.yaml`:
+
[source,yaml]
----
Expand Down Expand Up @@ -49,13 +49,17 @@ spec:
<7> The NIC selector identifies the device for the Operator to configure. You do not have to specify values for all the parameters. It is recommended to identify the network device with enough precision to avoid selecting a 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 refer to the same device. If you specify a value for `netFilter`, then you do not need to specify any other parameter because a network ID is unique.
<8> Optional: An array of one or more physical function (PF) names for the device.
<9> Optional: The driver type for the virtual functions. The only allowed values are `netdevice` and `vfio-pci`. The default value is `netdevice`.
For a Mellanox NIC to work in DPDK mode on bare metal nodes, use the `netdevice` driver type and set `isRdma` to `true`.
<9> Optional: The driver type for the virtual functions. The only allowed value is `netdevice`.
For a Mellanox NIC to work in DPDK mode on bare metal nodes, set `isRdma` to `true`.
<10> Optional: Configures whether to enable remote direct memory access (RDMA) mode. The default value is `false`.
If the `isRdma` parameter 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.
Set `isRdma` to `true` and additionally set `needVhostNet` to `true` to configure a Mellanox NIC for use with Fast Datapath DPDK applications.
+

[NOTE]
====
The `vfio-pci` driver type is not supported.
====
+
. Create the `SriovNetworkNodePolicy` object:
+
[source,terminal]
Expand All @@ -72,7 +76,7 @@ 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}'
----
+
.Example output
.Example output
[source,terminal]
----
Succeeded
Expand Down
16 changes: 10 additions & 6 deletions modules/nw-sriov-interface-level-sysctl-bonded-node-policy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

:_content-type: CONCEPT
[id="nw-setting-all-sysctls-flag-node-policy-bonded_{context}"]
= Setting all sysctl flag on nodes with bonded SR-IOV network devices
= Setting all sysctl flag on nodes with bonded SR-IOV network devices

The SR-IOV Network Operator adds the `SriovNetworkNodePolicy.sriovnetwork.openshift.io` custom resource definition (CRD) to {product-title}. You can configure an SR-IOV network device by creating a `SriovNetworkNodePolicy` custom resource (CR).
The SR-IOV Network Operator adds the `SriovNetworkNodePolicy.sriovnetwork.openshift.io` custom resource definition (CRD) to {product-title}. You can configure an SR-IOV network device by creating a `SriovNetworkNodePolicy` custom resource (CR).

[NOTE]
====
Expand All @@ -15,7 +15,7 @@ When applying the configuration specified in a SriovNetworkNodePolicy object, th
It might take several minutes for a configuration change to apply.
====

Follow this procedure to create a `SriovNetworkNodePolicy` custom resource (CR).
Follow this procedure to create a `SriovNetworkNodePolicy` custom resource (CR).

.Procedure

Expand Down Expand Up @@ -49,13 +49,17 @@ spec:
<7> The NIC selector identifies the device for the Operator to configure. You do not have to specify values for all the parameters. It is recommended to identify the network device with enough precision to avoid selecting a 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 refer to the same device. If you specify a value for `netFilter`, then you do not need to specify any other parameter because a network ID is unique.
<8> Optional: An array of one or more physical function (PF) names for the device.
<9> Optional: The driver type for the virtual functions. The only allowed values are `netdevice` and `vfio-pci`. The default value is `netdevice`.
For a Mellanox NIC to work in DPDK mode on bare metal nodes, use the `netdevice` driver type and set `isRdma` to `true`.
<9> Optional: The driver type for the virtual functions. The only allowed value is `netdevice`.
For a Mellanox NIC to work in DPDK mode on bare metal nodes, set `isRdma` to `true`.
<10> Optional: Configures whether to enable remote direct memory access (RDMA) mode. The default value is `false`.
If the `isRdma` parameter 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.
Set `isRdma` to `true` and additionally set `needVhostNet` to `true` to configure a Mellanox NIC for use with Fast Datapath DPDK applications.
+

[NOTE]
====
The `vfio-pci` driver type is not supported.
====
+
. Create the SriovNetworkNodePolicy object:
+
[source,terminal]
Expand Down