|author||Tim Irnich <email@example.com>||2016-08-12 11:56:07 +0000|
|committer||Gerrit Code Review <firstname.lastname@example.org>||2016-08-12 11:56:07 +0000|
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
new file mode 100644
@@ -0,0 +1,42 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. (c) Tim Irnich, (email@example.com) and others
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+This document will provide an overview of how to work with the SDN VPN features in
+OPNFV. For a description of the scenarios and their provided capabilities refer to
+the scenario description document:
+SDN VPN feature description
+.. Describe the specific usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+The BGPVPN feature enables creation of BGP VPNs according to the OpenStack
+BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn.
+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
+Feature and API usage guidelines and example
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
+For the details of using OpenStack BGPVPN API, please refer to the documentation
+Can we give a basic example here? Pointing someone off to a generic document in reference to
+this specific compilation of components feels a little like only half the job. :)
+What? I thought this would work!