summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-30 12:17:20 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-30 12:17:20 +0100
commit5a09b36ecbcfcfa3f71861d7c586b9edee73b61a (patch)
treeefd8e17a9993c314832604f40cc41d919a07c493
parent158b50d2476d5e5efe3189f4a933aa480f9b0a43 (diff)
downloadvyos-documentation-5a09b36ecbcfcfa3f71861d7c586b9edee73b61a.tar.gz
vyos-documentation-5a09b36ecbcfcfa3f71861d7c586b9edee73b61a.zip
vxlan: use documented section style guide
-rw-r--r--docs/interfaces/vxlan.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index e597e167..04e38f7e 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -1,7 +1,8 @@
.. _vxlan-interface:
+#####
VXLAN
------
+#####
:abbr:`VXLAN (Virtual Extensible LAN)` is a network virtualization technology
that attempts to address the scalability problems associated with large cloud
@@ -33,7 +34,7 @@ may be blocked by the hypervisor.
per VXLAN interface basis to get it working accross multiple vendors.
Multicast VXLAN
-^^^^^^^^^^^^^^^^
+===============
Example Topology:
@@ -65,8 +66,8 @@ For optimal scalability Multicast shouldn't be used at all, but instead use BGP
to signal all connected devices between leafs. Unfortunately, VyOS does not yet
support this.
-Configuration commands
-^^^^^^^^^^^^^^^^^^^^^^
+Configuration
+=============
.. code-block:: none
@@ -83,8 +84,8 @@ Configuration commands
remote # Remote address of the VXLAN tunnel, used for PTP instead of multicast
vni <1-16777215> # Virtual Network Identifier (required)
-Configuration Example
-^^^^^^^^^^^^^^^^^^^^^
+Example
+-------
The setup is this:
@@ -239,7 +240,7 @@ configuration directive to support a user-specified destination port to override
that behavior is available using the above command.
Older Examples
-^^^^^^^^^^^^^^
+--------------
Example for bridging normal L2 segment and vxlan overlay network, and using a
vxlan interface as routing interface.
@@ -304,7 +305,7 @@ gateway. You can add an IP to a bridge to create a gateway.
}
Unicast VXLAN
-^^^^^^^^^^^^^
+=============
Alternative to multicast, the remote IPv4 address of the VXLAN tunnel can set directly.
Let's change the Multicast example from above: