Merge "Remove "handbook" terminology"
[docs.git] / docs / release-notes / projects / 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
19 USC Channel UI
20 --------------
21
22 * **Feature Name:** odl-usc-channel-ui
23 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=usc.git;a=blob;f=usc-features/odl-usc-channel-ui/pom.xml;
24 * **Feature Description:**  Responsible for communication between the controller
25   and the USC agent . It responds to call-home with the controller, maintains
26   live connections with the devices, acts as muxer/demuxer for packets with the
27   USC header, and provides support for TLS/DTLS.
28 * **Top Level:** Yes
29 * **User Facing:** Yes
30 * **Experimental:** Yes
31 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/usc
32
33 Documentation
34 =============
35
36 Please provide the URL to each document at docs.opendaylight.org. If the
37 document is under review, provide a link to the change in Gerrit.
38
39 * **User Guide(s):**
40
41   * :ref:`usc-user-guide`
42
43 * **Developer Guide(s):**
44
45   * :ref:`usc-dev-guide`
46
47 Security Considerations
48 =======================
49
50 * USC uses TLS and DTLS to secure the channels. Asymmetric authentication
51   handshake when establishing the channels. Mutual authentication achieved with
52   certificates configured in usc.properties for both the controller and the
53   device.
54
55 Quality Assurance
56 =================
57
58 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44336>`_
59 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/usc>`_
60 * `Link to Additional Details <https://wiki.opendaylight.org/view/USC:Integration_Test>`_
61 * Code is covered by unit and integration tests
62 * System Tests are performed by CSIT jobs using java test agent.
63
64
65 Migration
66 ---------
67
68 * Nothing beyond general OpenDaylight migration requirements.
69
70 Compatibility
71 -------------
72
73 * Nothing beyond general OpenDaylight compatibility constraints.
74
75 Bugs Fixed
76 ----------
77
78 * `USC Bugs List <https://jira.opendaylight.org/projects/USC>`_
79
80 Known Issues
81 ------------
82
83 * `USC-12 <https://jira.opendaylight.org/browse/USC-12>`_ USC features has configuration issues with 3-node cluster environment.
84
85 End-of-life
86 ===========
87
88 * Nothing deprecated, EOL.
89
90 Standards
91 =========
92
93 * N/A
94
95 Release Mechanics
96 =================
97
98 * `USC Release Plan <https://wiki.opendaylight.org/view/USC:Release_Plan>`_
99 * Project was on schedule