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

   1 .. _usc-user-guide:
   2
   3 Unified Secure Channel
   4 ======================
   5
   6 This document describes how to use the Unified Secure Channel (USC)
   7 feature in OpenDaylight. This document contains configuration,
   8 administration, and management sections for the feature.
   9
  10 Overview
  11 --------
  12
  13 In enterprise networks, more and more controller and network management
  14 systems are being deployed remotely, such as in the cloud. Additionally,
  15 enterprise networks are becoming more heterogeneous - branch, IoT,
  16 wireless (including cloud access control). Enterprise customers want a
  17 converged network controller and management system solution. This
  18 feature is intended for device and network administrators looking to use
  19 unified secure channels for their systems.
  20
  21 USC Channel Architecture
  22 ------------------------
  23
  24 -  USC Agent
  25
  26    -  The USC Agent provides proxy and agent functionality on top of all
  27       standard protocols supported by the device. It initiates call-home
  28       with the controller, maintains live connections with with the
  29       controller, acts as a demuxer/muxer for packets with the USC
  30       header, and authenticates the controller.
  31
  32 -  USC Plugin
  33
  34    -  The USC Plugin is responsible for communication between the
  35       controller and the USC agent . It responds to call-home with the
  36       controller, maintains live connections with the devices, acts as a
  37       muxer/demuxer for packets with the USC header, and provides
  38       support for TLS/DTLS.
  39
  40 -  USC Manager
  41
  42    -  The USC Manager handles configurations, high availability,
  43       security, monitoring, and clustering support for USC.
  44
  45 -  USC UI
  46
  47    -  The USC UI is responsible for displaying a graphical user
  48       interface representing the state of USC in the OpenDaylight DLUX
  49       UI.
  50
  51 Installing USC Channel
  52 ----------------------
  53
  54 To install USC, download OpenDaylight and use the Karaf console to
  55 install the following feature:
  56
  57 odl-usc-channel-ui
  58
  59 Configuring USC Channel
  60 -----------------------
  61
  62 This section gives details about the configuration settings for various
  63 components in USC.
  64
  65 The USC configuration files for the Karaf distribution are located in
  66 distribution/karaf/target/assembly/etc/usc
  67
  68 -  certificates
  69
  70    -  The certificates folder contains the client key, pem, and rootca
  71       files as is necessary for security.
  72
  73 -  akka.conf
  74
  75    -  This file contains configuration related to clustering. Potential
  76       configuration properties can be found on the akka website at
  77       http://doc.akka.io
  78
  79 -  usc.properties
  80
  81    -  This file contains configuration related to USC. Use this file to
  82       set the location of certificates, define the source of additional
  83       akka configurations, and assign default settings to the USC
  84       behavior.
  85
  86 Administering or Managing USC Channel
  87 -------------------------------------
  88
  89 After installing the odl-usc-channel-ui feature from the Karaf console,
  90 users can administer and manage USC channels from the the UI or APIDOCS
  91 explorer.
  92
  93 Go to
  94 `http://${ipaddress}:8181/index.html <http://${ipaddress}:8181/index.html>`__,
  95 sign in, and click on the USC side menu tab. From there, users can view
  96 the state of USC channels.
  97
  98 Go to
  99 `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__,
 100 sign in, and expand the usc-channel panel. From there, users can execute
 101 various API calls to test their USC deployment such as add-channel,
 102 delete-channel, and view-channel.
 103
 104 Tutorials
 105 ---------
 106
 107 Below are tutorials for USC Channel
 108
 109 Viewing USC Channel
 110 ~~~~~~~~~~~~~~~~~~~
 111
 112 The purpose of this tutorial is to view USC Channel
 113
 114 Overview
 115 ^^^^^^^^
 116
 117 This tutorial walks users through the process of viewing the USC Channel
 118 environment topology including established channels connecting the
 119 controllers and devices in the USC topology.
 120
 121 Prerequisites
 122 ^^^^^^^^^^^^^
 123
 124 For this tutorial, we assume that a device running a USC agent is
 125 already installed.
 126
 127 Instructions
 128 ^^^^^^^^^^^^
 129
 130 -  Run the OpenDaylight distribution and install odl-usc-channel-ui from
 131    the Karaf console.
 132
 133 -  Go to
 134    `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__
 135
 136 -  Execute add-channel with the following json data:
 137
 138    -  {"input":{"channel":{"hostname":"127.0.0.1","port":1068,"remote":false}}}
 139
 140 -  Go to
 141    `http://${ipaddress}:8181/index.html <http://${ipaddress}:8181/index.html>`__
 142
 143 -  Click on the USC side menu tab.
 144
 145 -  The UI should display a table including the added channel from step
 146    3.
 147