docs/getting-started-guide/project-release-notes/usc.rst

   1 ======================
   2 Unified Secure Channel
   3 ======================
   4
   5 Major Features
   6 ==============
   7
   8 * USC Agent provides proxy and agent functionality on top of all standard
   9   protocols supported by the device. It initiates call-home with the controller,
  10   maintains live connections with with the controller, acts as a demuxer/muxer
  11   for packets with the USC header, and authenticates the controller.
  12 * USC Plugin is responsible for communication between the controller and the USC
  13   agent . It responds to call-home with the controller, maintains live
  14   connections with the devices, acts as a muxer/demuxer for packets with the USC
  15   header, and provides support for TLS/DTLS.
  16 * USC Manager handles configurations, high availability, security, monitoring,
  17   and clustering support for USC.
  18 * USC UI is responsible for displaying a graphical user interface representing
  19   the state of USC in the OpenDaylight DLUX UI.
  20
  21 USC Channel UI
  22 --------------
  23
  24 * **Feature Name:** odl-usc-channel-ui
  25 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=usc.git;a=blob;f=usc-features/odl-usc-channel-ui/pom.xml;
  26 * **Feature Description:**  Responsible for communication between the controller
  27   and the USC agent . It responds to call-home with the controller, maintains
  28   live connections with the devices, acts as muxer/demuxer for packets with the
  29   USC header, and provides support for TLS/DTLS.
  30 * **Top Level:** Yes
  31 * **User Facing:** Yes
  32 * **Experimental:** Yes
  33 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/usc/job/usc-csit-1node-tcp-all-nitrogen/
  34
  35 Documentation
  36 =============
  37
  38 Please provide the URL to each document at docs.opendaylight.org. If the
  39 document is under review, provide a link to the change in Gerrit.
  40
  41 * **User Guide(s):**
  42
  43   * :ref:`usc-user-guide`
  44
  45 * **Developer Guide(s):**
  46
  47   * :ref:`usc-dev-guide`
  48
  49 Security Considerations
  50 =======================
  51
  52 * USC uses TLS and DTLS to secure the channels. Asymmetric authentication
  53   handshake when establishing the channels. Mutual authentication achieved with
  54   certificates configured in usc.properties for both the controller and the
  55   device.
  56
  57 Quality Assurance
  58 =================
  59
  60 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44336>`_
  61 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/usc/job/usc-csit-1node-tcp-all-nitrogen/>`_
  62 * `Link to Additional Details <https://wiki.opendaylight.org/view/USC:Integration_Test>`_
  63 * Code is covered by unit and integration tests
  64 * System Tests are performed by CSIT jobs using java test agent.
  65
  66
  67 Migration
  68 ---------
  69
  70 * Nothing beyond general OpenDaylight migration requirements.
  71
  72 Compatibility
  73 -------------
  74
  75 * Nothing beyond general OpenDaylight compatibility constraints.
  76
  77 Bugs Fixed
  78 ----------
  79
  80 * `Bug Report <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&bug_status=VERIFIED&list_id=47710&product=usc&query_format=advanced&resolution=--->`_
  81
  82 Known Issues
  83 ------------
  84
  85 * `3402 <https://bugs.opendaylight.org/show_bug.cgi?id=4558>`_ USC features has configuration issues with 3-node cluster environment.
  86
  87 End-of-life
  88 ===========
  89
  90 * Nothing deprecated, EOL.
  91
  92 Standards
  93 =========
  94
  95 * N/A
  96
  97 Release Mechanics
  98 =================
  99
 100 * `USC Release Plan <https://wiki.opendaylight.org/view/USC:Nitrogen:Release_Plan>`_
 101 * Project was on schedule