lagertonne/ifupdown-ng
1
0
Fork 0
Code Issues Pull requests Projects Releases 4 Wiki Activity

doc: Polish VXLAN related documentation.

Browse source 
Thanks-to: Blake W.
Signed-off-by: Maximilian Wilhelm <max@sdn.clinic>
This commit is contained in:
Maximilian Wilhelm 2020-10-02 22:29:01 +02:00
parent 704b2feecb
commit 7cf353dd22
1 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/interfaces-vxlan.scd
View file

@ -10,14 +10,15 @@ Virtual eXtensible LAN (VXLAN) is an overlay network to carry Layer 2 over
an IP network while accommodating a very large number of tenants. It is an IP network while accommodating a very large number of tenants. It is
defined in RFC 7348. defined in RFC 7348.
Beware that VXLAN encapsulation adds an overhead of 50 bytes from witin Be aware that VXLAN encapsulation adds 50 bytes of overhead to the IP packet
the overlay to the underlay (inner Ethernet frame + VXLAN + UDP + IP header (inner Ethernet header + VXLAN + UDP + IP). This should be taken into
haeder). Consider this when setting up underlay an overlay. consideration when setting up overlay networks, particularly on underlay
networks with a conventional 1500 byte MTU.
The following options allow to set up VXLAN Tunnel EndPoints (VTEPs) The following options set up VXLAN Tunnel EndPoints (VTEP) interfaces with
interfaces with ifupdown-ng. ifupdown-ng.
See https://www.kernel.org/doc/Documentation/networking/vxlan.rst and/or See https://www.kernel.org/doc/Documentation/networking/vxlan.rst and
https://vincent.bernat.ch/en/blog/2017-vxlan-linux for more information. https://vincent.bernat.ch/en/blog/2017-vxlan-linux for more information.
# VXLAN-RELATED OPTIONS # VXLAN-RELATED OPTIONS
@ -27,11 +28,11 @@ other options are optional.
*vxlan-id* _VNI ID_ *vxlan-id* _VNI ID_
Denotes the VXLAN Network Identifier (VNI) ID for this interface. Denotes the VXLAN Network Identifier (VNI) ID for this interface.
This parameter is required for a VXLAN interface. This parameter is required for VTEP interfaces.
*vxlan-physdev* _interface_ *vxlan-physdev* _interface_
Specifies the physical device to use for tunnel endpoint Specifies the physical ("underlay") device to use for tunnel
communication. endpoint communication.
*vxlan-local-ip* _address_ *vxlan-local-ip* _address_
Specifies the source IP address to use in outgoing packets. Specifies the source IP address to use in outgoing packets.
@ -47,8 +48,8 @@ other options are optional.
this parameter. this parameter.
*vxlan-remote-group* _multicast group_ *vxlan-remote-group* _multicast group_
Specifies the multicast IP address to join. This parameter cannot Specifies the multicast group IP address to join. This parameter
be specified with the _vxlan-remote-ip_ parameter. cannot be specified with the _vxlan-remote-ip_ parameter.
For compatibility with ifupdown2 _vxlan-svcnodeip_ is an alias for For compatibility with ifupdown2 _vxlan-svcnodeip_ is an alias for
this parameter. this parameter.
@ -60,8 +61,8 @@ other options are optional.
Specifies the lifetime in seconds of FDB entries learnt by the kernel. Specifies the lifetime in seconds of FDB entries learnt by the kernel.
*vxlan-dstport* _port_ *vxlan-dstport* _port_
Specifies the UDP destination port to communicate to the remote VXLAN Specifies the UDP destination port of the remote VXLAN tunnel endpoint.
tunnel endpoint. The default is 4789. The default is 4789.
# EXAMPLES # EXAMPLES