Migrating release notes from AsciiDoc to reST
[docs.git] / 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 === Preparing for Installation
13 Follow the instructions in <<_getting_and_installing_opendaylight,Getting and Installing OpenDaylight>>.
14
15 === Installing OVSDB OpenStack
16 Install the required features with the following command:
17 -----
18 feature:install odl-ovsdb-openstack
19 -----
20
21 ==== Sample output from the Karaf console
22 ----
23 opendaylight-user@root>feature:list -i | grep ovsdb
24 odl-ovsdb-southbound-api             | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
25 OpenDaylight :: southbound :: api
26 odl-ovsdb-southbound-impl            | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
27 OpenDaylight :: southbound :: impl
28 odl-ovsdb-southbound-impl-rest       | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
29 OpenDaylight :: southbound :: impl :: REST
30 odl-ovsdb-southbound-impl-ui         | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
31 OpenDaylight :: southbound :: impl :: UI
32 odl-ovsdb-openstack                  | 1.1.0-SNAPSHOT   | x         | ovsdb-1.1.0-SNAPSHOT
33 OpenDaylight :: OVSDB :: OpenStack Network Virtual
34 ----
35
36 === Verifying your Installation
37 To verify that the installation was successful, use the following command in karaf and check that there are no errors
38 logs relating to odl-ovsdb-openstack.
39 -----
40 log:display
41 -----
42
43 ==== Troubleshooting
44 There is no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
45 log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsctl) and OpenStack logs will be useful but will not
46 explain everything.
47
48 === Uninstalling OVSDB OpenStack
49 . Shutdown the karaf instance:
50 +
51 -----
52 system:shutdown
53 -----
54 . Remove what is in the /data folder of the OpenDaylight Distribution.