summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configexamples/bgp-ipv6-unnumbered.rst2
-rw-r--r--docs/configuration/interfaces/dummy.rst4
-rw-r--r--docs/configuration/interfaces/loopback.rst4
-rw-r--r--docs/configuration/protocols/bgp.rst2
-rw-r--r--docs/configuration/protocols/isis.rst5
-rw-r--r--docs/configuration/protocols/static.rst2
-rw-r--r--docs/configuration/system/default-route.rst2
-rw-r--r--docs/configuration/vrf/index.rst163
8 files changed, 26 insertions, 158 deletions
diff --git a/docs/configexamples/bgp-ipv6-unnumbered.rst b/docs/configexamples/bgp-ipv6-unnumbered.rst
index ccc1f69a..fe4430ae 100644
--- a/docs/configexamples/bgp-ipv6-unnumbered.rst
+++ b/docs/configexamples/bgp-ipv6-unnumbered.rst
@@ -4,7 +4,7 @@
BGP IPv6 unnumbered with extended nexthop
#########################################
-General information can be found in the :ref:`bgp` chapter.
+General information can be found in the :ref:`routing-bgp` chapter.
Configuration
=============
diff --git a/docs/configuration/interfaces/dummy.rst b/docs/configuration/interfaces/dummy.rst
index c9845230..d59c1039 100644
--- a/docs/configuration/interfaces/dummy.rst
+++ b/docs/configuration/interfaces/dummy.rst
@@ -13,8 +13,8 @@ you can have as many as you want.
.. hint:: A Dummy interface is always up, thus it could be used for
management traffic or as source/destination for and :abbr:`IGP (Interior
- Gateway Protocol)` like :ref:`bgp` so your internal BGP link is not dependent
- on physical link states and multiple routes can be chosen to the
+ Gateway Protocol)` like :ref:`routing-bgp` so your internal BGP link is not
+ dependent on physical link states and multiple routes can be chosen to the
destination. A :ref:`dummy-interface` Interface should always be preferred
over a :ref:`loopback-interface` interface.
diff --git a/docs/configuration/interfaces/loopback.rst b/docs/configuration/interfaces/loopback.rst
index f7386c62..4d0c8fb6 100644
--- a/docs/configuration/interfaces/loopback.rst
+++ b/docs/configuration/interfaces/loopback.rst
@@ -14,8 +14,8 @@ services on your local machine.
.. hint:: A lookback interface is always up, thus it could be used for
management traffic or as source/destination for and :abbr:`IGP (Interior
- Gateway Protocol)` like :ref:`bgp` so your internal BGP link is not dependent
- on physical link states and multiple routes can be chosen to the
+ Gateway Protocol)` like :ref:`routing-bgp` so your internal BGP link is not
+ dependent on physical link states and multiple routes can be chosen to the
destination. A :ref:`dummy-interface` Interface should always be preferred
over a :ref:`loopback-interface` interface.
diff --git a/docs/configuration/protocols/bgp.rst b/docs/configuration/protocols/bgp.rst
index 32ed22e0..2ef7c247 100644
--- a/docs/configuration/protocols/bgp.rst
+++ b/docs/configuration/protocols/bgp.rst
@@ -1,4 +1,4 @@
-.. _bgp:
+.. _routing-bgp:
###
BGP
diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst
index ecc5ced7..a38db6f2 100644
--- a/docs/configuration/protocols/isis.rst
+++ b/docs/configuration/protocols/isis.rst
@@ -1,6 +1,6 @@
.. include:: /_include/need_improvement.txt
-.. _isis:
+.. _routing-isis:
#####
IS-IS
@@ -16,9 +16,6 @@ neighbors. IS-IS runs directly on the data link layer (Layer 2). IS-IS
addresses are called :abbr:`NETs (Network Entity Titles)` and can be
8 to 20 bytes long, but are generally 10 bytes long.
-
-
-
*******
General
*******
diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst
index 723db727..fed0dd22 100644
--- a/docs/configuration/protocols/static.rst
+++ b/docs/configuration/protocols/static.rst
@@ -1,4 +1,4 @@
-.. _static-routing:
+.. _routing-static:
######
Static
diff --git a/docs/configuration/system/default-route.rst b/docs/configuration/system/default-route.rst
index 27c74188..e102eb9c 100644
--- a/docs/configuration/system/default-route.rst
+++ b/docs/configuration/system/default-route.rst
@@ -36,5 +36,5 @@ Operation
Last update 09:46:30 ago
* 172.18.201.254, via eth0.201
-.. seealso:: Configuration of :ref:`static-routing`
+.. seealso:: Configuration of :ref:`routing-static`
diff --git a/docs/configuration/vrf/index.rst b/docs/configuration/vrf/index.rst
index 244784de..cd7f3d54 100644
--- a/docs/configuration/vrf/index.rst
+++ b/docs/configuration/vrf/index.rst
@@ -14,7 +14,6 @@ in the very least need different default gateways.
different then they are implemented and handled right now - please feedback
via a task created in Phabricator_.
-
Configuration
=============
@@ -58,157 +57,29 @@ itself needs to be assigned to an interface.
Routing
-------
-Static
-^^^^^^
-
-Static routes are manually configured routes, which, in general, cannot be
-updated dynamically from information VyOS learns about the network topology from
-other routing protocols. However, if a link fails, the router will remove
-routes, including static routes, from the :abbr:`RIPB (Routing Information
-Base)` that used this interface to reach the next hop. In general, static
-routes should only be used for very simple network topologies, or to override
-the behavior of a dynamic routing protocol for a small number of routes. The
-collection of all routes the router has learned from its configuration or from
-its dynamic routing protocols is stored in the RIB. Unicast routes are directly
-used to determine the forwarding table used for unicast packet forwarding.
-
-Static Routes
-"""""""""""""
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> next-hop <address>
-
- Configure next-hop `<address>` for an IPv4 static route in the VRF identified
- by `<name>`. Multiple static routes can be created.
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> next-hop <address>
- disable
-
- Disable IPv4 static route entry in the VRF identified by `<name>`
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> next-hop <address>
- distance <distance>
-
- Defines next-hop distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
-
- Range is 1 to 255, default is 1.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> next-hop <address>
-
- Configure next-hop `<address>` for an IPv6 static route in the VRF identified
- by `<name>`. Multiple IPv6 static routes can be created.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> next-hop <address>
- disable
-
- Disable IPv6 static route entry in the VRF identified by `<name>`.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> next-hop <address>
- distance <distance>
-
- Defines next-hop distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
-
- Range is 1 to 255, default is 1.
-
- .. note:: Routes with a distance of 255 are effectively disabled and not
- installed into the kernel.
-
-
-Leaking
-"""""""
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> next-hop <address>
- vrf <default | vrf-name>
-
- Use this command if you have shared services or routes that should be shared
- between multiple VRF instances. This will add an IPv4 route to VRF `<name>`
- routing table to reach a `<subnet>` via a next-hop gatewys `<address>` in
- a different VRF or leak it into the default VRF.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> next-hop <address>
- vrf <default | vrf-name>
-
- Use this command if you have shared services or routes that should be shared
- between multiple VRF instances. This will add an IPv6 route to VRF `<name>`
- routing table to reach a `<subnet>` via a next-hop gatewys `<address>` in
- a different VRF or leak it into the default VRF.
-
-
-Interface Routes
-""""""""""""""""
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet>
- interface <interface>
-
- Allows you to configure the next-hop interface for an interface-based IPv4
- static route. `<interface>` will be the next-hop interface where trafic is
- routed for the given `<subnet>`.
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet>
- interface <interface> disable
-
- Disables interface-based IPv4 static route.
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet>
- interface <interface> distance <distance>
-
- Defines next-hop distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
-
- Range is 1 to 255, default is 1.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet>
- interface <interface>
-
- Allows you to configure the next-hop interface for an interface-based IPv6
- static route. `<interface>` will be the next-hop interface where trafic is
- routed for the given `<subnet>`.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet>
- interface <interface> disable
-
- Disables interface-based IPv6 static route.
-
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet>
- interface <interface> distance <distance>
-
- Defines next-hop distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
-
- Range is 1 to 255, default is 1.
-
-Blackhole
-"""""""""
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> blackhole
-
- Use this command to configure a "black-hole" route on the router. A
- black-hole route is a route for which the system silently discard packets
- that are matched. This prevents networks leaking out public interfaces, but
- it does not prevent them from being used as a more specific route inside your
- network.
-
-.. cfgcmd:: set protocols vrf <name> static route <subnet> blackhole distance
- <distance>
+.. note:: VyOS 1.4 (sagitta) introduced dynamic routing support for VRFs.
- Defines blackhole distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
+Currently dynamic routing is supported for the following protocols:
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> blackhole
+- :ref:`routing-bgp`
+- :ref:`routing-isis`
+- :ref:`routing-ospf`
+- :ref:`routing-static`
- Use this command to configure a "black-hole" route on the router. A
- black-hole route is a route for which the system silently discard packets
- that are matched. This prevents networks leaking out public interfaces, but
- it does not prevent them from being used as a more specific route inside your
- network.
+The CLI configuration the same as mentioned in above articles. The only
+difference is, that each routing protocol used, must be prefixed with the `vrf
+name <name>` command.
-.. cfgcmd:: set protocols vrf <name> static route6 <subnet> blackhole distance
- <distance>
+Example
+^^^^^^^
- Defines blackhole distance for this route, routes with smaller administrative
- distance are elected prior those with a higher distance.
+The following commands would be required to set options ofr a given dynamic
+routing protocol inside a given vrf:
+- :ref:`routing-bgp`: ``set vrf name <name> protocols bgp ...``
+- :ref:`routing-isis`: ``set vrf name <name> protocols isis ...``
+- :ref:`routing-ospf`: ``set vrf name <name> protocols ospf ...``
+- :ref:`routing-static`: ``set vrf name <name> protocols static ...``
Operation
=========