docs/user-guide/unified-secure-channel.rst

   1 Unified Secure Channel
   2 ======================
   3
   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.
   7
   8 Overview
   9 --------
  10
  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.
  18
  19 USC Channel Architecture
  20 ------------------------
  21
  22 -  USC Agent
  23
  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.
  29
  30 -  USC Plugin
  31
  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
  36       support for TLS/DTLS.
  37
  38 -  USC Manager
  39
  40    -  The USC Manager handles configurations, high availability,
  41       security, monitoring, and clustering support for USC.
  42
  43 -  USC UI
  44
  45    -  The USC UI is responsible for displaying a graphical user
  46       interface representing the state of USC in the OpenDaylight DLUX
  47       UI.
  48
  49 Installing USC Channel
  50 ----------------------
  51
  52 To install USC, download OpenDaylight and use the Karaf console to
  53 install the following feature:
  54
  55 odl-usc-channel-ui
  56
  57 Configuring USC Channel
  58 -----------------------
  59
  60 This section gives details about the configuration settings for various
  61 components in USC.
  62
  63 The USC configuration files for the Karaf distribution are located in
  64 distribution/karaf/target/assembly/etc/usc
  65
  66 -  certificates
  67
  68    -  The certificates folder contains the client key, pem, and rootca
  69       files as is necessary for security.
  70
  71 -  akka.conf
  72
  73    -  This file contains configuration related to clustering. Potential
  74       configuration properties can be found on the akka website at
  75       http://doc.akka.io
  76
  77 -  usc.properties
  78
  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
  82       behavior.
  83
  84 Administering or Managing USC Channel
  85 -------------------------------------
  86
  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
  89 explorer.
  90
  91 Go to
  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.
  95
  96 Go to
  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.
 101
 102 Tutorials
 103 ---------
 104
 105 Below are tutorials for USC Channel
 106
 107 Viewing USC Channel
 108 ~~~~~~~~~~~~~~~~~~~
 109
 110 The purpose of this tutorial is to view USC Channel
 111
 112 Overview
 113 ^^^^^^^^
 114
 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.
 118
 119 Prerequisites
 120 ^^^^^^^^^^^^^
 121
 122 For this tutorial, we assume that a device running a USC agent is
 123 already installed.
 124
 125 Instructions
 126 ^^^^^^^^^^^^
 127
 128 -  Run the OpenDaylight distribution and install odl-usc-channel-ui from
 129    the Karaf console.
 130
 131 -  Go to
 132    `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__
 133
 134 -  Execute add-channel with the following json data:
 135
 136    -  {"input":{"channel":{"hostname":"127.0.0.1","port":1068,"remote":false}}}
 137
 138 -  Go to
 139    `http://${ipaddress}:8181/index.html <http://${ipaddress}:8181/index.html>`__
 140
 141 -  Click on the USC side menu tab.
 142
 143 -  The UI should display a table including the added channel from step
 144    3.
 145