4 This document describes how to use the Unified Secure Channel (USC)
5 feature in OpenDaylight. This document contains configuration,
6 administration, and management sections for the feature.
11 In enterprise networks, more and more controller and network management
12 systems are being deployed remotely, such as in the cloud. Additionally,
13 enterprise networks are becoming more heterogeneous - branch, IoT,
14 wireless (including cloud access control). Enterprise customers want a
15 converged network controller and management system solution. This
16 feature is intended for device and network administrators looking to use
17 unified secure channels for their systems.
19 USC Channel Architecture
20 ------------------------
24 - The USC Agent provides proxy and agent functionality on top of all
25 standard protocols supported by the device. It initiates call-home
26 with the controller, maintains live connections with with the
27 controller, acts as a demuxer/muxer for packets with the USC
28 header, and authenticates the controller.
32 - The USC Plugin is responsible for communication between the
33 controller and the USC agent . It responds to call-home with the
34 controller, maintains live connections with the devices, acts as a
35 muxer/demuxer for packets with the USC header, and provides
40 - The USC Manager handles configurations, high availability,
41 security, monitoring, and clustering support for USC.
45 - The USC UI is responsible for displaying a graphical user
46 interface representing the state of USC in the OpenDaylight DLUX
49 Installing USC Channel
50 ----------------------
52 To install USC, download OpenDaylight and use the Karaf console to
53 install the following feature:
57 Configuring USC Channel
58 -----------------------
60 This section gives details about the configuration settings for various
63 The USC configuration files for the Karaf distribution are located in
64 distribution/karaf/target/assembly/etc/usc
68 - The certificates folder contains the client key, pem, and rootca
69 files as is necessary for security.
73 - This file contains configuration related to clustering. Potential
74 configuration properties can be found on the akka website at
79 - This file contains configuration related to USC. Use this file to
80 set the location of certificates, define the source of additional
81 akka configurations, and assign default settings to the USC
84 Administering or Managing USC Channel
85 -------------------------------------
87 After installing the odl-usc-channel-ui feature from the Karaf console,
88 users can administer and manage USC channels from the the UI or APIDOCS
92 `http://${ipaddress}:8181/index.html <http://${ipaddress}:8181/index.html>`__,
93 sign in, and click on the USC side menu tab. From there, users can view
94 the state of USC channels.
97 `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__,
98 sign in, and expand the usc-channel panel. From there, users can execute
99 various API calls to test their USC deployment such as add-channel,
100 delete-channel, and view-channel.
105 Below are tutorials for USC Channel
110 The purpose of this tutorial is to view USC Channel
115 This tutorial walks users through the process of viewing the USC Channel
116 environment topology including established channels connecting the
117 controllers and devices in the USC topology.
122 For this tutorial, we assume that a device running a USC agent is
128 - Run the OpenDaylight distribution and install odl-usc-channel-ui from
132 `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__
134 - Execute add-channel with the following json data:
136 - {"input":{"channel":{"hostname":"127.0.0.1","port":1068,"remote":false}}}
139 `http://${ipaddress}:8181/index.html <http://${ipaddress}:8181/index.html>`__
141 - Click on the USC side menu tab.
143 - The UI should display a table including the added channel from step