Update usc documentation.

Change-Id: I2cbfe4c793679e09f7b2a0b886c2a226f1ff89cc
Signed-off-by: A H <an.ho@huawei.com>

diff --git a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
index 5d7e15ec357681bd462fdb1f50148dbed5d2fcf1..ee1f4114619e39315818a954f175e7c6ee3cff08 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc
@@ -84,6 +84,8 @@ include::ttp/ttp-model-dev.adoc[]
 
 include::ttp/ttp-cli-tools-dev.adoc[]
 
+include::usc/odl-usc-channel-dev.adoc[]
+
 include::didm/didm-dev.adoc[]
 
 include::vtn/vtn-dev.adoc[]

diff --git a/manuals/developer-guide/src/main/asciidoc/usc/odl-usc-channel-dev.adoc b/manuals/developer-guide/src/main/asciidoc/usc/odl-usc-channel-dev.adoc
index 5944b5d3123ef2dbb525a5b444488ac2a431fa5c..fa8614d44cfa6b15e5864943f55628e1c95ce434 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/usc/odl-usc-channel-dev.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/usc/odl-usc-channel-dev.adoc
@@ -7,18 +7,26 @@ monitors, maintains, and provides channel related services.  The plugin
 handles the lifecycle of channels.
 
 === USC Channel Architecture
-TBD: Architecture Diagram
+* USC Agent
+  ** The USC Agent provides proxy and agent functionality on top of all standard protocols supported by the device.  It initiates call-home with the controller, maintains live connections with with the controller, acts as a demuxer/muxer for packets with the USC header, and authenticates the controller.
+* USC Plugin
+  ** The USC Plugin is responsible for communication between the controller and the USC agent .  It responds to call-home with the controller, maintains live connections with the devices, acts as a muxer/demuxer for packets with the USC header, and provides support for TLS/DTLS.
+* USC Manager
+  ** The USC Manager handles configurations, high availability, security, monitoring, and clustering support for USC.
+* USC UI
+  ** The USC UI is responsible for displaying a graphical user interface representing the state of USC in the OpenDaylight DLUX UI.
 
 === USC Channel APIs and Interfaces
 This section describes the APIs for interacting with the unified secure
 channels.
 
 ==== USC Channel Topology API
-The USC project maintains a topology that is YANG-based in MD-SAL.
-These models are available via RESTCONF.
+The USC project maintains a topology that is YANG-based in MD-SAL.  These models are available via RESTCONF.
 
-TBD: List Topology API
+* Name: view-channel
+* URL: http://${IPADDRESS}:8181/restconf/operations/usc-channel:view-channel
+* Description: Views the current state of the USC environment.
 
 === API Reference Documentation
-TBD: Provide links to JavaDoc, REST API documentation, etc.
+Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand the usc-channel panel.  From there, users can execute various API calls to test their USC deployment.
 

diff --git a/manuals/user-guide/src/main/asciidoc/usc/odl-usc-channel-user.adoc b/manuals/user-guide/src/main/asciidoc/usc/odl-usc-channel-user.adoc
index 2768676cbaf564caff0d952f5eb7b1f460c52207..1e7fedb464f22e94c01c9f6a1ed42f2b4554f92f 100644 (file)
--- a/manuals/user-guide/src/main/asciidoc/usc/odl-usc-channel-user.adoc
+++ b/manuals/user-guide/src/main/asciidoc/usc/odl-usc-channel-user.adoc
@@ -14,7 +14,14 @@ device and network administrators looking to use unified secure
 channels for their systems.
 
 === USC Channel Architecture
-TBD: Architecture Diagram
+* USC Agent
+  ** The USC Agent provides proxy and agent functionality on top of all standard protocols supported by the device.  It initiates call-home with the controller, maintains live connections with with the controller, acts as a demuxer/muxer for packets with the USC header, and authenticates the controller.
+* USC Plugin
+  ** The USC Plugin is responsible for communication between the controller and the USC agent .  It responds to call-home with the controller, maintains live connections with the devices, acts as a muxer/demuxer for packets with the USC header, and provides support for TLS/DTLS.
+* USC Manager
+  ** The USC Manager handles configurations, high availability, security, monitoring, and clustering support for USC.
+* USC UI
+  ** The USC UI is responsible for displaying a graphical user interface representing the state of USC in the OpenDaylight DLUX UI.
 
 === Installing USC Channel
 To install USC, download OpenDaylight and use the Karaf console
@@ -23,10 +30,23 @@ to install the following feature:
 odl-usc-channel-ui
 
 === Configuring USC Channel
-TBD: Describe configuration of plugin and agent.
+This section gives details about the configuration settings for various components in USC.
+
+The USC configuration files for the Karaf distribution are located in distribution/karaf/target/assembly/etc/usc
+
+* certificates
+  ** The certificates folder contains the client key, pem, and rootca files as is necessary for security.
+* akka.conf
+  ** This file contains configuration related to clustering.  Potential configuration properties can be found on the akka website at http://doc.akka.io
+* usc.properties
+  ** This file contains configuration related to USC.  Use this file to set the location of certificates, define the source of additional akka configurations, and assign default settings to the USC behavior.
 
 === Administering or Managing USC Channel
-TBD: Describe viewing USC topology steps.
+After installing the odl-usc-channel-ui feature from the Karaf console, users can administer and manage USC channels from the the UI or APIDOCS explorer.
+
+Go to http://${IPADDRESS}:8181/index.html, sign in, and click on the USC side menu tab.  From there, users can view the state of USC channels.
+
+Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand the usc-channel panel.  From there, users can execute various API calls to test their USC deployment such as add-channel, delete-channel, and view-channel.
 
 === Tutorials
 Below are tutorials for USC Channel
@@ -43,9 +63,12 @@ the controllers and devices in the USC topology.
 For this tutorial, we assume that a device running a USC agent
 is already installed.
 
-===== Target Environment
-TBD: Topology Diagram
-
 ===== Instructions
-TBD: Describe Steps
+* Run the OpenDaylight distribution and install odl-usc-channel-ui from the Karaf console.
+* Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html 
+* Execute add-channel with the following json data:
+** {"input":{"channel":{"hostname":"127.0.0.1","port":1068,"remote":false}}}
+* Go to http://${IPADDRESS}:8181/index.html
+* Click on the USC side menu tab.
+* The UI should display a table including the added channel from step 3.