Migrating release notes from AsciiDoc to reST

[docs.git] / manuals / getting-started-guide / src / main / asciidoc / ovsdb / ovsdb-openstack-install.adoc

diff --git a/manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-install.adoc b/manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-install.adoc
index 2bdc5beaad543dfde339d315bee2a01ec899ccef..5ac4c8c8293641e92735b138e9cd8a078ceb2422 100644 (file)
--- a/manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-install.adoc
+++ b/manuals/getting-started-guide/src/main/asciidoc/ovsdb/ovsdb-openstack-install.adoc
@@ -1,4 +1,4 @@
-== OVSDB Openstack Installation Guide
+== OVSDB OpenStack Installation Guide
 
 === Overview
 This guide is geared towards installing OpenDaylight to use the OVSDB project to provide Neutron support for OpenStack.
@@ -9,59 +9,46 @@ For information on OVS, see http://openvswitch.org/[Open vSwitch].
 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.
 A simple and concise overview of Open Virtual Switch Database (OVSDB) is available at: http://networkstatic.net/getting-started-ovsdb/
 
-=== Pre Requisites for Installing OVSDB Openstack
-* JRE 1.7+
-* A distribution of OpenDaylight
-
 === Preparing for Installation
-. Download a copy of the latest OpenDaylight release in a Pre-Build archive of your choosing.
-http://www.opendaylight.org/software/downloads[Download OpenDaylight]
-
+Follow the instructions in <<_getting_and_installing_opendaylight,Getting and Installing OpenDaylight>>.
 
-=== Installing OVSDB Openstack
-. Extract the OpenDaylight distribution somewhere.
-. Navigate to the /bin/ directory
-. Execute the karaf binary file, that should bring up the OpenDaylight console
-. Install the required features with these commands:
+=== Installing OVSDB OpenStack
+Install the required features with the following command:
+-----
 feature:install odl-ovsdb-openstack
+-----
 
-===== Sample output from the Karaf console
+==== Sample output from the Karaf console
 ----
-opendaylight-user@root>feature:list | grep -i ovsdb
-odl-ovsdb-all                    | 1.0.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
-OpenDaylight :: OVSDB :: all
-odl-ovsdb-library                | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
-OVSDB :: Library
-odl-ovsdb-schema-openvswitch     | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
-OVSDB :: Schema :: Open_vSwitch
-odl-ovsdb-schema-hardwarevtep    | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
-OVSDB :: Schema :: hardware_vtep
-odl-ovsdb-plugin                 | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
-OpenDaylight :: OVSDB :: Plugin
-odl-ovsdb-northbound             | 0.6.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT
-OpenDaylight :: OVSDB :: Northbound
-odl-ovsdb-openstack              | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT
+opendaylight-user@root>feature:list -i | grep ovsdb
+odl-ovsdb-southbound-api             | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
+OpenDaylight :: southbound :: api
+odl-ovsdb-southbound-impl            | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
+OpenDaylight :: southbound :: impl
+odl-ovsdb-southbound-impl-rest       | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
+OpenDaylight :: southbound :: impl :: REST
+odl-ovsdb-southbound-impl-ui         | 1.1.0-SNAPSHOT   | x         | odl-ovsdb-southbound-1.1.0-SNAPSHOT
+OpenDaylight :: southbound :: impl :: UI
+odl-ovsdb-openstack                  | 1.1.0-SNAPSHOT   | x         | ovsdb-1.1.0-SNAPSHOT
 OpenDaylight :: OVSDB :: OpenStack Network Virtual
-odl-ovsdb-ovssfc                 | 0.0.1-SNAPSHOT      |           | ovsdb-0.0.1-SNAPSHOT
-OpenDaylight :: OVSDB :: OVS Service Function Chai
-odl-openflow-nxm-extensions      | 0.0.3-SNAPSHOT      | x         | ovsdb-0.0.3-SNAPSHOT
-OpenDaylight :: Openflow :: Nicira Extensions
 ----
 
 === Verifying your Installation
-To verify that the installation was successful, use the log:display command in karaf and check that there are no errors
+To verify that the installation was successful, use the following command in karaf and check that there are no errors
 logs relating to odl-ovsdb-openstack.
+-----
+log:display
+-----
 
 ==== Troubleshooting
-There are no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
-log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsdctl) and openstack logs will be useful but will not
+There is no easy way to troubleshoot an installation of odl-ovsdb-openstack. Perhaps a combination of
+log:display | grep -i ovsdb in karaf, Open vSwitch commands (ovs-vsctl) and OpenStack logs will be useful but will not
 explain everything.
 
-=== Upgrading From a Previous Release
-Upgrading from upstream
-
-Upgrading from release
-
-=== Uninstalling OVSDB Openstack
-. Shutdown the karaf instance: system:shutdown
+=== Uninstalling OVSDB OpenStack
+. Shutdown the karaf instance:
++
+-----
+system:shutdown
+-----
 . Remove what is in the /data folder of the OpenDaylight Distribution.