docs/getting-started-guide/project-specific-guides/ovsdb-openstack.rst

   1 OVSDB OpenStack Installation Guide
   2 ==================================
   3
   4 Overview
   5 ^^^^^^^^
   6
   7 This guide is geared towards installing OpenDaylight to use the OVSDB project to provide Neutron support for OpenStack.
   8
   9 Open vSwitch (OVS) is generally accepted as the unofficial standard for Virtual Switching in the Open hypervisor based solutions.
  10 For information on OVS, see `Open vSwitch <http://openvswitch.org/>`_.
  11
  12 With OpenStack within the SDN context, controllers and applications interact using two channels: OpenFlow and OVSDB. OpenFlow addresses the forwarding-side of the OVS functionality. OVSDB, on the other hand, addresses the management-plane.
  13 A simple and concise overview of Open Virtual Switch Database (OVSDB) is available at: http://networkstatic.net/getting-started-ovsdb/
  14
  15 Preparing for Installation
  16 --------------------------
  17
  18 Follow the instructions in :ref:`install_odl`.
  19
  20 Installing OVSDB OpenStack
  21 --------------------------
  22
  23 Install the required features with the following command::
  24
  25    feature:install odl-ovsdb-openstack
  26
  27 Sample output from the Karaf console
  28 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  29
  30 .. code-block:: shell
  31
  32    opendaylight-user@root>feature:list -i | grep ovsdb
  33    odl-ovsdb-southbound-api             | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  34    OpenDaylight :: southbound :: api
  35    odl-ovsdb-southbound-impl            | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  36    OpenDaylight :: southbound :: impl
  37    odl-ovsdb-southbound-impl-rest       | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  38    OpenDaylight :: southbound :: impl :: REST
  39    odl-ovsdb-southbound-impl-ui         | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  40    OpenDaylight :: southbound :: impl :: UI
  41    odl-ovsdb-openstack                  | 1.1.0-SNAPSHOT   | x         | ovsdb-1.1.0-SNAPSHOT
  42    OpenDaylight :: OVSDB :: OpenStack Network Virtual
  43
  44 Verifying your Installation
  45 ---------------------------
  46
  47 To verify that the installation was successful, use the following command in karaf and check that there are no errors
  48 logs relating to odl-ovsdb-openstack::
  49
  50    log:display
  51
  52 Troubleshooting
  53 ^^^^^^^^^^^^^^^
  54
  55 There is no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
  56 log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsctl) and OpenStack logs will be useful but will not
  57 explain everything.
  58
  59 Uninstalling OVSDB OpenStack
  60 ----------------------------
  61
  62 #. Shutdown the karaf instance::
  63
  64       system:shutdown
  65
  66 #. Remove what is in the ``/data`` folder of the OpenDaylight distribution.