summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-17 20:20:16 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-17 20:20:16 +0100
commit73edff0a21f8486a2c416537b72dda60c1885462 (patch)
treef94a3e0a545abfe2628cc82255790ddd7c4e5b77 /docs/interfaces
parent4e3fd8b583b17eb1a83681e35bea72b414d30b2e (diff)
downloadvyos-documentation-73edff0a21f8486a2c416537b72dda60c1885462.tar.gz
vyos-documentation-73edff0a21f8486a2c416537b72dda60c1885462.zip
Replace all RFC links with proper :rfc: syntax
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/addresses.rst13
-rw-r--r--docs/interfaces/l2tpv3.rst3
-rw-r--r--docs/interfaces/pppoe.rst4
-rw-r--r--docs/interfaces/tunnel.rst10
-rw-r--r--docs/interfaces/vxlan.rst8
5 files changed, 10 insertions, 28 deletions
diff --git a/docs/interfaces/addresses.rst b/docs/interfaces/addresses.rst
index 51d2e7e5..0ced23f8 100644
--- a/docs/interfaces/addresses.rst
+++ b/docs/interfaces/addresses.rst
@@ -87,7 +87,7 @@ The command is `set interfaces $type $name address dhcpv6`. Examples:
Autoconfiguration (SLAAC)
*************************
-SLAAC is specified in RFC4862_. This method is supported on all physical
+SLAAC is specified in :rfc:`4862`. This method is supported on all physical
interfaces, and those that are directly connected to a physical interface
(ethernet, VLAN, bridge, bond, pseudo-ethernet, wireless).
@@ -104,7 +104,7 @@ The command is `set interfaces $type $name ipv6 address autoconf`. Examples:
EUI-64
******
-EUI-64 (64-Bit Extended Unique Identifier) as specified in RFC4291_. IPv6
+EUI-64 (64-Bit Extended Unique Identifier) as specified in :rfc:`4291`. IPv6
addresses in /64 networks can be automatically generated from the prefix and
MAC address, if you specify the prefix.
@@ -120,7 +120,7 @@ Examples:
Router Advertisements
*********************
-Router advertisements are described in `RFC4861 section 4.2`_. They are part of what is known as SLAAC (Stateless Address Autoconfiguration).
+Router advertisements are described in :rfc:`4861` section 4.2. They are part of what is known as SLAAC (Stateless Address Autoconfiguration).
To enable or disable, use:
@@ -152,7 +152,7 @@ To set the options described in "Router Advertisement Message Format":
**Prefix Information**
-Prefix information is described in `RFC4861 section 4.6.2`_
+Prefix information is described in :rfc:`4861` section 4.6.2.
.. code-block:: sh
@@ -171,8 +171,3 @@ To receive and accept RAs on an interface, you need to enable it with the follow
vyos@vyos# set system sysctl custom net.ipv6.conf.<interface name>.accept_ra value 2
-
-.. _`RFC4861 section 4.6.2`: https://tools.ietf.org/html/rfc4861#section-4.6.2
-.. _`RFC4861 section 4.2`: https://tools.ietf.org/html/rfc4861#section-4.2
-.. _RFC4862: https://tools.ietf.org/html/rfc4862
-.. _RFC4291: http://tools.ietf.org/html/rfc4291#section-2.5.1
diff --git a/docs/interfaces/l2tpv3.rst b/docs/interfaces/l2tpv3.rst
index 4cc296ca..ec2762eb 100644
--- a/docs/interfaces/l2tpv3.rst
+++ b/docs/interfaces/l2tpv3.rst
@@ -3,7 +3,7 @@
L2TPv3 Interfaces
-----------------
-L2TPv3 is a pseudowire protocol, you can read more about here `Wikipedia L2TPv3`_ or `RFC3921`_
+L2TPv3 is a pseudowire protocol, you can read more about here `Wikipedia L2TPv3`_ or :rfc:`3921`
L2TPv3 can transport any traffic including ethernet frames. L2TPv2 is limited to PPP.
@@ -116,4 +116,3 @@ L2TPv3:
set interfaces l2tpv3 l2tpeth0 tunnel-id '10'
.. _`Wikipedia L2TPv3`: http://en.wikipedia.org/wiki/L2TPv3
-.. _`RFC3921`: https://tools.ietf.org/html/rfc3931
diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst
index c4eb2d8f..42d7c3b4 100644
--- a/docs/interfaces/pppoe.rst
+++ b/docs/interfaces/pppoe.rst
@@ -8,7 +8,7 @@ There are two main ways to setup VyOS to connect over a PPPoE internet connectio
**First Method:** (Common for Homes)
-In this method, the DSL Modem/Router connects to the ISP for you with your credentials preprogrammed into the device. This gives you an RFC1918_ address, such as 192.168.1.0/24 by default.
+In this method, the DSL Modem/Router connects to the ISP for you with your credentials preprogrammed into the device. This gives you an :rfc:`1918` address, such as ``192.168.1.0/24`` by default.
For a simple home network using just the ISP's equipment, this is usually desirable. But if you want to run VyOS as your firewall and router, this will result in having a double NAT and firewall setup. This results in a few extra layers of complexity, particularly if you use some NAT or tunnel features.
@@ -78,5 +78,3 @@ This command shows the same log as without the 'tail' option but only starts wit
.. code-block:: sh
show interfaces pppoe 0 log tail
-
-.. _RFC1918: https://tools.ietf.org/html/rfc1918
diff --git a/docs/interfaces/tunnel.rst b/docs/interfaces/tunnel.rst
index 7103e5a2..54e9c1c1 100644
--- a/docs/interfaces/tunnel.rst
+++ b/docs/interfaces/tunnel.rst
@@ -13,7 +13,7 @@ All those protocols are grouped under 'interfaces tunnel' in VyOS. Let's take a
IPIP
----
-This is one of the simplest types of tunnels, as defined by RFC2003_.
+This is one of the simplest types of tunnels, as defined by :rfc:`2003`.
It takes an IPv4 packet and sends it as a payload of another IPv4 packet. For this reason, there are no other configuration options for this kind of tunnel.
An example:
@@ -28,7 +28,7 @@ An example:
IP6IP6
------
-This is the IPv6 counterpart of IPIP. I'm not aware of an RFC that defines this encapsulation specifically, but it's a natural specific case of IPv6 encapsulation mechanisms described in RFC2473_.
+This is the IPv6 counterpart of IPIP. I'm not aware of an RFC that defines this encapsulation specifically, but it's a natural specific case of IPv6 encapsulation mechanisms described in :rfc:2473`.
It's not likely that anyone will need it any time soon, but it does exist.
@@ -61,7 +61,7 @@ An example:
----------
-6in4 uses tunneling to encapsulate IPv6 traffic over IPv4 links as defined in RFC4213_.
+6in4 uses tunneling to encapsulate IPv6 traffic over IPv4 links as defined in :rfc:`4213`.
The 6in4 traffic is sent over IPv4 inside IPv4 packets whose IP headers have the IP protocol number set to 41.
This protocol number is specifically designated for IPv6 encapsulation, the IPv4 packet header is immediately followed by the IPv6 packet being carried.
The encapsulation overhead is the size of the IPv4 header of 20 bytes, therefore with an MTU of 1500 bytes, IPv6 packets of 1480 bytes can be sent without fragmentation. This tunneling technique is frequently used by IPv6 tunnel brokers like `Hurricane Electric`_.
@@ -188,9 +188,5 @@ Results in:
description "Description"
}
-
-.. _RFC2003: https://tools.ietf.org/html/rfc2003
-.. _RFC2473: https://tools.ietf.org/html/rfc2473
.. _`other proposals`: https://www.isc.org/downloads/aftr
-.. _RFC4213: https://tools.ietf.org/html/rfc4213
.. _`Hurricane Electric`: https://tunnelbroker.net/
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index 2795fc75..d432bdc6 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -1,8 +1,7 @@
VXLAN
-----
-VXLAN is an overlaying Ethernet over IP protocol.
-It is described in RFC7348_.
+VXLAN is an overlaying Ethernet over IP protocol, it's described in :rfc:`7348`.
If configuring VXLAN in a VyOS virtual machine, ensure that MAC spoofing
(Hyper-V) or Forged Transmits (ESX) are permitted, otherwise forwarded frames
@@ -300,8 +299,3 @@ Let's change the Multicast example from above:
The default port udp is set to 8472.
It can be changed with ``set interface vxlan <vxlanN> remote-port <port>``
-
-
-.. target-notes::
-
-.. _RFC7348: https://datatracker.ietf.org/doc/rfc7348/