Neutron drivers for OpenDaylight.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 5752d506bd Merge "Fix HOST_IP fetching method in local.conf.example" 1 week ago
files Fix OpenDaylight setup with oxygen. 1 year ago
odl-etc/opendaylight/datastore/initial/config devstack: option for conntrack for old netvirt 2 years ago
odl-releases Remove untested ODL releases 10 months ago
upgrade Remove the v1 drivers 9 months ago
README.rst [Trivial fix] Correct spelling error 5 months ago
devstackgaterc Fix the misspelling of "available" 1 month ago
entry_points devstack: enable flow based tunnels for sfc 5 months ago
functions Fix broken if in devstack/functions 1 year ago
jetty-legacy.patch Fix OpenDaylight setup with oxygen. 1 year ago
local.conf.example Merge "Fix HOST_IP fetching method in local.conf.example" 1 week ago
override-defaults Dont disable services that are not enabled 5 months ago Switch to lib/neutron 1 year ago devstack: show install ODL features 1 year ago Use latest Oxygen release instead of snapshot 1 month ago
settings Remove dns-integration from NETWORK_API_EXTENSIONS 8 months ago
settings.odl Remove the v1 drivers 9 months ago tox: enable bashate 1 year ago


Enabling in Devstack

  1. Download DevStack
  2. Copy the sample local.conf over:

    cp devstack/local.conf.example local.conf
  3. Optionally, to manually configure this:

    Add this repo as an external repository:

    > cat local.conf
    enable_plugin networking-odl
  4. Optionally, to enable support for OpenDaylight L3 router functionality, add the below:

    > cat local.conf


    This is only relevant when using old netvirt (ovsdb based, default).

  5. If you need to route the traffic out of the box (e.g. br-ex), set ODL_PROVIDER_MAPPINGS to map the physical provider network to device mapping, as shown below:

    > cat local.conf
    ODL_PROVIDER_MAPPINGS=${ODL_PROVIDER_MAPPINGS:-br-ex:eth2}    # for old netvirt (ovsdb based)
    ODL_PROVIDER_MAPPINGS=${ODL_PROVIDER_MAPPINGS:-physnet1:eth2} # for new netvirt (vpnservice based)
  6. Optionally, to enable support for OpenDaylight with LBaaS V2, add this:

    > cat local.conf
    enable_plugin neutron-lbaas
    enable_service q-lbaasv2
  7. run
  8. Note: In a multi-node devstack environment, for each compute node you will want to add this to the local.conf file:

    > cat local.conf
    enable_plugin networking-odl
  9. Note: In a node using a release of Open vSwitch provided from another source than your Linux distribution you have to enable in your local.conf skipping of OVS installation step by setting SKIP_OVS_INSTALL=True. For example when stacking together with networking-ovs-dpdk Neutron plug-in to avoid conflicts between openvswitch and ovs-dpdk you have to add this to the local.conf file:

    > cat local.conf
    enable_plugin networking-ovs-dpdk
    enable_plugin networking-odl
  10. Note: Optionally, to use the new netvirt implementation (netvirt-vpnservice-openstack), add the following to the local.conf file (only allinone topology is currently supported by devstack, since tunnel endpoints are not automatically configured). For tunnel configurations after loading devstack, please refer to this guide

    > cat local.conf
    ODL_BOOT_WAIT_URL=restconf/operational/network-topology:network-topology/ # Workaround since netvirt:1 no longer exists in DS!
  11. Note: To enable Quality Of Service (QoS) with OpenDaylight Backend, add the following lines in neutron.conf:

    > in /etc/neutron/neutron.conf
    service_plugins = qos, odl-router

    enable qos extension driver in ml2 conf:

    > in /etc/neutron/plugins/ml2/ml2_conf.ini
    extensions_drivers = qos, port_security

    restart neutron service neutron-api

  12. Note: legacy netvirt specific options
    • OVS conntrack support


      ODL_LEGACY_NETVIRT_CONNTRACK By default it's False for compatibility and version requirements.

      • version requirement
        ODL version

        Boron release or later. (ODL legacy netvirt support is from Beryllium. But networking-odl devstack supports Boron+)

        OVS version

        2.5 or later

      enable OVS conntrack support:

      > cat local.conf
  13. Note: To enable Vlan Aware VMs (Trunk) with OpenDaylight Backend, make the following entries in local.conf:

    > cat local.conf
  14. Enabling L2Gateway Backend for OpenDaylight
  • The package networking-l2gw must be installed as a pre-requisite.

    So include in your localrc (or local.conf) the following:

    enable_plugin networking-l2gw
    enable_service l2gw-plugin
  • Now stack up Devstack and after stacking completes, we are all set to use l2gateway-as-a-service with OpenDaylight.
  1. Note: To enable Service Function Chaining support driven by networking-sfc, the following steps have to be taken:
    • local.conf should contain the following lines:

      # enable our plugin:
      enable_plugin networking-odl
      # enable the networking-sfc plugin:
      enable_plugin networking-sfc
      # enable the odl-netvirt-sfc Karaf feature in OpenDaylight
      # enable the networking-sfc OpenDaylight driver pair
      drivers = odl_v2
      drivers = odl_v2
    • A special commit of Open vSwitch should be compiled and installed (containing compatible NSH OpenFlow support). This isn't done automatically by networking-odl or DevStack, so the user has to manually install. Please follow the instructions in:
    • Fluorine is the recommended and latest version of OpenDaylight to use, you can specify it by adding the following to local.conf:

    • To clarify, OpenDaylight doesn't have to be running/installed before stacking with networking-odl (and it shouldn't). The networking-odl DevStack plugin will download and start OpenDaylight automatically. However, it will not fetch the correct Open vSwitch version, so the instructions above and the usage of SKIP_OVS_INSTALL are important.
  2. To enable BGPVPN driver to use with OpenDaylight controller Include the following lines in your localrc (or local.conf):

    enable_plugin networking-bgpvpn

    and then stack up your devstack.

  3. To enable DHCP Service in OpenDaylight deployments with Openstack, please use:

  4. To enable ODL with OVS hardware Offload support please use:

    ODL_OVS_HOSTCONFIGS_OPTIONS="--noovs_dpdk --debug --ovs_sriov_offload"
    Note: OVS offload support minimal version requirements - Linux kernel from version 4.12

    OVS from version 2.8.0 ODL from version Nitrogen (please note that Nitrogen is no longer maintained)

  5. For development environment, if opendaylight installation is not required for then a parameter ODL_INSTALL should be set to False. By default it is set to True therefore it is backward compatible with gate and already existing scripts:

  6. To Enable L3 Flavors with ODL, service providers should be added to neutron.conf:

    service_provider = L3_ROUTER_NAT:ODL:networking_odl.l3.l3_flavor.ODLL3ServiceProvider:default

    Note: Service Plugin 'router' should be used in neutron.conf for enabling L3 flavors completely