Merge "Applying the userguide template for the SDN VPN userguide documentation."

2 files changed, 85 insertions, 0 deletions

diff --git a/docs/scenarios/os-odl_l2-bgpvpn/index.rst b/docs/scenarios/os-odl_l2-bgpvpn/index.rst
new file mode 100644
index 0000000..a2e5076
--- /dev/null
+++ b/docs/scenarios/os-odl_l2-bgpvpn/index.rst
@@ -0,0 +1,16 @@
+.. 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> and others
+
+=========================================
+os-odl_l2-bgpvpn overview and description
+=========================================
+.. This document will be used to provide a description of the scenario for an end user.
+.. You should explain the purpose of the scenario, the types of capabilities provided and
+..  the unique components that make up the scenario including how they are used.
+
+.. toctree::
+   :maxdepth: 3
+
+   ./scenario.description.rst
+
diff --git a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst
new file mode 100644
index 0000000..b7ef93a
--- /dev/null
+++ b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst
@@ -0,0 +1,69 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Many telecom network functions are relying on layer-3 infrastructure services, within a VNF
+between components, or towards existing external networks. In many cases, these external
+networks are implemented in MPLS/BGP technology in existing service provider wide-area-networks (WAN).
+
+This proven technology provides a good mechanism for inter-operation of a NFV Infrastructure (NFVI)
+and wide-area networks (WAN) and is the main feature set provided by the BGP VPN project.
+
+This document provides an outline of the os-odl_l2-bgpvpn scenarios of OPNFV including
+guidelines and references to required installation, software and hardware configuration documents.
+
+  <To be completed, this outlines the basic content and flow>
+  Description of bgpvpn scenarios
+  Description of the internal transport tunnel mesh
+  Install Neutron BGPVPN additions (networking-bgpvpn)
+  Neutron odl additions (networking-odl)
+  install and configure Quagga (incl. config on ODL side)
+  configure OVS to connect to ODL and set up the right bridges (network architecture)
+  set up iptables to allow connections between OVS and ODL
+  set up HA proxy so that ODL can be reached
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+  <Where applicable and without copying the installation procedure in the install guides>
+  Describe Neutron BGPVPN additions (networking-bgpvpn)
+  Neutron odl additions (networking-odl)
+  Usage and the role of Quagga (incl. config on ODL side)
+  OVS and ODL specifics around setting up the right bridges (network architecture)
+  "" iptables to allow connections between OVS and ODL
+  "" HA proxy so that ODL can be reached
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+  When would I use this scenario, what value does it provide?  Refer to the userguide for details
+  of configuration etc...
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs.  If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
+mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the
+ODL Neutron Northbound module.
+
+Are there places these basic procedures will not work.  Do we have constraints on the use of
+Quagga that may change in the future?
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please visit
+http://www.opnfv.org/colorado