manuals/user-guide/src/main/asciidoc/usc/odl-usc-channel-user.adoc

   1 == Unified Secure Channel
   2 This document describes how to use the Unified Secure Channel (USC)
   3 feature in OpenDaylight.  This document contains configuration,
   4 administration, and management sections for the feature.
   5
   6 === Overview
   7 In enterprise networks, more and more controller and network
   8 management systems are being deployed remotely, such as in the
   9 cloud. Additionally, enterprise networks are becoming more
  10 heterogeneous - branch, IoT, wireless (including cloud access
  11 control). Enterprise customers want a converged network controller
  12 and management system solution.  This feature is intended for
  13 device and network administrators looking to use unified secure
  14 channels for their systems.
  15
  16 === USC Channel Architecture
  17 * USC Agent
  18   ** 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.
  19 * USC Plugin
  20   ** 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.
  21 * USC Manager
  22   ** The USC Manager handles configurations, high availability, security, monitoring, and clustering support for USC.
  23 * USC UI
  24   ** The USC UI is responsible for displaying a graphical user interface representing the state of USC in the OpenDaylight DLUX UI.
  25
  26 === Installing USC Channel
  27 To install USC, download OpenDaylight and use the Karaf console
  28 to install the following feature:
  29
  30 odl-usc-channel-ui
  31
  32 === Configuring USC Channel
  33 This section gives details about the configuration settings for various components in USC.
  34
  35 The USC configuration files for the Karaf distribution are located in distribution/karaf/target/assembly/etc/usc
  36
  37 * certificates
  38   ** The certificates folder contains the client key, pem, and rootca files as is necessary for security.
  39 * akka.conf
  40   ** This file contains configuration related to clustering.  Potential configuration properties can be found on the akka website at http://doc.akka.io
  41 * usc.properties
  42   ** 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.
  43
  44 === Administering or Managing USC Channel
  45 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.
  46
  47 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.
  48
  49 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.
  50
  51 === Tutorials
  52 Below are tutorials for USC Channel
  53
  54 ==== Viewing USC Channel
  55 The purpose of this tutorial is to view USC Channel
  56
  57 ===== Overview
  58 This tutorial walks users through the process of viewing the USC
  59 Channel environment topology including established channels connecting
  60 the controllers and devices in the USC topology.
  61
  62 ===== Prerequisites
  63 For this tutorial, we assume that a device running a USC agent
  64 is already installed.
  65
  66 ===== Instructions
  67 * Run the OpenDaylight distribution and install odl-usc-channel-ui from the Karaf console.
  68 * Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html
  69 * Execute add-channel with the following json data:
  70 ** {"input":{"channel":{"hostname":"127.0.0.1","port":1068,"remote":false}}}
  71 * Go to http://${IPADDRESS}:8181/index.html
  72 * Click on the USC side menu tab.
  73 * The UI should display a table including the added channel from step 3.
  74