fuel-plugin-opendaylight/README.md

OpenDaylight Plugin for Fuel

OpenDaylight plugin

Overview

This plugin will install OpenDaylight controller and set it as manager for OVS using ovsdb plugin.

• OpenDaylight controller is a SDN controller.
• OVSDB plugin implement the Open vSwitch Database management protocol.

Requirements

Requirement	Version/Comment
Mirantis OpenStack compatibility	9.0

Limitations

• HA for ODL controller is not implemented yet.

Installation Guide

OpenDaylight plugin installation

1. Clone the fuel-plugin-opendaylight repo from github:

    git clone https://github.com/openstack/fuel-plugin-opendaylight
   

2. Install the Fuel Plugin Builder:

    pip install fuel-plugin-builder
   

3. Build OpenDaylight Fuel plugin:

    fpb --build fuel-plugin-opendaylight/
   

4. The opendaylight-[x.x.x].rpm plugin package will be created in the plugin folder.

5. Move this file to the Fuel Master node with secure copy (scp):

    scp opendaylight-[x.x.x].rpm root@<the_Fuel_Master_node_IP address>:/tmp
   

6. While logged in Fuel Master install the OpenDaylight plugin:

    fuel plugins --install opendaylight-[x.x.x].rpm
   

7. Check if the plugin was installed successfully:

    fuel plugins
   
    id | name         | version | package_version
    ---|--------------|---------|----------------
    1  | opendaylight | 0.5.2   | 2.0.0
   

8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.

User Guide

OpenDaylight plugin configuration

1. Create a new environment with the Fuel UI wizard.
2. Click on the Settings tab of the Fuel web UI.
3. Select "OpenDaylight plugin" section in "Other" tab.
4. Tick the checkbox and click "Save Settings" button.
5. Assign role OPENDAYLIGHT to one of the node.

Build options

It is possible to modify process of building plugin by setting environment variables. Look into pre_build_hook file for more details. For example include 2 versions of opendaylight controller in plugin:

    ODL_VERSIONS="5.1.0.1 5.0.0.1" fpb --build fuel-plugin-opendaylight/

Testing

OpenDaylight files are stored on node with 'OpenDaylight' role assigned inside /opt/opendaylight directory.

To log in to OpenDayligt shell run /opt/opendaylight/bin/client -u karaf

Known issues

• VM live migration not supported by ODL ovsdb
• ODL ignore MTU size from Neutron and create tap devices for VMs with MTU 1500. Things like Jumbo frames will not work on VMs side.

Development

Plugin is developed as a part of FUEL@OPNFV project.

If you have questions/suggestions you can find us on #opnfv-fuel freenode IRC channel.

If you prefer email The OpenStack Development Mailing List openstack-dev@lists.openstack.org or OPNFV Technical Discussion opnfv-tech-discuss@lists.opnfv.org can be used. Subject should be prefixed by [fuel][plugins][odl].

Reporting Bugs

Bugs should be filled on the Launchpad fuel-plugin-opendaylight project.

Contributing

If you would like to contribute to the development of this Fuel plugin you must follow the OpenStack development workflow.

Patch reviews take place on the OpenStack gerrit system.

Contributors

• https://github.com/openstack/fuel-plugin-opendaylight/graphs/contributors