1 files changed, 29 insertions, 0 deletions
diff --git a/framework/src/openstack/neutron/plugin/networking-onos/README.onos b/framework/src/openstack/neutron/plugin/networking-onos/README.onos
new file mode 100644
index 00000000..667fa36c
--- /dev/null
+++ b/framework/src/openstack/neutron/plugin/networking-onos/README.onos
@@ -0,0 +1,29 @@
+Open Networking Operating System (ONOS) ML2 MechanismDriver
+==========================================================
+ONOS is a carrier grade SDN open operating system designed for
+High Availability, scale-out and better performance.
+
+    http://www.onosproject.org/
+
+Mode of Working:
+================
+The networking-onos project provides a thin layer which makes the
+communication between ONOS and openstack neutron possible via ReST
+call. The driver code can be downloaded from:
+
+    https://git.openstack.org/cgit/openstack/networking-onos
+
+Using ONOS ML2 MechanismDriver
+==============================
+To use ONOS ML2 MechanismDriver one should
+1. Make sure networking-onos code is downloaded and installed. If doing
+   mannually then download the code, go inside networking_onos folder
+   and finally run "sudo python setup.py install" otherwise install
+   using pip.
+
+2. Configure ONOS as the required ML2 "mechanism_drivers" in
+   neutron/plugins/ml2/ml2_conf.ini:
+
+    mechanism_drivers=onos
+
+3. Configure "[ml2_onos]" in networking_onos/etc/ml2_onos_conf.ini
+\ No newline at end of file