manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-install.adoc

   1 == OVSDB OpenStack Installation Guide
   2
   3 === Overview
   4 This guide is geared towards installing OpenDaylight to use the OVSDB project to provide Neutron support for OpenStack.
   5
   6 Open vSwitch (OVS) is generally accepted as the unofficial standard for Virtual Switching in the Open hypervisor based solutions.
   7 For information on OVS, see http://openvswitch.org/[Open vSwitch].
   8
   9 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.
  10 A simple and concise overview of Open Virtual Switch Database (OVSDB) is available at: http://networkstatic.net/getting-started-ovsdb/
  11
  12 === Pre Requisites for Installing OVSDB OpenStack
  13 * JRE 1.7+
  14 * A distribution of OpenDaylight
  15
  16 === Preparing for Installation
  17 . Download a copy of the latest OpenDaylight release in a Pre-Build archive of your choosing.
  18 http://www.opendaylight.org/software/downloads[Download OpenDaylight]
  19
  20
  21 === Installing OVSDB OpenStack
  22 . Extract the OpenDaylight distribution somewhere.
  23 . Navigate to the /bin/ directory
  24 . Execute the karaf binary file, that should bring up the OpenDaylight console
  25 . Install the required features with these commands:
  26 feature:install odl-ovsdb-openstack
  27
  28 ===== Sample output from the Karaf console
  29 ----
  30 opendaylight-user@root>feature:list -i | grep ovsdb
  31 odl-ovsdb-southbound-api             | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  32 OpenDaylight :: southbound :: api
  33 odl-ovsdb-southbound-impl            | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  34 OpenDaylight :: southbound :: impl
  35 odl-ovsdb-southbound-impl-rest       | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  36 OpenDaylight :: southbound :: impl :: REST
  37 odl-ovsdb-southbound-impl-ui         | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
  38 OpenDaylight :: southbound :: impl :: UI
  39 odl-ovsdb-openstack                  | 1.1.0-SNAPSHOT   | x         | ovsdb-1.1.0-SNAPSHOT
  40 OpenDaylight :: OVSDB :: OpenStack Network Virtual
  41 ----
  42
  43 === Verifying your Installation
  44 To verify that the installation was successful, use the log:display command in karaf and check that there are no errors
  45 logs relating to odl-ovsdb-openstack.
  46
  47 ==== Troubleshooting
  48 There is no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
  49 log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsctl) and OpenStack logs will be useful but will not
  50 explain everything.
  51
  52 === Uninstalling OVSDB OpenStack
  53 . Shutdown the karaf instance: system:shutdown
  54 . Remove what is in the /data folder of the OpenDaylight Distribution.