You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
TELCODOCS-2853: Fix AsciiDocDITA violations for hardware offloading docs
Resolve all Vale AsciiDocDITA errors and warnings to prepare the
configuring-hardware-offloading assembly and its modules for DITA
conversion. Changes include adding short descriptions, replacing
callouts with bullet lists, extracting inline prerequisites to a
new module, fixing terminology, and correcting content type.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: modules/nw-sriov-hwol-about-hardware-offloading.adoc
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@
6
6
[id="about-hardware-offloading_{context}"]
7
7
= About hardware offloading
8
8
9
+
[role="_abstract"]
9
10
Open vSwitch hardware offloading is a method of processing network tasks by diverting them away from the CPU and offloading them to a dedicated processor on a network interface controller.
10
11
As a result, clusters can benefit from faster data transfer speeds, reduced CPU workloads, and lower computing costs.
11
12
@@ -14,7 +15,7 @@ A SmartNIC is a network interface controller that is able to handle computationa
14
15
In the same way that a dedicated graphics card can improve graphics performance, a SmartNIC can improve network performance.
15
16
In each case, a dedicated processor improves performance for a specific type of processing task.
16
17
17
-
In {product-title}, you can configure hardware offloading for baremetal nodes that have a compatible SmartNIC.
18
+
In {product-title}, you can configure hardware offloading for bare-metal nodes that have a compatible SmartNIC.
18
19
Hardware offloading is configured and enabled by the SR-IOV Network Operator.
19
20
20
21
Hardware offloading is not compatible with all workloads or application types.
= Adding the network attachment definition to your pods
8
8
9
+
[role="_abstract"]
9
10
After you create the machine config pool, the `SriovNetworkPoolConfig` and `SriovNetworkNodePolicy` custom resources, and the network attachment definition, you can apply these configurations to your pods by adding the network attachment definition to your pod specifications.
10
11
11
12
.Procedure
@@ -17,6 +18,9 @@ After you create the machine config pool, the `SriovNetworkPoolConfig` and `Srio
Copy file name to clipboardExpand all lines: modules/nw-sriov-hwol-configuring-machine-config-pool.adoc
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@
6
6
[id="configuring-machine-config-pool_{context}"]
7
7
= Configuring a machine config pool for hardware offloading
8
8
9
+
[role="_abstract"]
9
10
To enable hardware offloading, you now create a dedicated machine config pool and configure it to work with the SR-IOV Network Operator.
10
11
11
12
.Prerequisites
@@ -16,24 +17,26 @@ To enable hardware offloading, you now create a dedicated machine config pool an
16
17
17
18
. Create a machine config pool for machines you want to use hardware offloading on.
18
19
19
-
.. Create a file, such as `mcp-offloading.yaml`, with content like the following example:
20
+
.. Create a file, such as `mcp-offloading.yaml`, with content such as the following example:
20
21
+
21
22
[source,yaml]
22
23
----
23
24
apiVersion: machineconfiguration.openshift.io/v1
24
25
kind: MachineConfigPool
25
26
metadata:
26
-
name: mcp-offloading <1>
27
+
name: <mcp_name>
27
28
spec:
28
29
machineConfigSelector:
29
30
matchExpressions:
30
-
- {key: machineconfiguration.openshift.io/role, operator: In, values: [worker,mcp-offloading]} <1>
31
+
- {key: machineconfiguration.openshift.io/role, operator: In, values: [worker,<mcp_name>]}
31
32
nodeSelector:
32
33
matchLabels:
33
-
node-role.kubernetes.io/mcp-offloading: "" <2>
34
+
node-role.kubernetes.io/<mcp_name>: ""
34
35
----
35
-
<1> The name of your machine config pool for hardware offloading.
36
-
<2> This node role label is used to add nodes to the machine config pool.
36
+
+
37
+
--
38
+
* `<mcp_name>` specifies the name of your machine config pool for hardware offloading. This value is used as the machine config pool name, the machine config selector value, and the node role label.
39
+
--
37
40
38
41
.. Apply the configuration for the machine config pool:
After you define the machine config pool and the SR-IOV network node policy, you can create a network attachment definition for the network interface card you specified.
9
+
[role="_abstract"]
10
+
After you define the machine config pool and the SR-IOV network node policy, you can create a network attachment definition for the network interface controller (NIC) you specified.
10
11
11
12
.Prerequisites
12
13
@@ -15,23 +16,26 @@ After you define the machine config pool and the SR-IOV network node policy, you
15
16
16
17
.Procedure
17
18
18
-
. Create a file, such as `net-attach-def.yaml`, with content like the following example:
19
+
. Create a file, such as `net-attach-def.yaml`, with content such as the following example:
= Improving network traffic performance using a virtual function
8
8
9
+
[role="_abstract"]
9
10
Follow this procedure to assign a virtual function to the OVN-Kubernetes management port and increase its network traffic performance.
10
11
11
12
This procedure results in the creation of two pools: the first has a virtual function used by OVN-Kubernetes, and the second comprises the remaining virtual functions.
@@ -44,15 +45,18 @@ spec:
44
45
- 0000:d8:00.0
45
46
vendor: "15b3"
46
47
pfNames:
47
-
- ens8f0#0-0 <1>
48
+
- <pf_name>#0-0
48
49
nodeSelector:
49
50
network.operator.openshift.io/smart-nic: ""
50
-
numVfs: 6 <2>
51
+
numVfs: <num_vfs>
51
52
priority: 5
52
53
resourceName: mgmtvf
53
54
----
54
-
<1> Replace this device with the appropriate network device for your use case. The `#0-0` part of the `pfNames` value reserves a single virtual function used by OVN-Kubernetes.
55
-
<2> The value provided here is an example. Replace this value with one that meets your requirements. For more information, see _SR-IOV network node configuration object_ in the _Additional resources_ section.
55
+
+
56
+
--
57
+
* `<pf_name>` specifies the network device for your use case. The `#0-0` part of the `pfNames` value reserves a single virtual function used by OVN-Kubernetes.
58
+
* `<num_vfs>` specifies the number of virtual functions. Replace this value with one that meets your requirements. For more information, see _SR-IOV network node configuration object_ in the _Additional resources_ section.
59
+
--
56
60
57
61
. Create a policy named `sriov-node-policy.yaml` with content such as the following example:
58
62
+
@@ -72,15 +76,18 @@ spec:
72
76
- 0000:d8:00.0
73
77
vendor: "15b3"
74
78
pfNames:
75
-
- ens8f0#1-5 <1>
79
+
- <pf_name>#1-5
76
80
nodeSelector:
77
81
network.operator.openshift.io/smart-nic: ""
78
-
numVfs: 6 <2>
82
+
numVfs: <num_vfs>
79
83
priority: 5
80
84
resourceName: mlxnics
81
85
----
82
-
<1> Replace this device with the appropriate network device for your use case.
83
-
<2> The value provided here is an example. Replace this value with the value specified in the `sriov-node-mgmt-vf-policy.yaml` file. For more information, see _SR-IOV network node configuration object_ in the _Additional resources_ section.
86
+
+
87
+
--
88
+
* `<pf_name>` specifies the network device for your use case.
89
+
* `<num_vfs>` specifies the number of virtual functions. Replace this value with the value specified in the `sriov-node-mgmt-vf-policy.yaml` file. For more information, see _SR-IOV network node configuration object_ in the _Additional resources_ section.
0 commit comments