docs/scenarios/os-odl_l2-bgpvpn/scenario.description.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 Nikolas Hermanns (nikolas.hermanns@ericsson.com)
   4
   5 Introduction
   6 ============
   7 .. In this section explain the purpose of the scenario and the types of capabilities provided
   8
   9 Many Telecom network functions are relying on layer-3 infrastructure services, within a VNF
  10 between components, or towards existing external networks. In many cases, these external
  11 networks are implemented in MPLS/BGP technology in existing service provider wide-area-networks (WAN).
  12 This proven technology provides a good mechanism for inter-operation of a NFV Infrastructure (NFVI)
  13 and wide-area networks (WAN) and is the main capability provided by the OPNFV SDNVPN project.
  14
  15 .. should we explain here what a deployment scenario is?
  16 The OPNFV SDNVPN feature is made available through additional OPNFV deployment scenarios, which are derived
  17 from the baseline scenarios os-odl_l2-nofeature and os-odl_l3-nofeature. This document
  18 provides an outline of the os-odl_l2-bgpvpn scenarios including guidelines and references to
  19 required installation, software and hardware configuration documents.
  20
  21 Scenario components and composition
  22 ===================================
  23 .. In this section describe the unique components that make up the scenario,
  24 .. what each component provides and why it has been included in order
  25 .. to communicate to the user the capabilities available in this scenario.
  26
  27 The SDN VPN feature enhances OPNFV's baseline OpenStack deployment with the
  28 possibility to configure BGP based VPNs using the Neutron API extension and service plugin
  29 provided by the OpenStack Neutron
  30 Stadium project BGPVPN. The BGPVPN project consists of a Neutron API extension and a
  31 service plugin which has a driver framework similar to the ML2 plugin. BGPVPN today
  32 has a quite large number of backend drivers (Bagpipe, OpenContrail,
  33 Nuage and OpenDaylight currently). In OPNFV, currently only the OpenDaylight driver
  34 is supported.
  35
  36 The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight NetVirt service, which exposes the data
  37 center overlay like a virtual router to which Neutron Networks and Routers (and in the future also Ports)
  38 are connected. NetVirt has access to the state of the Neutron API through the OpenDaylight
  39 Neutron Northbound Interface module, which has been enhanced to support the BGPVPN API extension.
  40 It uses an internal mesh of VxLAN tunnels to interconnect the vSwitches on the data
  41 center compute nodes. For the purpose of BGP based route exchange with other BGP speakers the ODL
  42 controller makes use of Quagga BGP as an external BGP speaker.
  43
  44
  45 Scenario usage overview
  46 =======================
  47 .. Provide a brief overview on how to use the scenario and the features available to the
  48 .. user.  This should be an "introduction" to the user guide document, and explicitly link to it,
  49 .. where the specifics of the features are covered including examples and API's
  50
  51   When would I use this scenario, what value does it provide?  Refer to the user guide for details
  52   of configuration etc...
  53
  54 Configuring SDNVPN features
  55 ---------------------------
  56
  57 Each installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is enabled.
  58
  59 Fuel installer configuration
  60 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  61
  62 To install the SDNVPN feature using Fuel, follow the Fuel installation guide ensuring to select the SDNVPN
  63 feature when prompted <add link to Fuel docs once artifact locations are known>.
  64
  65 This will trigger installation of the OpenStack BGPVPN API extension for
  66 Neutron, set up for using the ODL driver, in addition to vanilla Neutron.
  67 In addition, the required karaf features will be activated when ODL is installed and the compute nodes
  68 will be configured including the VPN Service internal transport tunnel mesh.
  69
  70 No post-deploy configuration is necessary. The Fuel BGPVPN plugin and the ODL plugin
  71 should set up the cluster ready for BGPVPNs being created.
  72
  73 APEX installer configuration
  74 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  75
  76 To install the SDNVPN feature using the APEX installer, follow the APEX installation guide and
  77 activate the SDNVPN feature when prompted.
  78
  79 Limitations, Issues and Workarounds
  80 ===================================
  81 .. Explain scenario limitations here, this should be at a design level rather than discussing
  82 .. faults or bugs.  If the system design only provide some expected functionality then provide
  83 .. some insight at this point.
  84
  85 Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
  86 mapped onto the ODL NetVirt REST API through the BGPVPN ODL driver and the
  87 ODL Neutron Northbound module.
  88
  89 No DPDK-enabled vhost user ports are supported.
  90
  91 Integration with data center gateway will not work due to missing OVS patches for MPLSoGRE.
  92
  93 References
  94 ==========
  95
  96 For more information on the OPNFV Danube release, please visit
  97 http://www.opnfv.org/danube