Merge "Use parallel to generate robot docs if available"
[docs.git] / docs / getting-started-guide / project-release-notes / controller.rst
1 ==========
2 Controller
3 ==========
4
5 Major Features
6 ==============
7
8 odl-mdsal-broker
9 ----------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blob;f=features/mdsal/features-mdsal/src/main/features/features.xml
12 * **Feature Description:**  Core MD-SAL implementations.
13 * **Top Level:** Yes
14 * **User Facing:** No
15 * **Experimental:** No
16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/controller/job/controller-csit-verify-3node-clustering/
17
18 Documentation
19 =============
20
21 * **User Guide(s):**
22
23   * :ref:`User Guide <controller-user-guide>`
24
25 * **Developer Guide(s):**
26
27   * :ref:`controller-dev-guide`
28
29 Security Considerations
30 =======================
31
32 * Do you have any external interfaces other than RESTCONF?
33
34   * Yes, akka uses port 2550 and by default communicates with unencrypted, unauthenticated messages. Securing akka communication isn't described here, but those concerned should look at the "Configuring SSL/TLS for Akka Remoting" section at http://doc.akka.io/docs/akka//2.4.17/scala/remoting.html.
35
36 * Other security issues?
37
38   * No
39
40 Quality Assurance
41 =================
42
43 * `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/controller/job/controller-sonar/>`_ (60%)
44 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/controller/>`_
45
46 Migration
47 ---------
48
49 * Is is possible migrate from the previous release? If so, how?
50
51   * There are no issues with migration from Boron to Carbon.
52
53 Compatibility
54 -------------
55
56 * Is this release compatible with the previous release?
57
58   * Yes
59
60 * Any API changes?
61
62   * No
63
64 * Any configuration changes?
65
66   * Preview for Distributed Datastore Tell-Based protocol. This is enabled using etc/org.opendaylight.controller.cluster.datastore.cfg's
67     use-tell-based-protocol knob and should eliminate most sources of AskTimeouts.
68
69 Bugs Fixed
70 ----------
71
72 * List of bugs fixed since the previous release
73
74   * `Bugs Fixed <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78854&product=controller&query_format=advanced&resolution=FIXED>`_
75
76 Known Issues
77 ------------
78
79 * List key known issues with workarounds
80
81   * None
82
83 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78855&product=controller&query_format=advanced>`_
84
85 End-of-life
86 ===========
87
88 * List of features/APIs which are EOLed, deprecated, and/or removed in this
89   release
90
91   * The XSQL component packaged in odl-mdsal-xsql has been deprecated and will be removed in
92     the next release.
93
94   * The following API elements are deprecated, pending future removal:
95
96     * org.opendaylight.controller.md.sal.binding.api.ClusteredDataChangeListener
97     * org.opendaylight.controller.md.sal.binding.api.DataChangeListener
98     * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareConsumer
99     * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareProvider
100     * org.opendaylight.controller.sal.binding.api.data.DataBrokerService
101     * org.opendaylight.controller.sal.binding.api.data.DataChangeListener
102     * org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction
103     * org.opendaylight.controller.sal.binding.api.data.DataProviderService
104     * org.opendaylight.controller.sal.binding.api.data.SynchronizedTransaction
105     * org.opendaylight.controller.sal.binding.api.NotificationListener
106     * org.opendaylight.controller.sal.binding.api.NotificationProviderService
107     * org.opendaylight.controller.sal.binding.api.NotificationService
108     * org.opendaylight.controller.sal.common.util.RpcErrors.java
109     * org.opendaylight.controller.sal.common.util.Rpcs.java
110     * org.opendaylight.controller.sal.core.api.model.SchemaService
111
112 Standards
113 =========
114
115 * List of standards implemented and to what extent
116
117   * None
118
119 Release Mechanics
120 =================
121
122 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Controller:Carbon:Release_Plan>`_