Merge "uploading ascii documents for ODL-SDNi Boron release."
authorColin Dixon <colin@colindixon.com>
Thu, 18 Aug 2016 00:58:44 +0000 (00:58 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Thu, 18 Aug 2016 00:58:44 +0000 (00:58 +0000)
manuals/developer-guide/src/main/asciidoc/sdninterfaceapp/odl-sdninterfaceapp-all-dev.adoc
manuals/user-guide/src/main/asciidoc/sdninterfaceapp/odl-sdninterfaceapp-all-user.adoc

index b750b53427cc98bc600e1a83f0e28d6ad97bb011..1e3475c5097686bcd15de469d017630b712d95b9 100755 (executable)
@@ -8,6 +8,7 @@ This project aims at enabling inter-SDN controller communication by developing S
 * SDNi Aggregator: Northbound SDNi plugin acts as an aggregator for collecting network information such as topology, stats, host etc. This plugin can be evolving as per needs of network data requested to be shared across federated SDN controllers.
 * SDNi REST API: REST API view autogenerated and accessible through RESTCONF to fetch the aggregated information from the northbound plugin – SDNi aggregator.The RESTCONF protocol operates on a conceptual datastore defined with the YANG data modeling language.
 * SDNi Wrapper: SDNi BGP Wrapper will be responsible for the sharing and collecting information to/from federated controllers.
+* SDNi UI:This component displays the SDN controllers connected to each other.
 
 === SDNi Aggregator
 
@@ -22,10 +23,18 @@ http://${IPADDRESS}:8181/restconf/operations/opendaylight-sdni-topology-msg:getT
 
 *Topology Data:* Controller IP Address, Links, Nodes, Link Bandwidths, MAC Address of switches, Latency, Host IP address.
 
+http://${IPADDRESS}:8181/restconf/operations/opendaylight-sdni-topology-msg:getAllPeerTopology
+
+*Peer Topology Data:* Controller IP Address, Links, Nodes, Link Bandwidths, MAC Address of switches, Latency, Host IP address.
+
 http://${IPADDRESS}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-node-connectors-statistics
 
 *QOS Data:* Node, Port, Transmit Packets, Receive Packets, Collision Count, Receive Frame Error, Receive Over Run Error, Receive Crc Error
 
+http://${IPADDRESS}:8181/restconf/operations/opendaylight-sdni-qos-msg:get-all-peer-node-connectors-statistics
+
+*Peer QOS Data:* Node, Port, Transmit Packets, Receive Packets, Collision Count, Receive Frame Error, Receive Over Run Error, Receive Crc Error
+
 === SDNi Wrapper
 .SDNiWrapper
 image::SDNiWrapper.png[]
@@ -33,6 +42,11 @@ image::SDNiWrapper.png[]
 * SDNiWrapper is an extension of ODL-BGPCEP where SDNi topology data is exchange along with the Update NLRI message. Refer http://tools.ietf.org/html/draft-ietf-idr-ls-distribution-04 for more information on NLRI.
 * SDNiWrapper gets the controller’s network capabilities through SDNi REST API and serialize it in Update NLRI message. This NLRI message will get exchange between the clustered controllers through BGP-UPDATE message. Similarly peer controller’s UPDATE message is received and unpacked then format to SDNi Network capability data, which will be stored for further purpose.
 
+=== SDNi UI
+This component displays the SDN controllers connected to each other.
+
+http://localhost:8181/index.html#/sdniUI/sdnController
+
 === API Reference Documentation
 Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand the opendaylight-sdni panel.  From there, users can execute various API calls to test their sdni deployment.
 
index 3d0823677110f6291c5e623f574ad228cf5612c4..88fe984a0752eddbc1b5c6a60b97f509efac69f8 100755 (executable)
@@ -1,7 +1,7 @@
 == ODL-SDNi User Guide
 
 === Introduction
-This user guide will help to setup the ODL-SDNi application for lithium release and contains the examples configuration using ODL-BGPCEP.
+This user guide will help to setup the ODL-SDNi application for boron release and contains the examples configuration using ODL-BGPCEP.
 
 === Components
 SDNiAggregator(controller), SDNi REST API(controller) and SDNiWrapper(bgpcep) are the three components in ODL-SDNi App  
@@ -9,6 +9,7 @@ SDNiAggregator(controller), SDNi REST API(controller) and SDNiWrapper(bgpcep) ar
 * SDNiAggregator: Connects with switch, topology, hosttracker managers of controller to get the topology and other related data.
 * SDNi REST API: It is a part of controller northbound, which gives the required information by quering SDNiAggregator through RESTCONF.
 * SDNiWrapper: This component uses the SDNi REST API and gathers the information required to be shared among controllers.
+* SDNiUI:This component displays all the SDN controllers which are connected to each other.
 
 === Troubleshooting
 To work with multiple controllers, change some of the configuration in config.ini file. For example change the listening port of one controller to 6653 and other controller to 6663 in /root/controller/opendaylight/distribution/opendaylight/target/distribution.opendaylight-osgipackage/opendaylight/configuration/config.ini (i.e of.listenPort=6653).