path: root/docs/userguide/feature.userguide.rst
diff options
authorTim Irnich <>2016-08-12 11:56:07 +0000
committerGerrit Code Review <gerrit@>2016-08-12 11:56:07 +0000
commitbc715cf525afa81c261a03ab7646f16ca6356f16 (patch)
treead2fe947cc865c73bca59c787a0af38a42b79c98 /docs/userguide/feature.userguide.rst
parentcd8f226ea6aa01432b003e6bbcfb314950445e4f (diff)
parentf4011396e88647e9fbbb2b99b4cb6c6da54b70bd (diff)
Merge "Applying the userguide template for the SDN VPN userguide documentation."
Diffstat (limited to 'docs/userguide/feature.userguide.rst')
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
new file mode 100644
index 0000000..a531fe2
--- /dev/null
+++ b/docs/userguide/feature.userguide.rst
@@ -0,0 +1,42 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. (c) Tim Irnich, ( 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
+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.
+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!