summaryrefslogtreecommitdiffstats
path: root/docs/userguide/opendaylight.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-05 12:48:04 +0100
committerChristopher Price <christopher.price@ericsson.com>2016-02-07 13:53:46 +0000
commit2e05184b9b7101e6d2e4ca68b4490dce985baf83 (patch)
tree871fbccf7ad2395e89c990ecbde455c38c6d27f7 /docs/userguide/opendaylight.rst
parentf436981eedcaaacf8be760c95404c6ba5a9fa4de (diff)
Adding general component descriptions and information.
Change-Id: Ie9824ac9c706f730c929a5ca0ed34ee85314719e Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> (cherry picked from commit 58a2bb9407285dbf2bac8e32bd55582379c49a6a)
Diffstat (limited to 'docs/userguide/opendaylight.rst')
-rw-r--r--docs/userguide/opendaylight.rst52
1 files changed, 46 insertions, 6 deletions
diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst
index dc0430863..7171f0c3a 100644
--- a/docs/userguide/opendaylight.rst
+++ b/docs/userguide/opendaylight.rst
@@ -5,11 +5,51 @@
OpenDaylight User Guide
=======================
-Add opendaylight specific user guide information here.
-Needs to include OPNFV default ports and addresses and
-references to upstream documentation applicable for an
-OPNFV deployment.
+OpenDaylight is an SDN controller platform developed and released by the
+`OpenDaylight project <https://www.opendaylight.org/>`_.
+The OpenDaylight controller is installed and configured in OPNFV as the networking
+component of a variety of OPNFV VNFi scenarios using the neutron ODL device driver
+as an integration point toward OpenStack.
-From the Jumphost VIP:8181
-admin/admin
+OpenDaylight runs within a JVM that is installed in OPNFV within a container and
+integrated with OpenStack. The OpenDaylight instance can be configured through the
+OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost. The
+Brahmaputra release of OPNFV integrates the latest
+`Lithium stable release <https://www.opendaylight.org/downloads/>`_ or when deploying
+an SFC or SDNVPN scenario will integrate a Beryllium release version.
+OpenDaylight references
+-----------------------
+
+For an overview of the OpenDaylight controller a good reference is the
+`Getting Started Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qt/6342/128122/bk_getting_started_guide_20150629.pdf>`_. For more detailed information
+about using the platform the `OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_
+provides a good feature by feature reference.
+
+It is important when working on your Brahmaputra deployment to be aware of the
+configured state of the OpenDaylight controller in the scenario you have deployed,
+installing an SFC scenario will for instance configure the OpenDaylight controller
+with the required SFC Karaf features in the OpenDaylight controller. Make sure you
+read the installation and configuration guide carefully to understand the state
+of the deployed system.
+
+Connecting to the OpenDaylight instance
+---------------------------------------
+
+Once you are familiar with the OpenDaylight controller and it's configuration
+you will want to connect to the OpenDaylight 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}:8181/index.html>
+ username: admin
+ password: admin
+
+Other methods of interacting with and configuring the controller, like the REST API
+and CLI are also available in the Brahmaputra deployment, see the
+`OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_
+for more information on using those interfaces.
+
+It is important to be aware that when working directly on the OpenDaylight 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.