1 files changed, 33 insertions, 0 deletions
diff --git a/framework/src/openstack/neutron/plugin/networking-onos/networking-onos/networking_onos/plugins/ml2/README b/framework/src/openstack/neutron/plugin/networking-onos/networking-onos/networking_onos/plugins/ml2/README
new file mode 100644
index 00000000..c3c722c8
--- /dev/null
+++ b/framework/src/openstack/neutron/plugin/networking-onos/networking-onos/networking_onos/plugins/ml2/README
@@ -0,0 +1,33 @@
+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 download the
+   required package version from "https://pypi.python.org/pypi/networking-onos/"
+   and install using pip.
+
+2. Configure ONOS as the required ML2 "mechanism_drivers" in
+   neutron/plugins/ml2/ml2_conf.ini:
+
+    mechanism_drivers=onos_ml2
+
+3. Configure ONOS credentials in networking_onos/etc/conf_onos.ini.
+
+4. Start neutron server mentioning networking_onos/etc/conf_onos.ini as
+   one of the config-file.