diff options
Diffstat (limited to 'docs/userguide/onos.rst')
| -rw-r--r-- | docs/userguide/onos.rst | 44 |
1 files changed, 38 insertions, 6 deletions
diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst index b39478e2d..f576d8598 100644 --- a/docs/userguide/onos.rst +++ b/docs/userguide/onos.rst @@ -5,11 +5,43 @@ ONOS User Guide =============== -Add ONOS specific user guide information here. -Needs to include OPNFV default ports and addresses and -references to upstream documentation applicable for an -OPNFV deployment. +ONOS is an SDN controller platform developed and released by the +`ONOS project <https://www.onosproject.org>`_. +The ONOS controller is installed and configured in OPNFV as the networking +component of a variety of OPNFV VNFi scenarios. -From the Jumphost VIP:8282 -karaf/karaf +ONOS runs within a JVM that is installed in OPNFV within a container and +integrated with OpenStack. The ONOS instance can be configured through the +OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost. The +Brahmaputra release of OPNFV integrates the latest +`ONOS 1.4 (EMU) <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_ +release version. +ONOS references +--------------- + +For an overview of the ONOS controller a good reference is the +`User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_. For more detailed information +about the EMU version of ONOS, documentation is available on the +`ONOS download page <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_. + +Connecting to the ONOS instance +------------------------------- + +Once you are familiar with the ONOS controller and it's configuration +you will want to connect to the ONOS instance from the Jumphost. +To do this you should open a browser on the JumpHost to the following address +and enter the username and password: + + http://{Controller-VIP}:8282/index.html> + username: karaf + password: karaf + +Other methods of interacting with and configuring the controller, like the REST API +and CLI are also available in the Brahmaputra deployment, see the +`ONOS User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_ +for more information on using those interfaces. + +It is important to be aware that when working directly on the ONOS controller +the OpenStack instance will not always be aware of the changes you are making to the +networking controller. This may result in unrecoverable inconsistencies in your deployment. |