Skip to content

Commit f7d3859

Browse files
authored
Merge pull request #20629 from openshift-cherrypick-robot/cherry-pick-20617-to-enterprise-4.3
[enterprise-4.3] Ensure procedure steps are sequential
2 parents f8aeed8 + 73c4cc1 commit f7d3859

File tree

3 files changed

+13
-22
lines changed

3 files changed

+13
-22
lines changed

modules/nw-sriov-dpdk-example-intel.adoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,16 @@ spec:
2929
rootDevices: ["<pci_bus_id>", "..."]
3030
deviceType: vfio-pci <1>
3131
----
32-
3332
<1> Specify the driver type for the virtual functions to `vfio-pci`.
34-
33+
+
3534
[NOTE]
3635
=====
3736
Please refer to the `Configuring SR-IOV network devices` section for a detailed explanation on each option in `SriovNetworkNodePolicy`.
38-
37+
+
3938
When applying the configuration specified in a SriovNetworkNodePolicy CR, the SR-IOV Operator may drain the nodes, and in some cases, reboot nodes.
4039
It may take several minutes for a configuration change to apply.
4140
Ensure that there are enough available nodes in your cluster to handle the evicted workload beforehand.
42-
41+
+
4342
After the configuration update is applied, all the Pods in `openshift-sriov-network-operator` namespace will change to a `Running` status.
4443
=====
4544

@@ -64,14 +63,13 @@ spec:
6463
vlan: <vlan>
6564
resourceName: intelnics
6665
----
67-
6866
<1> Specify an empty object `"{}"` for the ipam CNI plug-in. DPDK works in userspace mode and does not require an IP address.
69-
67+
+
7068
[NOTE]
7169
=====
7270
Please refer to the `Configuring SR-IOV additional network` section for a detailed explanation on each option in `SriovNetwork`.
7371
=====
74-
72+
+
7573
. Create the SriovNetworkNodePolicy CR by running the following command:
7674
+
7775
----
@@ -116,7 +114,6 @@ spec:
116114
emptyDir:
117115
medium: HugePages
118116
----
119-
120117
<1> Specify the same `target_namespace` where the SriovNetwork CR `intel-dpdk-network` is created. If you would like to create the Pod in a different namespace, change `target_namespace` in both the Pod spec and the SriovNetowrk CR.
121118
<2> Specify the DPDK image which includes your application and the DPDK library used by application.
122119
<3> Specify the `IPC_LOCK` capability which is required by the application to allocate hugepage memory inside container.

modules/nw-sriov-dpdk-example-mellanox.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,18 @@ spec:
3030
deviceType: netdevice <2>
3131
isRdma: true <3>
3232
----
33-
3433
<1> Specify the device hex code of the SR-IOV network device. The only allowed values for Mellanox cards are `1015`, `1017`.
3534
<2> Specify the driver type for the virtual functions to `netdevice`. Mellanox SR-IOV VF can work in DPDK mode without using the `vfio-pci` device type. VF device appears as a kernel network interface inside a container.
3635
<3> Enable RDMA mode. This is required by Mellanox cards to work in DPDK mode.
37-
36+
+
3837
[NOTE]
3938
=====
4039
Please refer to `Configuring SR-IOV network devices` section for detailed explanation on each option in `SriovNetworkNodePolicy`.
41-
40+
+
4241
When applying the configuration specified in a SriovNetworkNodePolicy CR, the SR-IOV Operator may drain the nodes, and in some cases, reboot nodes.
4342
It may take several minutes for a configuration change to apply.
4443
Ensure that there are enough available nodes in your cluster to handle the evicted workload beforehand.
45-
44+
+
4645
After the configuration update is applied, all the Pods in the `openshift-sriov-network-operator` namespace will change to a `Running` status.
4746
=====
4847

@@ -68,9 +67,8 @@ spec:
6867
vlan: <vlan>
6968
resourceName: mlxnics
7069
----
71-
7270
<1> Specify a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
73-
71+
+
7472
[NOTE]
7573
=====
7674
Please refer to `Configuring SR-IOV additional network` section for detailed explanation on each option in `SriovNetwork`.
@@ -120,7 +118,6 @@ spec:
120118
emptyDir:
121119
medium: HugePages
122120
----
123-
124121
<1> Specify the same `target_namespace` where SriovNetwork CR `mlx-dpdk-network` is created. If you would like to create the Pod in a different namespace, change `target_namespace` in both Pod spec and SriovNetowrk CR.
125122
<2> Specify the DPDK image which includes your application and the DPDK library used by application.
126123
<3> Specify the `IPC_LOCK` capability which is required by the application to allocate hugepage memory inside the container.

modules/nw-sriov-rdma-example-mellanox.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,18 @@ spec:
3333
deviceType: netdevice <2>
3434
isRdma: true <3>
3535
----
36-
3736
<1> Specify the device hex code of SR-IOV network device. The only allowed values for Mellanox cards are `1015`, `1017`.
3837
<2> Specify the driver type for the virtual functions to `netdevice`.
3938
<3> Enable RDMA mode.
40-
39+
+
4140
[NOTE]
4241
=====
4342
Please refer to the `Configuring SR-IOV network devices` section for a detailed explanation on each option in `SriovNetworkNodePolicy`.
44-
43+
+
4544
When applying the configuration specified in a SriovNetworkNodePolicy CR, the SR-IOV Operator may drain the nodes, and in some cases, reboot nodes.
4645
It may take several minutes for a configuration change to apply.
4746
Ensure that there are enough available nodes in your cluster to handle the evicted workload beforehand.
48-
47+
+
4948
After the configuration update is applied, all the Pods in the `openshift-sriov-network-operator` namespace will change to a `Running` status.
5049
=====
5150

@@ -71,9 +70,8 @@ spec:
7170
vlan: <vlan>
7271
resourceName: mlxnics
7372
----
74-
7573
<1> Specify a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
76-
74+
+
7775
[NOTE]
7876
=====
7977
Please refer to `Configuring SR-IOV additional network` section for detailed explanation on each option in `SriovNetwork`.
@@ -121,7 +119,6 @@ spec:
121119
emptyDir:
122120
medium: HugePages
123121
----
124-
125122
<1> Specify the same `target_namespace` where SriovNetwork CR `mlx-rdma-network` is created. If you would like to create the Pod in a different namespace, change `target_namespace` in both Pod spec and SriovNetowrk CR.
126123
<2> Specify the RDMA image which includes your application and RDMA library used by application.
127124
<3> Specify the `IPC_LOCK` capability which is required by the application to allocate hugepage memory inside the container.

0 commit comments

Comments
 (0)