diff mbox

[v2,net-next] documentation: bring vxlan documentation more up-to-date

Message ID 20150812172314.5C6862900958@tardy
State Accepted, archived
Delegated to: David Miller
Headers show

Commit Message

Rick Jones Aug. 12, 2015, 5:23 p.m. UTC 
From: Rick Jones <rick.jones2@hp.com>

A few things have changed since the previous version of the vxlan
documentation was written, so update it and correct some grammer and
such while we are at it.

Signed-off-by: Rick Jones <rick.jones2@hp.com>

---

v2: Stephen Hemminger feedback to include dstport 4789 in command line
    example.  Also some further refinements from other sources.

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Randy Dunlap Aug. 12, 2015, 5:32 p.m. UTC | #1 
On 08/12/15 10:23, Rick Jones wrote:
> From: Rick Jones <rick.jones2@hp.com>
> 
> A few things have changed since the previous version of the vxlan
> documentation was written, so update it and correct some grammer and

if there are more updates:                                 grammar

> such while we are at it.
> 
> Signed-off-by: Rick Jones <rick.jones2@hp.com>
> 
> ---
> 
> v2: Stephen Hemminger feedback to include dstport 4789 in command line
>     example.  Also some further refinements from other sources.
David Miller Aug. 12, 2015, 11:46 p.m. UTC | #2 
From: raj@tardy.usa.hp.com (Rick Jones)
Date: Wed, 12 Aug 2015 10:23:14 -0700 (PDT)

> From: Rick Jones <rick.jones2@hp.com>
> 
> A few things have changed since the previous version of the vxlan
> documentation was written, so update it and correct some grammer and
> such while we are at it.
> 
> Signed-off-by: Rick Jones <rick.jones2@hp.com>

Applied with "grammar" misspelling fixed.

Thanks.
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rick Jones Aug. 12, 2015, 11:49 p.m. UTC | #3 
On 08/12/2015 04:46 PM, David Miller wrote:
> From: raj@tardy.usa.hp.com (Rick Jones)
> Date: Wed, 12 Aug 2015 10:23:14 -0700 (PDT)
>
>> From: Rick Jones <rick.jones2@hp.com>
>>
>> A few things have changed since the previous version of the vxlan
>> documentation was written, so update it and correct some grammer and
>> such while we are at it.
>>
>> Signed-off-by: Rick Jones <rick.jones2@hp.com>
>
> Applied with "grammar" misspelling fixed.

Thanks.

rick
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/networking/vxlan.txt b/Documentation/networking/vxlan.txt
index 6d99351..89ee11b 100644
--- a/Documentation/networking/vxlan.txt
+++ b/Documentation/networking/vxlan.txt
@@ -1,32 +1,36 @@ 
 Virtual eXtensible Local Area Networking documentation
 ======================================================
 
-The VXLAN protocol is a tunnelling protocol that is designed to
-solve the problem of limited number of available VLAN's (4096).
-With VXLAN identifier is expanded to 24 bits.
-
-It is a draft RFC standard, that is implemented by Cisco Nexus,
-Vmware and Brocade. The protocol runs over UDP using a single
-destination port (still not standardized by IANA).
-This document describes the Linux kernel tunnel device,
-there is also an implantation of VXLAN for Openvswitch.
-
-Unlike most tunnels, a VXLAN is a 1 to N network, not just point
-to point. A VXLAN device can either dynamically learn the IP address
-of the other end, in a manner similar to a learning bridge, or the
-forwarding entries can be configured statically.
-
-The management of vxlan is done in a similar fashion to it's
-too closest neighbors GRE and VLAN. Configuring VXLAN requires
-the version of iproute2 that matches the kernel release
-where VXLAN was first merged upstream.
+The VXLAN protocol is a tunnelling protocol designed to solve the
+problem of limited VLAN IDs (4096) in IEEE 802.1q.  With VXLAN the
+size of the identifier is expanded to 24 bits (16777216).
+
+VXLAN is described by IETF RFC 7348, and has been implemented by a
+number of vendors.  The protocol runs over UDP using a single
+destination port.  This document describes the Linux kernel tunnel
+device, there is also a separate implementation of VXLAN for
+Openvswitch.
+
+Unlike most tunnels, a VXLAN is a 1 to N network, not just point to
+point. A VXLAN device can learn the IP address of the other endpoint
+either dynamically in a manner similar to a learning bridge, or make
+use of statically-configured forwarding entries.
+
+The management of vxlan is done in a manner similar to its two closest
+neighbors GRE and VLAN. Configuring VXLAN requires the version of
+iproute2 that matches the kernel release where VXLAN was first merged
+upstream.
 
 1. Create vxlan device
-  # ip li add vxlan0 type vxlan id 42 group 239.1.1.1 dev eth1
-
-This creates a new device (vxlan0). The device uses the
-the multicast group 239.1.1.1 over eth1 to handle packets where
-no entry is in the forwarding table.
+ # ip link add vxlan0 type vxlan id 42 group 239.1.1.1 dev eth1 dstport 4789
+
+This creates a new device named vxlan0.  The device uses the multicast
+group 239.1.1.1 over eth1 to handle traffic for which there is no
+entry in the forwarding table.  The destination port number is set to
+the IANA-assigned value of 4789.  The Linux implementation of VXLAN
+pre-dates the IANA's selection of a standard destination port number
+and uses the Linux-selected value by default to maintain backwards
+compatibility.
 
 2. Delete vxlan device
   # ip link delete vxlan0