30daf22b67
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
158 lines
3.9 KiB
PHP
158 lines
3.9 KiB
PHP
====================
|
|
Network Associations
|
|
====================
|
|
|
|
Associating a BGPVPN to a Network can be done for both BGPVPN of type L2 and of
|
|
type L3. For type L3, the semantic is that all Subnets bound to the Network
|
|
will be interconnected with the BGP VPN (and thus between themselves).
|
|
|
|
A given Network can be associated with multiple BGPVPNs.
|
|
|
|
Associating or disassociating a BGPVPN to a Network is done by manipulating a
|
|
Network association API resource as a sub-resource of the BGPVPN resource:
|
|
|
|
List Network Associations
|
|
=========================
|
|
|
|
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations
|
|
|
|
Lists network 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: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_associations: bgpvpn-network_associations
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-list-response.json
|
|
:language: javascript
|
|
|
|
Create Network Association
|
|
==========================
|
|
|
|
.. rest_method:: POST /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations
|
|
|
|
Creates a network 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
|
|
- network_association: bgpvpn-network_association
|
|
- network_id: bgpvpn-network_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_association: bgpvpn-network_association
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-create-response.json
|
|
:language: javascript
|
|
|
|
Show Network Association details
|
|
================================
|
|
|
|
.. rest_method:: GET /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations/{network_association_id}
|
|
|
|
Shows details for a network association.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- network_association_id: bgpvpn-network_association_id-path
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- network_association: bgpvpn-network_association
|
|
- id: bgpvpn-network_association_id
|
|
- network_id: bgpvpn-network_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/bgpvpn/network_associations/network_association-show-response.json
|
|
:language: javascript
|
|
|
|
Delete Network Association
|
|
==========================
|
|
|
|
.. rest_method:: DELETE /v2.0/bgpvpn/bgpvpns/{bgpvpn_id}/network_associations/{network_association_id}
|
|
|
|
Deletes a network association.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- bgpvpn_id: bgpvpn-id-path
|
|
- network_association_id: bgpvpn-network_association_id-path
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE request.
|