Moving documentation content into new template
[sdnvpn.git] / docs / userguide / featureusage.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Tim Irnich, (tim.irnich@ericsson.com)
4
5 SDN VPN capabilities and usage
6 ================================
7 The BGPVPN feature enables creation of BGP VPNs according to the OpenStack
8 BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn.
9 In a nutshell, the blueprint defines a BGPVPN object and a number of ways
10 how to associate it with the existing Neutron object model, including a unique
11 definition of the related semantics. The BGPVPN framework supports a backend
12 driver model with currently available drivers for Bagpipe, OpenContrail, Nuage
13 and OpenDaylight.
14
15 Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
16 mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the
17 ODL Neutron Northbound module.
18
19 Feature and API usage guidelines and example
20 -----------------------------------------------
21
22 For the details of using OpenStack BGPVPN API, please refer to the documentation
23 at http://docs.openstack.org/developer/networking-bgpvpn/.