From 13eb4940d69021e48871e8d8b54a12b0b560cb1a Mon Sep 17 00:00:00 2001 From: MilaNad Date: Mon, 2 Feb 2026 18:14:36 +0100 Subject: [PATCH 1/4] DOC: Proofread geneve.rst --- docs/configuration/interfaces/geneve.rst | 62 ++++++++++++++---------- 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst index e9d2d52b28..20e8c2a331 100644 --- a/docs/configuration/interfaces/geneve.rst +++ b/docs/configuration/interfaces/geneve.rst @@ -6,23 +6,28 @@ GENEVE ###### -:abbr:`GENEVE (Generic Network Virtualization Encapsulation)` supports all of -the capabilities of :abbr:`VXLAN (Virtual Extensible LAN)`, :abbr:`NVGRE -(Network Virtualization using Generic Routing Encapsulation)`, and :abbr:`STT -(Stateless Transport Tunneling)` and was designed to overcome their perceived -limitations. Many believe GENEVE could eventually replace these earlier formats -entirely. - -GENEVE is designed to support network virtualization use cases, where tunnels -are typically established to act as a backplane between the virtual switches -residing in hypervisors, physical switches, or middleboxes or other appliances. -An arbitrary IP network can be used as an underlay through Clos networks - A -technique for composing network fabrics larger than a single switch while -maintaining non-blocking bandwidth across connection points. ECMP is used to -divide traffic across the multiple links and switches that constitute the -fabric. Sometimes termed "leaf and spine" or "fat tree" topologies. - -Geneve Header: +:abbr:`GENEVE (Generic Network Virtualization Encapsulation)` interfaces +operate as virtual network ports. Administrators can apply standard network +configurations on them, such as IP addressing, bridging, or firewall rules, +just as they would on physical Ethernet ports. + +GENEVE interfaces are also used for configuring GENEVE tunnels. To transport +data across the network, they utilize the GENEVE encapsulation protocol. This +protocol encapsulates Layer 2 Ethernet frames originating from endpoints such +as virtual machines, containers, or physical servers inside UDP packets. It +unifies the features of earlier encapsulation protocols, including VXLAN, +NVGRE, and STT, and addresses their limitations, such as fixed header +structures and a lack of metadata support. Because of its extensibility, GENEVE +is considered the successor to these legacy protocols. + +GENEVE tunnels are used to connect virtual switches residing within +hypervisors, physical switches, middleboxes, and other network appliances. + +GENEVE tunnels operate over any standard IP network. In larger deployments, +the underlying network (underlay) is often built using a **Clos** topology, +also known as a *leaf-and-spine* or *fat-tree* topology. + +GENEVE header: .. code-block:: none @@ -74,19 +79,24 @@ GENEVE options .. cfgcmd:: set interfaces geneve gnv0 remote
- Configure GENEVE tunnel far end/remote tunnel endpoint. + Configure the remote endpoint IP address for the GENEVE tunnel. .. cfgcmd:: set interfaces geneve gnv0 vni - :abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique - element of a virtual network. In many situations this may represent an L2 - segment, however, the control plane defines the forwarding semantics of - decapsulated packets. The VNI MAY be used as part of ECMP forwarding - decisions or MAY be used as a mechanism to distinguish between overlapping - address spaces contained in the encapsulated packet when load balancing - across CPUs. + **Configure** :abbr:`VNI (Virtual Network Identifier)` **for the GENEVE + interface.** + + The VNI is a virtual network identifier. It allows multiple virtual networks to + share the same physical infrastructure while remaining isolated. + + The VNI is also used to distribute traffic after it leaves the tunnel, for + example, to map packets with overlapping IP addresses to specific routing + tables or to distribute traffic across multiple CPU cores. .. cfgcmd:: set interfaces gnv0 port - Configure port number of remote GENEVE endpoint. + **Configure the destination UDP port for the remote GENEVE tunnel endpoint.** + + Ensure the remote peer is configured to listen on this specific port. + From d892ac4845f471cf1abbfce9b43b4648ebebb304 Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Tue, 3 Feb 2026 19:50:32 +0100 Subject: [PATCH 2/4] Update docs/configuration/interfaces/geneve.rst Co-authored-by: Daniil Baturin --- docs/configuration/interfaces/geneve.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst index 20e8c2a331..baca143119 100644 --- a/docs/configuration/interfaces/geneve.rst +++ b/docs/configuration/interfaces/geneve.rst @@ -18,7 +18,7 @@ as virtual machines, containers, or physical servers inside UDP packets. It unifies the features of earlier encapsulation protocols, including VXLAN, NVGRE, and STT, and addresses their limitations, such as fixed header structures and a lack of metadata support. Because of its extensibility, GENEVE -is considered the successor to these legacy protocols. +may eventually replace those older protocols. GENEVE tunnels are used to connect virtual switches residing within hypervisors, physical switches, middleboxes, and other network appliances. From 38e28d716fb8bde246bf9782a35e3232e88fc0c1 Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Tue, 3 Feb 2026 20:13:33 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Daniil Baturin --- docs/configuration/interfaces/geneve.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst index baca143119..34702f9eaf 100644 --- a/docs/configuration/interfaces/geneve.rst +++ b/docs/configuration/interfaces/geneve.rst @@ -11,8 +11,7 @@ operate as virtual network ports. Administrators can apply standard network configurations on them, such as IP addressing, bridging, or firewall rules, just as they would on physical Ethernet ports. -GENEVE interfaces are also used for configuring GENEVE tunnels. To transport -data across the network, they utilize the GENEVE encapsulation protocol. This +To transport data across the network, they utilize the GENEVE encapsulation protocol. This protocol encapsulates Layer 2 Ethernet frames originating from endpoints such as virtual machines, containers, or physical servers inside UDP packets. It unifies the features of earlier encapsulation protocols, including VXLAN, @@ -87,7 +86,7 @@ GENEVE options interface.** The VNI is a virtual network identifier. It allows multiple virtual networks to - share the same physical infrastructure while remaining isolated. + share the same physical infrastructure and remain isolated. The VNI is also used to distribute traffic after it leaves the tunnel, for example, to map packets with overlapping IP addresses to specific routing From 96b4461870d8e9eb18d0e8b546bc82d6393e330b Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Tue, 3 Feb 2026 20:28:17 +0100 Subject: [PATCH 4/4] Update geneve.rst Corrected Geneve capitalization. --- docs/configuration/interfaces/geneve.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst index 34702f9eaf..d8b05a390a 100644 --- a/docs/configuration/interfaces/geneve.rst +++ b/docs/configuration/interfaces/geneve.rst @@ -1,32 +1,32 @@ -:lastproofread: 2023-01-20 +:lastproofread: 2026-02-02 .. _geneve-interface: ###### -GENEVE +Geneve ###### -:abbr:`GENEVE (Generic Network Virtualization Encapsulation)` interfaces +:abbr:`Geneve (Generic Network Virtualization Encapsulation)` interfaces operate as virtual network ports. Administrators can apply standard network configurations on them, such as IP addressing, bridging, or firewall rules, just as they would on physical Ethernet ports. -To transport data across the network, they utilize the GENEVE encapsulation protocol. This +To transport data across the network, they utilize the Geneve encapsulation protocol. This protocol encapsulates Layer 2 Ethernet frames originating from endpoints such as virtual machines, containers, or physical servers inside UDP packets. It unifies the features of earlier encapsulation protocols, including VXLAN, NVGRE, and STT, and addresses their limitations, such as fixed header -structures and a lack of metadata support. Because of its extensibility, GENEVE +structures and a lack of metadata support. Because of its extensibility, Geneve may eventually replace those older protocols. -GENEVE tunnels are used to connect virtual switches residing within +Geneve tunnels are used to connect virtual switches residing within hypervisors, physical switches, middleboxes, and other network appliances. -GENEVE tunnels operate over any standard IP network. In larger deployments, +Geneve tunnels operate over any standard IP network. In larger deployments, the underlying network (underlay) is often built using a **Clos** topology, also known as a *leaf-and-spine* or *fat-tree* topology. -GENEVE header: +Geneve header: .. code-block:: none @@ -73,16 +73,16 @@ Common interface configuration :var0: geneve :var1: gnv0 -GENEVE options +Geneve options ============== .. cfgcmd:: set interfaces geneve gnv0 remote
- Configure the remote endpoint IP address for the GENEVE tunnel. + Configure the remote endpoint IP address for the Geneve tunnel. .. cfgcmd:: set interfaces geneve gnv0 vni - **Configure** :abbr:`VNI (Virtual Network Identifier)` **for the GENEVE + **Configure** :abbr:`VNI (Virtual Network Identifier)` **for the Geneve interface.** The VNI is a virtual network identifier. It allows multiple virtual networks to @@ -94,7 +94,7 @@ GENEVE options .. cfgcmd:: set interfaces gnv0 port - **Configure the destination UDP port for the remote GENEVE tunnel endpoint.** + **Configure the destination UDP port for the remote Geneve tunnel endpoint.** Ensure the remote peer is configured to listen on this specific port.