docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) Periyasamy Palanisamy <periyasamy.palanisamy@ericsson.com> and others
   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 <https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn>`_.
  25 In a nutshell, the blueprint defines a BGPVPN object and a number of ways how
  26 to associate it with the existing Neutron object model, as well as a
  27 unique definition of the related semantics. The BGPVPN framework
  28 supports a backend driver model with currently available drivers for
  29 Bagpipe, OpenContrail, Nuage and OpenDaylight. The OPNFV scenario makes
  30 use of the OpenDaylight driver and backend implementation through the
  31 ODL NetVirt project.
  32
  33
  34
  35 Scenario components and composition
  36 ===================================
  37 .. In this section describe the unique components that make up the scenario,
  38 .. what each component provides and why it has been included in order
  39 .. to communicate to the user the capabilities available in this scenario.
  40
  41 The SDN VPN feature enhances OPNFV's baseline OpenStack deployment with
  42 the possibility to configure BGP based VPNs using the Neutron API
  43 extension and service plugin provided by the OpenStack Neutron Stadium
  44 project BGPVPN. The BGPVPN project consists of a Neutron API extension
  45 and a service plugin which has a driver framework similar to the ML2
  46 plugin. BGPVPN today has a quite large number of backend drivers
  47 (Bagpipe, OpenContrail, Nuage and OpenDaylight currently). In OPNFV,
  48 currently only the OpenDaylight driver is supported.
  49
  50 The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight NetVirt
  51 service, which exposes the data center overlay like a virtual router to
  52 which Neutron Networks and Routers (and in the future also Ports) are
  53 connected. NetVirt has access to the state of the Neutron API through
  54 the OpenDaylight Neutron Northbound Interface module, which has been
  55 enhanced to support the BGPVPN API extension. It uses an internal mesh
  56 of VxLAN tunnels to interconnect the vSwitches on the data center
  57 compute nodes. For the purpose of BGP based route exchange with other
  58 BGP speakers the ODL controller makes use of Quagga BGP as an external
  59 BGP speaker.
  60
  61
  62 Scenario usage overview
  63 =======================
  64 .. Provide a brief overview on how to use the scenario and the features available to the
  65 .. user.  This should be an "introduction" to the user guide document, and explicitly link to it,
  66 .. where the specifics of the features are covered including examples and API's
  67
  68   When would I use this scenario, what value does it provide?  Refer to the user guide for details
  69   of configuration etc...
  70
  71 Configuring SDNVPN features
  72 ---------------------------
  73
  74 Apex installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is
  75 enabled.
  76
  77 APEX installer configuration and BGPVPN deployment
  78 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  79
  80 To install the SDNVPN feature using the APEX installer, follow the `APEX installation guide <(https://wiki.
  81 opnfv.org/display/apex/Integration+Guide)>`_ . When prompted activate the SDNVPN feature based on
  82 openstack configuration:
  83
  84 * For os-odl-bgpvpn-noha deployment:
  85
  86   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
  87
  88 * For os-odl-bgpvpn-ha deployment:
  89
  90   python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-ha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16
  91
  92 Limitations, Issues and Workarounds
  93 ===================================
  94 .. Explain scenario limitations here, this should be at a design level rather than discussing
  95 .. faults or bugs.  If the system design only provide some expected functionality then provide
  96 .. some insight at this point.
  97
  98 Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
  99 mapped onto the ODL NetVirt REST API through the BGPVPN ODL driver and the
 100 ODL Neutron Northbound module.
 101
 102 No DPDK-enabled vhost user ports are supported.
 103
 104 Integration with data center gateway will not work due to missing OVS patches for MPLSoGRE.
 105
 106 References
 107 ==========
 108
 109 For more information on the OPNFV latest stable release, please visit
 110 https://www.opnfv.org/software