openstack/neutron-lib
Code Issues Proposed changes
neutron-lib/api-ref/source/v2/bgpvpn-port_associations.inc
Thomas Morin 30daf22b67 bgpvpn-routes-control extension 
This change defines the bgpvpn-routes-control extension.

Beyond the already defined resources for network and router associations
with BGPVPNs, this extension defines port associations allowing to
control BGPVPN connectivity at the granularity of a neutron port.

Additionally, this extension provides features to control what routes
are advertised to a BGPVPN, as summarized in
neutron_lib/api-ref/source/v2/bgpvpn-overview.inc:

With the ``bgpvpn`` extension, when associations between networks or
routers and BGVPNs are defined, the routes corresponding to fixed IPs of
neutron ports will be advertised to BGPVPNs.  For router associations,
extra routes of the router ('routes' attribute of a ``router`` resource)
may also be advertized to BGPVPNs.

To provide more flexibility, the ``bgpvpn-routes-control`` extension
provides a way to:

- advertise other routes to a BGPVPN, for instances a prefix that is
  reachable via a neutron port, or routes leaked from another BGPVPN;
  this is implemented thanks to the ``routes`` attribute of a BGPVPN
  port association

- not advertise the fixed IPs of a neutron port to a BGPVPN, which
  can be particularly relevant when other IP prefixes are reachable via
  the port; this is implemented thanks to the ``advertise_fixed_ips``
  attribute of a BGPVPN port association

- explictly control whether extra routes of a router are to be
  advertized to a BGPVPN; this is implemented thanks to the
  ``advertise_extra_routes`` attribute of a BGPVPN router association

- optionally control the value of the LOCAL_PREF BGP attribute of
  advertized routes, for all routes of a BGPVPN (thanks to the
  ``local_pref`` attribute of a BGPVPN resource) and/or per route
  (thanks to the ``local_pref``  in a port association route)

Partially Implements: blueprint routes-control

Change-Id: Ib2cefcb6a345887435b754fbdcff3584329d45d2
2017-06-14 16:19:34 +00:00

249 lines
7.0 KiB
PHP
Raw Blame History

=================
Port Associations
=================
Port associations are available if the ``bgpvpn-routes-control`` extension
is available.
Associating or disassociating a BGPVPN to a Port is done by manipulating a
Port association API resource as a sub-resource of the BGPVPN resource.
The semantic behind this API call is a form of policy-based routing: the
traffic from the given Port will be processed according to dataplane lookups
specific to this Port. This means, in particular that Ports belonging to a
given neutron network will possibly see a different L2 or L3 connectivity if
they have different BGPVPN associations.
When, a port association is defined for a given port, and at the same time,
a network association is defined for the port's network, both associations are
considered simultaneously active and the connectivity will be established
between the port and the BGPVPNs in both associations. This is true also in
the case where multiple associations are made, and for a router associations
of a router connected to the port's network.
Port routes
===========
Additionally to providing Port-level granularity in the definition of BGPVPN
connectivity, port associations also provide a way to control the
advertisement of routes other than only the fixed IPs of neutron ports.
So-called static routes are defined as follows: to indicate that prefix
20.1.0.0/16 is reachable via port A and should be advertised
accordingly in BGPVPN X, a port association is defined between port A
and BGPVPN X, with the ``routes`` attribute set to ``[ {'type': 'prefix',
'prefix': '20.1.0.0/16'} ]``.
Route leaking of the routes of a given BGPVPN into another BGPVPN belonging
to the same tenant, is supported similarily: to indicate that all the prefixes
advertised to BGPVPN Y are reachable via port A (i.e. the routes tagged with at
least an RT belonging to ``route_targets`` or ``import_targets`` of BGPVPN Y),
and that they should be leaked into BGPVPN X, a port association is defined
between port A and BGPVPN X, with the ``routes`` attribute set to
``[ {'type': 'bgpvpn', 'bgpvpn_id': <uuid of BGPVPN Y>} ]``.
Control of BGP LOCAL_PREF attribute
===================================
The BGP LOCAL_PREF for a specific route can be controlled to take a different
value than the one defined in the BGPVPN ``local_pref`` attribute, by
adding a ``'local_pref': VALUE`` in a route in the ``routes`` attribute (see
example in port association Update request).
List Port Associations
======================
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/port_associations
Lists port associations for a given BGP VPN.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- bgpvpn_id: bgpvpn-id-path
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- port_associations: bgpvpn-port_associations
- id: bgpvpn-port_association_id
- port_id: bgpvpn-port_id
- project_id: project_id
- routes: bgpvpn-routes
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips
Response Example
----------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-list-response.json
:language: javascript
Create Port Association
=======================
.. rest_method:: POST /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/port_associations
Creates a port association for a given BGP VPN
Normal response codes: 201
Error response codes: 400, 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- bgpvpn_id: bgpvpn-id-path
- port_association: bgpvpn-port_association
- port_id: bgpvpn-port_id
- routes: bgpvpn-routes-request
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips-request
Request Example
---------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- port_association: bgpvpn-port_association
- id: bgpvpn-port_association_id
- port_id: bgpvpn-port_id
- project_id: project_id
- routes: bgpvpn-routes
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips
Response Example
----------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-create-response.json
:language: javascript
Show Port Association details
=============================
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/port_associations/{port_association_id}
Shows details for a port association.
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- bgpvpn_id: bgpvpn-id-path
- port_association_id: bgpvpn-port_association_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- port_association: bgpvpn-port_association
- id: bgpvpn-port_association_id
- port_id: bgpvpn-port_id
- project_id: project_id
- routes: bgpvpn-routes
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips
Response Example
----------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-show-response.json
:language: javascript
Update a Port Association
=========================
.. rest_method:: PUT /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/port_associations/{port_association_id}
Updates a port Association.
Normal response codes: 201
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- bgpvpn_id: bgpvpn-id-path
- port_association_id: bgpvpn-port_association_id-path
- port_association: bgpvpn-port_association
- routes: bgpvpn-routes-request
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips-request
Request Example
---------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- port_association: bgpvpn-port_association
- id: bgpvpn-port_association_id
- port_id: bgpvpn-port_id
- project_id: project_id
- routes: bgpvpn-routes
- advertise_fixed_ips: bgpvpn-advertise_fixed_ips
Response Example
----------------
.. literalinclude:: samples/bgpvpn/port_associations/port_association-update-response.json
:language: javascript
Delete Port Association
=======================
.. rest_method:: DELETE /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/port_associations/{port_association_id}
Deletes a port association.
Normal response codes: 204
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- bgpvpn_id: bgpvpn-id-path
- port_association_id: bgpvpn-port_association_id-path
Response
--------
There is no body content for the response of a successful DELETE request.
View Git Blame Copy Permalink