summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-12-23 14:30:45 +0100
committerChristian Poessinger <christian@poessinger.com>2020-12-23 14:30:45 +0100
commit2b55a3a72fca5975724836df2d857de77fb12e7f (patch)
treee020fe13f50ae43d01088ace4a68116528233f29 /docs
parent6cdae273512a3e78cef93c1227274fcf4733add0 (diff)
downloadvyos-documentation-2b55a3a72fca5975724836df2d857de77fb12e7f.tar.gz
vyos-documentation-2b55a3a72fca5975724836df2d857de77fb12e7f.zip
xdp: use common include for both ethernet and bond
Diffstat (limited to 'docs')
-rw-r--r--docs/_include/interface-xdp.txt24
-rw-r--r--docs/configuration/interfaces/bonding.rst8
-rw-r--r--docs/configuration/interfaces/ethernet.rst21
3 files changed, 35 insertions, 18 deletions
diff --git a/docs/_include/interface-xdp.txt b/docs/_include/interface-xdp.txt
new file mode 100644
index 00000000..6f5f88c1
--- /dev/null
+++ b/docs/_include/interface-xdp.txt
@@ -0,0 +1,24 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> xdp
+
+ Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling
+ releases. You must enable it for every interface which should participate in
+ the XDP forwarding.
+
+ XDP is an eBPF based high performance data path merged in the Linux kernel
+ since version 4.8. The idea behind XDP is to add an early hook in the RX path
+ of the kernel, and let a user supplied eBPF program decide the fate of the
+ packet. The hook is placed in the NIC driver just after the interrupt
+ processing, and before any memory allocation needed by the network stack
+ itself, because memory allocation can be an expensive operation.
+
+ .. warning:: This is highly experimental!
+
+ .. note:: Enabling this feature will break any form of NAT or Firewalling on
+ this interface, as XDP is handled way earlier in the driver then iptables/
+ nftables.
+
+ Example:
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} xdp \ No newline at end of file
diff --git a/docs/configuration/interfaces/bonding.rst b/docs/configuration/interfaces/bonding.rst
index 92601b37..bf7cfc2c 100644
--- a/docs/configuration/interfaces/bonding.rst
+++ b/docs/configuration/interfaces/bonding.rst
@@ -256,6 +256,13 @@ Bond options
The maximum number of targets that can be specified is 16. The default value
is no IP addresses.
+Offloading
+----------
+
+.. cmdinclude:: /_include/interface-xdp.txt
+ :var0: bonding
+ :var1: bond0
+
VLAN
====
@@ -265,6 +272,7 @@ VLAN
Port Mirror (SPAN)
==================
+
.. cmdinclude:: ../../_include/interface-mirror.txt
:var0: bonding
:var1: bond1
diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst
index 8c6bcc07..2eca130f 100644
--- a/docs/configuration/interfaces/ethernet.rst
+++ b/docs/configuration/interfaces/ethernet.rst
@@ -92,24 +92,9 @@ Offloading
the IPv4 ID is not sequentially incrementing it will be altered so that it is
when a frame assembled via GRO is segmented via GSO.
-.. cfgcmd:: set interfaces ethernet <interface> xdp
-
- Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling
- releases. You must enable it for every interface which should participate in
- the XDP forwarding.
-
- XDP is an eBPF based high performance data path merged in the Linux kernel
- since version 4.8. The idea behind XDP is to add an early hook in the RX path
- of the kernel, and let a user supplied eBPF program decide the fate of the
- packet. The hook is placed in the NIC driver just after the interrupt
- processing, and before any memory allocation needed by the network stack
- itself, because memory allocation can be an expensive operation.
-
- .. warning:: This is highly experimental!
-
- .. note:: Enabling this feature will break any form of NAT or Firewalling on
- this interface, as XDP is handled way earlier in the driver then iptables/
- nftables.
+.. cmdinclude:: /_include/interface-xdp.txt
+ :var0: ethernet
+ :var1: eth0
VLAN
====