summaryrefslogtreecommitdiffstats
path: root/docs/userguide/userguide.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguide/userguide.rst')
-rw-r--r--docs/userguide/userguide.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
index 7f3e4f9..f59fca3 100644
--- a/docs/userguide/userguide.rst
+++ b/docs/userguide/userguide.rst
@@ -1,7 +1,19 @@
-<Feature> capabilities and usage
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Tim Irnich, (tim.irnich@ericsson.com)
+
+SDN VPN capabilities and usage
================================
-Describe the specific capabilities and usage for <XYZ> feature.
-<Feature and API usage guidelines and example>
------------------------------------------------
-Describe with examples how to use specfic features.
+The BGPVPN feature enables creation of BGP VPNs according to the OpenStack
+BGPVPN blueprint <link>. In a nutshell, the blueprint defines a BGPVPN object
+and a number of ways how to associate it with the existing Neutron object model,
+including a unique definition of the related semantics. The BGPVPN framework
+supports a backend driver model with currently available drivers for Bagpipe,
+OpenContrail, Nuage and OpenDaylight. For the details of using the OpenStack
+BGP VPN API, please refer to the documentation at <link>.
+
+Currently, in OPNFV only ODL is supported as a backend for BGPVPN. The BGPVPN
+API calls are mapped onto the ODL VPN Service REST API through the BGPVPN ODL
+driver and the ODL Neutron Northbound module.
+