diff options
author | 2016-08-15 08:56:08 +0200 | |
---|---|---|
committer | 2016-08-19 15:18:56 +0200 | |
commit | a070148babcc8f589baef1166197263761a63f46 (patch) | |
tree | 4667746ca75224a48930e20988a8136e7c3beecd /docs/scenarios | |
parent | bc715cf525afa81c261a03ab7646f16ca6356f16 (diff) |
Moving documentation content into new template
JIRA: DOCS-103, DOCS-134, SDNVPN-40
Moving documentation content into new feature description and user guide template.
Change-Id: I2c1549b44ef43e28961f1a0d2885adc0dd161910
Signed-off-by: Tim Irnich <tim.irnich@ericsson.com>
Diffstat (limited to 'docs/scenarios')
-rw-r--r-- | docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst | 74 |
1 files changed, 59 insertions, 15 deletions
diff --git a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst index b7ef93a..4af9de6 100644 --- a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst +++ b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst @@ -6,15 +6,39 @@ 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 +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. +and wide-area networks (WAN) and is the main capability provided by the OPNFV SDNVPN project. + +.. should we explain here what a deployment scenario is? +The OPNFV SDNVPN feature is made available through additional OPNFV deployment scenarios, which are derived +from the baseline scenarios os-odl_l2-nofeature and os-odl_l3-nofeature. This document +provides an outline of the os-odl_l2-bgpvpn scenarios including guidelines and references to +required installation, software and hardware configuration documents. + +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. + +The SDN VPN feature enhances OPNFV's baseline OpenStack deployment with the +possibility to configure BGP based VPNs according to the OpenStack Neutron +Stadium project BGPVPN. The BGPVPN project consists of a Neutron API extension and a +service plugin which has a driver framework similar to the ML2 plugin. BGPVPN today +has a quite large number of backend drivers (Bagpipe, OpenContrail, +Nuage and OpenDaylight currently). In OPNFV, currently only the OpenDaylight driver +is supported. -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. +The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight VPNService, which exposes the data +center overlay like a virtual router to which Neutron Networks and Routers (and in the future also Ports) +are connected. The VPNService has access to the state of the Neutron API through the OpenDaylight +Neutron Northbound Interface module, which has been enhanced to support the BGPVPN API extension. +It uses an internal mesh of VxLAN tunnels to interconnect the vSwitches on the data +center compute nodes. For the purpose of BGP based route exchange with other BGP speakers the ODL +controller makes use of Quagga BGP as an external BGP speaker. <To be completed, this outlines the basic content and flow> Description of bgpvpn scenarios @@ -26,12 +50,6 @@ guidelines and references to required installation, software and hardware config 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) @@ -43,12 +61,37 @@ Scenario components and composition 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, +.. user. This should be an "introduction" to the user guide 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 + When would I use this scenario, what value does it provide? Refer to the user guide for details of configuration etc... +Configuring SDNVPN features +--------------------------- + +Each installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is enabled. + +Fuel installer configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install the SDNVPN feature using Fuel, follow the Fuel installation guide ensuring to select the SDNVPN +feature when prompted <add link to Fuel docs once artifact locations are known>. + +This will trigger installation of the OpenStack BGPVPN API extension for +Neutron, set up for using the ODL driver, in addition to vanilla Neutron. +In addition, the required karaf features will be activated when ODL is installed and the compute nodes +will be configured including the VPN Service internal transport tunnel mesh. + +No post-deploy configuration is necessary. The Fuel BGPVPN plugin and the ODL plugin +should set up the cluster ready for BGPVPNs being created. + +APEX installer configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install the SDNVPN feature using the APEX installer, follow the APEX installation guide and +activate the SDNVPN feature when prompted. + Limitations, Issues and Workarounds =================================== .. Explain scenario limitations here, this should be at a design level rather than discussing @@ -59,8 +102,9 @@ 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? +No DPDK-enabled vhost user ports + +Integration with data center gateway will not work due to missing OVS patches for MPLSoGRE. References ========== |