docs/userguide/feature.userguide.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) and others
   4
   5 Introduction
   6 ============
   7 .. Describe the specific features and how it is realised in the scenario in a brief manner
   8 .. to ensure the user understand the context for the user guide instructions to follow.
   9
  10 This document will provide an overview of how to work with the SDN VPN features in
  11 OPNFV.  For a description of the scenarios and their provided capabilities refer to
  12 the scenario description document:
  13 http://artifacts.opnfv.org/colorado/sdnpvn/scenarios/os-odl_l2-bgpvpn/index.html
  14
  15 SDN VPN feature description
  16 ===========================
  17 .. Describe the specific usage for <XYZ> feature.
  18 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
  19
  20 The BGPVPN feature enables creation of BGP VPNs according to the OpenStack
  21 BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn.
  22 In a nutshell, the blueprint defines a BGPVPN object and a number of ways
  23 how to associate it with the existing Neutron object model, including a unique
  24 definition of the related semantics. The BGPVPN framework supports a backend
  25 driver model with currently available drivers for Bagpipe, OpenContrail, Nuage
  26 and OpenDaylight.
  27
  28 Feature and API usage guidelines and example
  29 ============================================
  30 .. Describe with examples how to use specific features, provide API examples and details required to
  31 .. operate the feature on the platform.
  32
  33 For the details of using OpenStack BGPVPN API, please refer to the documentation
  34 at http://docs.openstack.org/developer/networking-bgpvpn/.
  35
  36 Can we give a basic example here?  Pointing someone off to a generic document in reference to
  37 this specific compilation of components feels a little like only half the job.  :)
  38
  39 Troubleshooting
  40 ===============
  41
  42 What? I thought this would work!