Minor updates to OVSDB documents
[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 === 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 | grep -i ovsdb
31 odl-ovsdb-all                    | 1.0.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
32 OpenDaylight :: OVSDB :: all
33 odl-ovsdb-library                | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
34 OVSDB :: Library
35 odl-ovsdb-schema-openvswitch     | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
36 OVSDB :: Schema :: Open_vSwitch
37 odl-ovsdb-schema-hardwarevtep    | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
38 OVSDB :: Schema :: hardware_vtep
39 odl-ovsdb-plugin                 | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
40 OpenDaylight :: OVSDB :: Plugin
41 odl-ovsdb-northbound             | 0.6.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
42 OpenDaylight :: OVSDB :: Northbound
43 odl-ovsdb-openstack              | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
44 OpenDaylight :: OVSDB :: OpenStack Network Virtual
45 odl-ovsdb-ovssfc                 | 0.0.1-SNAPSHOT      |           | ovsdb-0.0.1-SNAPSHOT
46 OpenDaylight :: OVSDB :: OVS Service Function Chai
47 odl-openflow-nxm-extensions      | 0.0.3-SNAPSHOT      | x         | ovsdb-0.0.3-SNAPSHOT
48 OpenDaylight :: Openflow :: Nicira Extensions
49 ----
50
51 === Verifying your Installation
52 To verify that the installation was successful, use the log:display command in karaf and check that there are no errors
53 logs relating to odl-ovsdb-openstack.
54
55 ==== Troubleshooting
56 There is no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
57 log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsctl) and openstack logs will be useful but will not
58 explain everything.
59
60 === Upgrading From a Previous Release
61 Upgrading from upstream
62
63 Upgrading from release
64
65 === Uninstalling OVSDB Openstack
66 . Shutdown the karaf instance: system:shutdown
67 . Remove what is in the /data folder of the OpenDaylight Distribution.