summaryrefslogtreecommitdiffstats
path: root/Documentation/networking/bareudp.rst
diff options
context:
space:
mode:
authorMartin Varghese <martin.varghese@nokia.com>2020-02-24 10:57:50 +0530
committerDavid S. Miller <davem@davemloft.net>2020-02-24 13:31:42 -0800
commit571912c69f0ed731bd1e071ade9dc7ca4aa52065 (patch)
tree319a2ff693104702ebfc44cbf22cbfebc5000fba /Documentation/networking/bareudp.rst
parent48851e9e802de3ede4ce81c3f7896c63e841adbc (diff)
downloadlinux-571912c69f0ed731bd1e071ade9dc7ca4aa52065.tar.gz
linux-571912c69f0ed731bd1e071ade9dc7ca4aa52065.tar.xz
net: UDP tunnel encapsulation module for tunnelling different protocols like MPLS, IP, NSH etc.
The Bareudp tunnel module provides a generic L3 encapsulation tunnelling module for tunnelling different protocols like MPLS, IP,NSH etc inside a UDP tunnel. Signed-off-by: Martin Varghese <martin.varghese@nokia.com> Acked-by: Willem de Bruijn <willemb@google.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/bareudp.rst')
-rw-r--r--Documentation/networking/bareudp.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/networking/bareudp.rst b/Documentation/networking/bareudp.rst
new file mode 100644
index 000000000000..6ee68c16cf5b
--- /dev/null
+++ b/Documentation/networking/bareudp.rst
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+========================================
+Bare UDP Tunnelling Module Documentation
+========================================
+
+There are various L3 encapsulation standards using UDP being discussed to
+leverage the UDP based load balancing capability of different networks.
+MPLSoUDP (__ https://tools.ietf.org/html/rfc7510) is one among them.
+
+The Bareudp tunnel module provides a generic L3 encapsulation tunnelling
+support for tunnelling different L3 protocols like MPLS, IP, NSH etc. inside
+a UDP tunnel.
+
+Usage
+------
+
+1) Device creation & deletion
+
+ a) ip link add dev bareudp0 type bareudp dstport 6635 ethertype 0x8847.
+
+ This creates a bareudp tunnel device which tunnels L3 traffic with ethertype
+ 0x8847 (MPLS traffic). The destination port of the UDP header will be set to
+ 6635.The device will listen on UDP port 6635 to receive traffic.
+
+ b) ip link delete bareudp0
+
+2) Device Usage
+
+The bareudp device could be used along with OVS or flower filter in TC.
+The OVS or TC flower layer must set the tunnel information in SKB dst field before
+sending packet buffer to the bareudp device for transmission. On reception the
+bareudp device extracts and stores the tunnel information in SKB dst field before
+passing the packet buffer to the network stack.