docs/release/scenarios/os-odl-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
  10 services, within a VNF between components, or towards existing external
  11 networks. In many cases, these external networks are implemented in
  12 MPLS/BGP technology in existing service provider wide-area-networks
  13 (WAN). This proven technology provides a good mechanism for
  14 inter-operation of a NFV Infrastructure (NFVI) and wide-area networks
  15 (WAN) and is the main capability provided by the OPNFV SDNVPN project.
  16
  17 .. should we explain here what a deployment scenario is?
  18
  19 The OPNFV SDNVPN feature is made available through additional OPNFV
  20 deployment scenarios, which is derived from the baseline
  21 os-odl-nofeature scenario.
  22
  23 The BGPVPN feature enables creation of BGP VPNs on the Neutron API
  24 according to the OpenStack BGPVPN blueprint at
  25 https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn. In a
  26 nutshell, the blueprint defines a BGPVPN object and a number of ways how
  27 to associate it with the existing Neutron object model, as well as a
  28 unique definition of the related semantics. The BGPVPN framework
  29 supports a backend driver model with currently available drivers for
  30 Bagpipe, OpenContrail, Nuage and OpenDaylight. The OPNFV scenario makes
  31 use of the OpenDaylight driver and backend implementation through the
  32 ODL NetVirt project.
  33
  34
  35
  36 Scenario components and composition
  37 ===================================
  38 .. In this section describe the unique components that make up the scenario,
  39 .. what each component provides and why it has been included in order
  40 .. to communicate to the user the capabilities available in this scenario.
  41
  42 The SDN VPN feature enhances OPNFV's baseline OpenStack deployment with
  43 the possibility to configure BGP based VPNs using the Neutron API
  44 extension and service plugin provided by the OpenStack Neutron Stadium
  45 project BGPVPN. The BGPVPN project consists of a Neutron API extension
  46 and a service plugin which has a driver framework similar to the ML2
  47 plugin. BGPVPN today has a quite large number of backend drivers
  48 (Bagpipe, OpenContrail, Nuage and OpenDaylight currently). In OPNFV,
  49 currently only the OpenDaylight driver is supported.
  50
  51 The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight NetVirt
  52 service, which exposes the data center overlay like a virtual router to
  53 which Neutron Networks and Routers (and in the future also Ports) are
  54 connected. NetVirt has access to the state of the Neutron API through
  55 the OpenDaylight Neutron Northbound Interface module, which has been
  56 enhanced to support the BGPVPN API extension. It uses an internal mesh
  57 of VxLAN tunnels to interconnect the vSwitches on the data center
  58 compute nodes. For the purpose of BGP based route exchange with other
  59 BGP speakers the ODL controller makes use of Quagga BGP as an external
  60 BGP speaker.
  61
  62
  63 Scenario usage overview
  64 =======================
  65 .. Provide a brief overview on how to use the scenario and the features available to the
  66 .. user.  This should be an "introduction" to the user guide document, and explicitly link to it,
  67 .. where the specifics of the features are covered including examples and API's
  68
  69   When would I use this scenario, what value does it provide?  Refer to the user guide for details
  70   of configuration etc...
  71
  72 Configuring SDNVPN features
  73 ---------------------------
  74
  75 Each installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is enabled.
  76
  77 Fuel installer configuration
  78 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  79
  80 To install the SDNVPN feature using Fuel, follow the Fuel installation guide ensuring to select the SDNVPN
  81 feature when prompted <add link to Fuel docs once artifact locations are known>.
  82
  83 This will trigger installation of the OpenStack BGPVPN API extension for
  84 Neutron, set up for using the ODL driver, in addition to vanilla Neutron.
  85 In addition, the required karaf features will be activated when ODL is installed and the compute nodes
  86 will be configured including the VPN Service internal transport tunnel mesh.
  87
  88 No post-deploy configuration is necessary. The Fuel BGPVPN plugin and the ODL plugin
  89 should set up the cluster ready for BGPVPNs being created.
  90
  91 APEX installer configuration
  92 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  93
  94 To install the SDNVPN feature using the APEX installer, follow the APEX installation guide
  95 (https://wiki.opnfv.org/display/apex/Integration+Guide) and activate the SDNVPN feature when prompted (step "# Now execute a deployment")
  96 i.e. python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-noha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16
  97
  98 Limitations, Issues and Workarounds
  99 ===================================
 100 .. Explain scenario limitations here, this should be at a design level rather than discussing
 101 .. faults or bugs.  If the system design only provide some expected functionality then provide
 102 .. some insight at this point.
 103
 104 Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
 105 mapped onto the ODL NetVirt REST API through the BGPVPN ODL driver and the
 106 ODL Neutron Northbound module.
 107
 108 No DPDK-enabled vhost user ports are supported.
 109
 110 Integration with data center gateway will not work due to missing OVS patches for MPLSoGRE.
 111
 112 References
 113 ==========
 114
 115 For more information on the OPNFV Danube release, please visit
 116 https://www.opnfv.org/software