From ba74f42db3fd72defd9b414897cf2a51daf2b48d Mon Sep 17 00:00:00 2001 From: Quill <69414602+teslazonda@users.noreply.github.com> Date: Wed, 18 Mar 2026 05:55:09 +0900 Subject: Proofread files in /vpp/configuration/interfaces directory (#1793) * Proofread bonding.rst * Proofread bridge.rst * Edit remaining files in /interfaces * Fix line length lint errors * Apply suggestions from code review Co-authored-by: Daniil Baturin --------- Co-authored-by: Daniil Baturin --- docs/vpp/configuration/interfaces/bonding.rst | 59 +++++++++++++++++--------- docs/vpp/configuration/interfaces/bridge.rst | 44 +++++++++++++------ docs/vpp/configuration/interfaces/gre.rst | 40 +++++++++++------ docs/vpp/configuration/interfaces/index.rst | 30 ++++++++----- docs/vpp/configuration/interfaces/ipip.rst | 24 +++++++---- docs/vpp/configuration/interfaces/loopback.rst | 32 +++++++++----- docs/vpp/configuration/interfaces/vxlan.rst | 31 +++++++++----- docs/vpp/configuration/interfaces/xconnect.rst | 45 ++++++++++++++------ 8 files changed, 210 insertions(+), 95 deletions(-) (limited to 'docs') diff --git a/docs/vpp/configuration/interfaces/bonding.rst b/docs/vpp/configuration/interfaces/bonding.rst index 6ca50e8e..25ff6f40 100644 --- a/docs/vpp/configuration/interfaces/bonding.rst +++ b/docs/vpp/configuration/interfaces/bonding.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-09 .. _vpp_config_interfaces_bonding: @@ -8,7 +8,10 @@ VPP Bonding Configuration ######################### -VPP bonding interfaces provide link aggregation capabilities, combining multiple physical interfaces into a single logical interface for increased bandwidth and redundancy. VPP bonding offers high-performance packet processing compared to traditional Linux bonding. +VPP bonding interfaces provide link aggregation capabilities by combining +multiple physical interfaces into a single logical interface for increased +bandwidth and redundancy. VPP bonding offers high-performance packet +processing compared to traditional Linux bonding. Basic Configuration ------------------- @@ -20,8 +23,11 @@ To create a VPP bonding interface: .. cfgcmd:: set interfaces vpp bonding - Create a bonding interface where ```` follows the naming convention vppbond0, vppbond1, etc. - LCP kernel pair interface bound to the VPP bonding interface is created automatically. This allows standard Linux networking tools and services to interact with the VPP bond. + Create a bonding interface where ```` follows the naming + convention ``vppbond0``, ``vppbond1``, and so on. A kernel pair interface is + automatically created for the VPP bonding interface. This allows + standard Linux networking tools and services to interact with the VPP + bond. **Example:** @@ -47,7 +53,8 @@ Administrative Control .. cfgcmd:: set interfaces vpp bonding disable - Administratively disable the bonding interface. By default, interfaces are enabled. + Administratively disable the bonding interface. By default, interfaces + are enabled. Member Interface Configuration ------------------------------ @@ -55,9 +62,11 @@ Member Interface Configuration Adding Member Interfaces ^^^^^^^^^^^^^^^^^^^^^^^^ -.. cfgcmd:: set interfaces vpp bonding member interface +.. cfgcmd:: set interfaces vpp bonding member interface + - Add physical interfaces as members of the bond. Multiple interfaces can be added to the same bond. + Add physical interfaces as members of the bond. You can add multiple + interfaces to the same bond. **Example:** @@ -68,7 +77,8 @@ Adding Member Interfaces .. note:: - Member interfaces should be of the same speed and duplex for optimal performance and already be attached to VPP. + Member interfaces must have the same speed and duplex for optimal + performance. They must already be attached to VPP. Bonding Modes ------------- @@ -96,7 +106,8 @@ Bonding Modes Hash Policies ------------- -For load balancing modes, configure how traffic is distributed across member interfaces: +For load balancing modes, configure how the system distributes traffic +across member interfaces: .. cfgcmd:: set interfaces vpp bonding hash-policy @@ -134,7 +145,8 @@ IP Address Configuration .. cfgcmd:: set interfaces vpp bonding address - Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned. + Configure IPv4 or IPv6 addresses on the kernel interface. You can + assign multiple addresses. **Examples:** @@ -155,7 +167,8 @@ MTU Configuration .. cfgcmd:: set interfaces vpp bonding mtu - Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface. + Set the Maximum Transmission Unit (MTU) for the kernel interface. The + MTU must be compatible with the connected VPP interface. **Example:** @@ -165,12 +178,14 @@ MTU Configuration .. note:: - Ensure the MTU setting matches or is smaller than the MTU supported by the associated VPP interface to avoid issues. + The MTU setting must match or be smaller than the MTU supported by the + associated VPP interface. VLAN Configuration ------------------ -VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for network segmentation. +VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for +network segmentation. Creating VLAN Sub-interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -188,11 +203,14 @@ Creating VLAN Sub-interfaces VLAN Sub-interface Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -VLAN sub-interfaces support the same configuration options as the parent interface: +VLAN sub-interfaces support the same configuration options as the parent +interface: -.. cfgcmd:: set interfaces vpp bonding vif address +.. cfgcmd:: set interfaces vpp bonding vif address + -.. cfgcmd:: set interfaces vpp bonding vif description +.. cfgcmd:: set interfaces vpp bonding vif description + .. cfgcmd:: set interfaces vpp bonding vif disable @@ -237,6 +255,9 @@ Here's a complete example configuring a bonding interface with LACP: Best Practices -------------- -* Use **802.3ad mode** with LACP-capable switches for best performance and standards compliance -* Configure **layer3+4 hash policy** for environments with multiple traffic flows -* Ensure member interfaces have identical capabilities (speed, duplex, MTU) +* Use **802.3ad mode** with LACP-capable switches for best performance + and standards compliance. +* Configure **layer3+4 hash policy** for environments with multiple + traffic flows. +* Ensure member interfaces have identical settings (speed, duplex, + MTU). diff --git a/docs/vpp/configuration/interfaces/bridge.rst b/docs/vpp/configuration/interfaces/bridge.rst index 91cd2cdb..0b72d77f 100644 --- a/docs/vpp/configuration/interfaces/bridge.rst +++ b/docs/vpp/configuration/interfaces/bridge.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-10 .. _vpp_config_interfaces_bridge: @@ -8,9 +8,14 @@ VPP Bridge Configuration ######################## -VPP bridge interfaces provide Layer 2 switching functionality, allowing multiple interfaces to be connected at the data link layer. +VPP bridge interfaces provide Layer 2 switching functionality, allowing +multiple interfaces to be connected at the data link layer. -VPP bridges operate as learning bridges, automatically discovering MAC addresses and building forwarding tables to efficiently switch traffic between member interfaces. This provides transparent connectivity between different network segments while maintaining the performance benefits of VPP's optimized data plane. +VPP bridges operate as learning bridges, automatically discovering MAC +addresses and building forwarding tables to efficiently switch traffic +between member interfaces. This provides transparent connectivity between +different network segments while maintaining the performance benefits of +VPP's optimized data plane. **Supported Member Interface Types:** @@ -22,7 +27,8 @@ VPP bridges support various interface types as members: * :doc:`loopback` - Loopback interfaces (required for BVI) * :doc:`vxlan` - VXLAN tunnel interfaces -This flexibility allows you to create complex Layer 2 topologies combining different networking technologies. +This flexibility allows you to create complex Layer 2 topologies +combining different networking technologies. Basic Configuration ------------------- @@ -32,11 +38,14 @@ Creating a Bridge Interface .. cfgcmd:: set interfaces vpp bridge - Create a bridge interface where ```` follows the naming convention vppbr1, vppbr2, etc. + Create a bridge interface where ```` follows the naming + convention ``vppbr1``, ``vppbr2``, etc. .. note:: - Bridge domain vppbr0 is reserved by VPP and cannot be configured through VyOS. Start with vppbr1 for your bridge configurations. + Bridge domain ``vppbr0`` is reserved by VPP and cannot be + configured through VyOS. Start with ``vppbr1`` for your bridge + configurations. **Example:** @@ -64,7 +73,8 @@ Member Interface Configuration Adding Member Interfaces ^^^^^^^^^^^^^^^^^^^^^^^^ -.. cfgcmd:: set interfaces vpp bridge member interface +.. cfgcmd:: set interfaces vpp bridge member interface + Add an interface as a member of the bridge. @@ -93,14 +103,18 @@ Adding Member Interfaces Bridge Virtual Interface (BVI) ------------------------------ -A Bridge Virtual Interface (BVI) provides Layer 3 connectivity to a bridge domain, allowing the bridge to have an IP address and participate in routing. +A Bridge Virtual Interface (BVI) provides Layer 3 connectivity to a +bridge domain, allowing the bridge to have an IP address and participate +in routing. Configuring BVI ^^^^^^^^^^^^^^^ -.. cfgcmd:: set interfaces vpp bridge member interface bvi +.. cfgcmd:: set interfaces vpp bridge member interface + bvi - Designate a loopback interface as the Bridge Virtual Interface for the bridge domain. + Designate a loopback interface as the Bridge Virtual Interface for + the bridge domain. **Example:** @@ -169,7 +183,10 @@ Multi-Technology Bridge Integration with Kernel Interfaces ---------------------------------- -Bridge interfaces can be integrated with kernel interfaces for management and compatibility with standard Linux networking services. This is accomplished by binding a kernel interface to the Bridge Virtual Interface (BVI). +Bridge interfaces can be integrated with kernel interfaces for +management and compatibility with standard Linux networking services. +This is accomplished by binding a kernel interface to the Bridge +Virtual Interface (BVI). **Example Integration:** @@ -187,4 +204,7 @@ Bridge interfaces can be integrated with kernel interfaces for management and co # Bind LCP kernel interface to the BVI loopback set interfaces vpp loopback vpplo1 address '192.0.2.1/24' -This configuration creates a kernel interface bound to the BVI, allowing standard Linux applications and routing daemons to interact with the VPP bridge. The kernel interface provides Layer 3 access to the bridge domain. +This configuration creates a kernel interface bound to the BVI, +allowing standard Linux applications and routing daemons to interact +with the VPP bridge. The kernel interface provides Layer 3 access to +the bridge domain. diff --git a/docs/vpp/configuration/interfaces/gre.rst b/docs/vpp/configuration/interfaces/gre.rst index dbb29805..e7fd9abc 100644 --- a/docs/vpp/configuration/interfaces/gre.rst +++ b/docs/vpp/configuration/interfaces/gre.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_gre: @@ -8,7 +8,11 @@ VPP GRE Configuration ##################### -VPP GRE interfaces provide Generic Routing Encapsulation tunneling with high-performance packet processing. GRE tunnels encapsulate various protocols within IP packets, enabling connectivity across Layer 3 networks while maintaining the performance benefits of VPP's optimized data plane. +VPP GRE interfaces provide Generic Routing Encapsulation tunneling with +high-performance packet processing. GRE tunnels encapsulate various +protocols within IP packets, enabling connectivity across Layer 3 +networks while maintaining the performance benefits of VPP's optimized +data plane. Basic Configuration ------------------- @@ -18,15 +22,18 @@ Creating a GRE Interface .. cfgcmd:: set interfaces vpp gre - Create a GRE interface where ```` follows the naming convention vppgre1, vppgre2, etc. + Create a GRE interface where ```` follows the naming convention + ``vppgre1``, ``vppgre2``, etc. .. cfgcmd:: set interfaces vpp gre remote
- Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses. + Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 + addresses. .. cfgcmd:: set interfaces vpp gre source-address
- Set the tunnel source address. Must match an address configured on the local system. + Set the tunnel source address. Must match an address configured on + the local system. **Basic Example:** @@ -57,21 +64,25 @@ Tunnel Type Set the GRE tunnel encapsulation type: - * ``l3`` - Generic Routing Encapsulation for network layer traffic (default) - * ``teb`` - Transparent Ethernet Bridge for Layer 2 frame transport - * ``erspan`` - Encapsulated Remote Switched Port Analyzer for traffic mirroring + * ``l3`` - Generic Routing Encapsulation for network layer traffic (default). + * ``teb`` - Transparent Ethernet Bridge for Layer 2 frame transport. + * ``erspan`` - Encapsulated Remote Switched Port Analyzer for traffic + mirroring. Kernel Interface Integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -LCP kernel pair interface bound to the VPP GRE interface is created automatically. This allows standard Linux networking tools and services to interact with the VPP GRE. +LCP kernel pair interface bound to the VPP GRE interface is created +automatically. This allows standard Linux networking tools and +services to interact with the VPP GRE. IP Address Configuration ------------------------ .. cfgcmd:: set interfaces vpp gre address - Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned. + Configure IPv4 or IPv6 addresses on the kernel interface. Multiple + addresses can be assigned. **Examples:** @@ -88,7 +99,8 @@ MTU Configuration .. cfgcmd:: set interfaces vpp gre mtu - Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface. + Set the Maximum Transmission Unit (MTU) for the kernel interface. + The MTU must be compatible with the connected VPP interface. **Example:** @@ -98,7 +110,8 @@ MTU Configuration .. note:: - Ensure the MTU setting matches or is smaller than the MTU supported by the associated VPP interface to avoid issues. + The MTU size must not exceed the MTU size + supported by the associated VPP interface. Configuration Examples @@ -152,7 +165,8 @@ GRE with Kernel Interface Bridge Integration ------------------ -GRE interfaces can be added as members to VPP bridges for Layer 2 switching. See :doc:`bridge` for detailed bridge configuration. +GRE interfaces can be added as members to VPP bridges for Layer 2 +switching. See :doc:`bridge` for detailed bridge configuration. .. code-block:: none diff --git a/docs/vpp/configuration/interfaces/index.rst b/docs/vpp/configuration/interfaces/index.rst index b9739ed2..da9bff03 100644 --- a/docs/vpp/configuration/interfaces/index.rst +++ b/docs/vpp/configuration/interfaces/index.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_index: @@ -20,20 +20,30 @@ VPP Interfaces Configuration vxlan xconnect -VyOS utilizes VPP (Vector Packet Processor) to provide high-performance data plane processing. While physical interfaces are typically managed through the Linux kernel using linux-cp (Linux Control Plane) integration, VyOS also supports creating dedicated VPP interfaces for enhanced flexibility and performance. +VyOS utilizes VPP (Vector Packet Processor) to provide high-performance data +plane processing. While physical interfaces are typically managed through the +Linux kernel using ``linux-cp`` (Linux Control Plane) integration, VyOS also +supports creating dedicated VPP interfaces for enhanced flexibility and +performance. -**Why VPP Interfaces?** +Why VPP Interfaces? +------------------- VPP interfaces offer several advantages: -* **Total Isolation**: VPP interfaces operate entirely within the VPP data plane, providing isolation from the Linux kernel when needed -* **Advanced Features**: Access to VPP-specific functionality not available in standard Linux interfaces -* **Flexible Deployment**: Some interface types are only available as VPP interfaces or may not be supported by the kernel -* **Specific scenarios**: Not all use cases require integration with the Linux Kernel +* **Total Isolation**: VPP interfaces operate entirely within the VPP data + plane, providing isolation from the Linux kernel when needed. +* **Advanced Features**: Access to VPP-specific functionality not available + in standard Linux interfaces. +* **Flexible Deployment**: Some interface types are only available as VPP + interfaces or may not be supported by the kernel. +* **Specific scenarios**: Not all use cases require integration with the + Linux Kernel. Integration with Kernel ^^^^^^^^^^^^^^^^^^^^^^^ -However, VyOS provides seamless integration between VPP and kernel networking. - -This allows you to leverage the strengths of both approaches - create interfaces inside VPP, but still have them accessible from the Linux kernel and other services side. +VyOS provides seamless integration between VPP and kernel networking. +This allows you to leverage the strengths of both approaches: +create interfaces inside VPP, and access them from the Linux kernel and other +services. diff --git a/docs/vpp/configuration/interfaces/ipip.rst b/docs/vpp/configuration/interfaces/ipip.rst index f56add85..4ad21c41 100644 --- a/docs/vpp/configuration/interfaces/ipip.rst +++ b/docs/vpp/configuration/interfaces/ipip.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_ipip: @@ -8,7 +8,9 @@ VPP IPIP Configuration ###################### -VPP IPIP interfaces provide IP-in-IP tunneling with high-performance packet processing. IPIP tunnels encapsulate IP packets within IP packets, creating point-to-point connections across Layer 3 networks. +VPP IPIP interfaces provide IP-in-IP tunneling with high-performance +packet processing. IPIP tunnels encapsulate IP packets within IP +packets, creating point-to-point connections across Layer 3 networks. Basic Configuration ------------------- @@ -18,15 +20,18 @@ Creating an IPIP Interface .. cfgcmd:: set interfaces vpp ipip - Create an IPIP interface where ```` follows the naming convention vppipip1, vppipip2, etc. + Create an IPIP interface where ```` follows the naming + convention ``vppipip1``, ``vppipip2``, etc. .. cfgcmd:: set interfaces vpp ipip remote
- Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses. + Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 + addresses. .. cfgcmd:: set interfaces vpp ipip source-address
- Set the tunnel source address. Must match an address configured on the local system. + Set the tunnel source address. The source address must match an address + configured on the local system. **Basic Example:** @@ -53,14 +58,16 @@ Description and Administrative Control Kernel Interface Integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Kernel interface is bounded to the VPP IPIP interface for management and application compatibility. +Kernel interface is bound to the VPP IPIP interface for management and +application compatibility. IP Address Configuration ------------------------ .. cfgcmd:: set interfaces vpp ipip address - Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned. + Configure IPv4 or IPv6 addresses on the kernel interface. Multiple + addresses can be assigned. **Examples:** @@ -77,7 +84,8 @@ MTU Configuration .. cfgcmd:: set interfaces vpp ipip mtu - Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface. + Set the Maximum Transmission Unit (MTU) for the kernel interface. + The MTU must be compatible with the connected VPP interface. Configuration Examples ---------------------- diff --git a/docs/vpp/configuration/interfaces/loopback.rst b/docs/vpp/configuration/interfaces/loopback.rst index 1fd66899..61ef6aca 100644 --- a/docs/vpp/configuration/interfaces/loopback.rst +++ b/docs/vpp/configuration/interfaces/loopback.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_loopback: @@ -8,7 +8,11 @@ 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. +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 ------------------- @@ -18,7 +22,8 @@ Creating a Loopback Interface .. cfgcmd:: set interfaces vpp loopback - Create a loopback interface where ```` follows the naming convention vpplo1, vpplo2, etc. + Create a loopback interface where ```` follows the naming + convention ``vpplo1``, ``vpplo2``, etc. **Basic Example:** @@ -43,14 +48,16 @@ Description and Administrative Control Kernel Interface Integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Kernel interface is bounded to the VPP loopback interface for management and application compatibility. +Kernel interface is bounded to the VPP loopback interface for management +and application compatibility. IP Address Configuration ------------------------ .. cfgcmd:: set interfaces vpp loopback address - Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned. + Configure IPv4 or IPv6 addresses on the kernel interface. Multiple + addresses can be assigned. **Examples:** @@ -67,12 +74,14 @@ MTU Configuration .. cfgcmd:: set interfaces vpp loopback mtu - Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface. + Set the Maximum Transmission Unit (MTU) for the kernel interface. + The MTU must be compatible with the connected VPP interface. VLAN Configuration ------------------ -VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for network segmentation. +VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for network +segmentation. Creating VLAN Sub-interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -84,11 +93,14 @@ Creating VLAN Sub-interfaces VLAN Sub-interface Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -VLAN sub-interfaces support the same configuration options as the parent interface: +VLAN sub-interfaces support the same configuration options as the parent +interface: -.. cfgcmd:: set interfaces vpp loopback vif address +.. cfgcmd:: set interfaces vpp loopback vif address + -.. cfgcmd:: set interfaces vpp loopback vif description +.. cfgcmd:: set interfaces vpp loopback vif description + .. cfgcmd:: set interfaces vpp loopback vif disable diff --git a/docs/vpp/configuration/interfaces/vxlan.rst b/docs/vpp/configuration/interfaces/vxlan.rst index 08765fa4..85398386 100644 --- a/docs/vpp/configuration/interfaces/vxlan.rst +++ b/docs/vpp/configuration/interfaces/vxlan.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_vxlan: @@ -8,7 +8,10 @@ VPP VXLAN Configuration ####################### -VPP VXLAN interfaces provide Virtual eXtensible Local Area Network tunneling with high-performance packet processing. VXLAN extends Layer 2 domains across Layer 3 networks using UDP encapsulation, enabling scalable multi-tenant networking while leveraging VPP's optimized data plane. +VPP VXLAN interfaces provide virtual extensible local area network (VXLAN) +tunneling with high-performance packet processing. VXLAN extends Layer 2 +domains across Layer 3 networks using UDP encapsulation, enabling scalable +multi-tenant networking while leveraging VPP's optimized data plane. Basic Configuration ------------------- @@ -18,19 +21,23 @@ Creating a VXLAN Interface .. cfgcmd:: set interfaces vpp vxlan - Create a VXLAN interface where ```` follows the naming convention vppvxlan1, vppvxlan2, etc. + Create a VXLAN interface where ```` follows the naming + convention ``vppvxlan1``, ``vppvxlan2``, etc. .. cfgcmd:: set interfaces vpp vxlan vni - Set the Virtual Network Identifier (VNI) for the VXLAN tunnel. Valid range is 0-16777214. + Set the Virtual Network Identifier (VNI) for the VXLAN tunnel. Valid range + is 0-16777214. .. cfgcmd:: set interfaces vpp vxlan remote
- Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses. + Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 + addresses. .. cfgcmd:: set interfaces vpp vxlan source-address
- Set the tunnel source address. Must match an address configured on the local system. + Set the tunnel source address. Must match an address configured on the + local system. **Basic Example:** @@ -58,14 +65,16 @@ Description and Administrative Control Kernel Interface Integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Kernel interface is bounded to the VXLAN tunnel for management and application compatibility. +The kernel interface is bound to the VXLAN tunnel for management and +application compatibility. IP Address Configuration ------------------------ .. cfgcmd:: set interfaces vpp vxlan address - Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned. + Configure IPv4 or IPv6 addresses on the kernel interface. Multiple + addresses can be assigned. **Examples:** @@ -79,7 +88,8 @@ MTU Configuration .. cfgcmd:: set interfaces vpp vxlan mtu - Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface. + Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU + must be compatible with the connected VPP interface. Configuration Examples ---------------------- @@ -122,7 +132,8 @@ VXLAN with Kernel Interface Bridge Integration ------------------ -VXLAN interfaces are commonly used as members in VPP bridges for Layer 2 extension. See :doc:`bridge` for detailed bridge configuration. +VXLAN interfaces are commonly used as members in VPP bridges for Layer 2 +extension. See :doc:`bridge` for more information. .. code-block:: none diff --git a/docs/vpp/configuration/interfaces/xconnect.rst b/docs/vpp/configuration/interfaces/xconnect.rst index 3144734f..27916a0e 100644 --- a/docs/vpp/configuration/interfaces/xconnect.rst +++ b/docs/vpp/configuration/interfaces/xconnect.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-09-04 +:lastproofread: 2026-03-13 .. _vpp_config_interfaces_xconnect: @@ -8,17 +8,28 @@ VPP XConnect Configuration ########################## -VPP XConnect provides direct Layer 2 packet forwarding between two interfaces with maximum transparency and minimal overhead. XConnect creates a simple point-to-point bridge that forwards all Layer 2 packets bidirectionally without MAC learning or flooding, making it ideal for transparent connectivity scenarios. +VPP XConnect provides direct Layer 2 packet forwarding between two +interfaces with maximum transparency and minimal overhead. XConnect +creates a simple point-to-point bridge that forwards all Layer 2 packets +bidirectionally without MAC learning or flooding, making it ideal for +transparent connectivity scenarios. -XConnect operates as a super-transparent bridge, forwarding all frames between the connected interfaces without any packet inspection or modification. This provides the simplest possible Layer 2 forwarding with VPP's high-performance packet processing. +XConnect operates as a super-transparent bridge, forwarding all frames +between the connected interfaces without any packet inspection or +modification. This provides the simplest possible Layer 2 forwarding with +VPP's high-performance packet processing. Comparison with Bridges ----------------------- -* **XConnect**: Point-to-point only, no MAC learning, maximum transparency, minimal overhead -* **Bridge**: Multi-port, MAC learning, broadcast handling, more features but higher overhead +* **XConnect**: Point-to-point only, no MAC learning, maximum + transparency, minimal overhead +* **Bridge**: Multi-port, MAC learning, broadcast handling, more + features but higher overhead -Choose XConnect when you need simple point-to-point Layer 2 forwarding with maximum performance and transparency. Use bridges when you need multi-port switching with MAC learning and broadcast handling. +Choose XConnect when you need simple point-to-point Layer 2 forwarding +with maximum performance and transparency. Use bridges when you need +multi-port switching with MAC learning and broadcast handling. Basic Configuration ------------------- @@ -28,11 +39,14 @@ Creating an XConnect Interface .. cfgcmd:: set interfaces vpp xconnect - Create an XConnect interface where ```` follows the naming convention vppxcon1, vppxcon2, etc. + Create an XConnect interface where ```` follows the naming + convention ``vppxcon1``, ``vppxcon2``, etc. -.. cfgcmd:: set interfaces vpp xconnect member interface +.. cfgcmd:: set interfaces vpp xconnect member interface + - Add an interface as a member of the XConnect. Exactly two member interfaces must be configured to create bidirectional forwarding. + Add an interface as a member of the XConnect. Exactly two member + interfaces must be configured to create bidirectional forwarding. **Basic Example:** @@ -42,7 +56,9 @@ Creating an XConnect Interface set interfaces vpp xconnect vppxcon1 member interface eth0 set interfaces vpp xconnect vppxcon1 member interface eth1 -This configuration creates transparent forwarding between eth0 and eth1, where any packet received on either interface is immediately forwarded to the other without any processing. +This configuration creates transparent forwarding between ``eth0`` and ``eth1``, +where any packet received on either interface is immediately forwarded to +the other without any processing. Interface Configuration ----------------------- @@ -65,7 +81,8 @@ Physical Interface XConnect set interfaces vpp xconnect vppxcon1 member interface eth0 set interfaces vpp xconnect vppxcon1 member interface eth1 -This creates a transparent wire between two physical ports, effectively making them function as a single cable. +This creates a transparent wire between two physical ports, effectively +making them function as a single cable. Tunnel to Physical XConnect ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -78,7 +95,8 @@ Tunnel to Physical XConnect set interfaces vpp xconnect vppxcon2 member interface vppgre1 set interfaces vpp xconnect vppxcon2 member interface eth2 -This forwards all traffic from a GRE tunnel directly to a physical interface and vice versa. +This forwards all traffic from a GRE tunnel directly to a physical +interface and vice versa. Mixed Interface Types ^^^^^^^^^^^^^^^^^^^^^ @@ -91,4 +109,5 @@ Mixed Interface Types set interfaces vpp xconnect vppxcon3 member interface vppvxlan1 set interfaces vpp xconnect vppxcon3 member interface vppbond0 -This demonstrates XConnect's flexibility in connecting various VPP interface types. +This demonstrates XConnect's flexibility in connecting various VPP interface +types. -- cgit v1.2.3