openstack/neutron-lib
Code Issues Proposed changes

[api-ref] Added warning about overwriting router's default routes

Browse Source 
When user will add to the router extra route which will overwrite
default router of one of the subnets attached to the router, and later
will remove this extra route, traffic to/from such subnet will be
broken.
This patch adds warning about that to the router's extra route API
documentation.

Co-Authored-By: Brian Haley <haleyb.dev@gmail.com>

Change-Id: I488530f6805392be7de205d7a55081b053991c78
This commit is contained in:
Slawek Kaplonski 2020-07-27 11:32:49 +02:00
parent 06e14c9565
commit 67fcda4284
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
api-ref/source/v2/routers.inc
View File

@ -26,6 +26,15 @@ When the ``extraroute-atomic`` extension is also available you can add
or remove a set of extra routes atomically on the server side. For details
please see below.
.. warning::
By default in a router there is one route for each attached subnet. If you
add an extra route that matches one of the default routes for a subnet,
the existing subnet route will be overwritten.
If the Neutron route is removed, the corresponding route will be removed
as well. The affected subnet will subsequently lose connectivity to this
router.
Extra routes (atomic) extension
===============================
@ -34,6 +43,15 @@ The extra route atomic extension (``extraroute-atomic``) extends the
``remove_extraroutes``) to edit the set of extra routes atomically on
the server side.
.. warning::
By default in a router there is one route for each attached subnet. If you
add an extra route that matches one of the default routes for a subnet,
the existing subnet route will be overwritten.
If the Neutron route is removed, the corresponding route will be removed
as well. The affected subnet will subsequently lose connectivity to this
router.
HA capability for router extension (``l3-ha``)
=======================================================