From 00faafed96d86a970bf566c79f1bfd304630ccaa Mon Sep 17 00:00:00 2001 From: zdc Date: Fri, 29 Aug 2025 19:53:13 +0300 Subject: VPP: Add comprehensive VPP documentation This commit introduces extensive documentation for VyOS VPP (Vector Packet Processing) Dataplane interfaces and features, including examples. Features documented: * VPP integration description, base requirements and limitations * VPP dataplane core settings * Features enabled in the dataplane: ACL, IPsec, NAT, sFlow * VPP interface types: bonding, bridge, GRE, IPIP, kernel, loopback, VXLAN, XConnect Note: This is an initial documentation version that will require ongoing improvements based on user feedback and questions, real-world deployment testing and validation, additional use cases and configuration scenarios discovered in production. Therefore, all pages are marked as "need improvement". --- docs/vpp/configuration/interfaces/loopback.rst | 86 ++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 docs/vpp/configuration/interfaces/loopback.rst (limited to 'docs/vpp/configuration/interfaces/loopback.rst') diff --git a/docs/vpp/configuration/interfaces/loopback.rst b/docs/vpp/configuration/interfaces/loopback.rst new file mode 100644 index 00000000..082124d2 --- /dev/null +++ b/docs/vpp/configuration/interfaces/loopback.rst @@ -0,0 +1,86 @@ +:lastproofread: 2025-09-04 + +.. _vpp_config_interfaces_loopback: + +.. include:: /_include/need_improvement.txt + +#################################### +VPP Loopback Interface Configuration +#################################### + +VPP loopback interfaces provide virtual interfaces that remain administratively up and are commonly used for stable addressing, routing protocols, and as Bridge Virtual Interfaces (BVI). Loopback interfaces in VPP offer high-performance virtual connectivity with optimized packet processing. + +Basic Configuration +------------------- + +Creating a Loopback Interface +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. cfgcmd:: set vpp interfaces loopback + + Create a loopback interface where ```` follows the naming convention lo1, lo2, etc. + +**Basic Example:** + +.. code-block:: none + + set vpp interfaces loopback lo1 + +Interface Configuration +----------------------- + +Description and Administrative Control +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. cfgcmd:: set vpp interfaces loopback description + + Set a descriptive name for the loopback interface. + +.. cfgcmd:: set vpp interfaces loopback disable + + Administratively disable the loopback interface. + +Kernel Interface Integration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. cfgcmd:: set vpp interfaces loopback kernel-interface + + Bind a kernel interface to the loopback interface for management and application compatibility. + +For detailed information about kernel interface integration, see :doc:`kernel`. + +Configuration Examples +---------------------- + +Basic Loopback Interface +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + # Create simple loopback + set vpp interfaces loopback lo1 + set vpp interfaces loopback lo1 description "Router ID interface" + +Loopback with Kernel Interface +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + # Loopback with management access + set vpp interfaces loopback lo2 + set vpp interfaces loopback lo2 description "Management loopback" + set vpp interfaces loopback lo2 kernel-interface vpptun2 + set vpp kernel-interfaces vpptun2 address 10.255.255.1/32 + +Bridge Virtual Interface (BVI) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + # Loopback as BVI for bridge + set vpp interfaces loopback lo3 + set vpp interfaces loopback lo3 description "Bridge gateway interface" + set vpp interfaces bridge br1 + set vpp interfaces bridge br1 member interface lo3 bvi + set vpp interfaces loopback lo3 kernel-interface vpptun3 + set vpp kernel-interfaces vpptun3 address 192.168.100.1/24 -- cgit v1.2.3