Merge "OF-CONFIG release notes"
[docs.git] / docs / getting-started-guide / project-release-notes / aaa.rst
1 ===
2 AAA
3 ===
4
5 Major Features
6 ==============
7
8 For each top-level feature, identify the name, url, description, etc. User-facing features are used directly by end users.
9
10 odl-aaa-shiro
11 -------------
12
13 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/shiro/features-aaa-shiro/src/main/features/features.xml;hb=refs/heads/stable/carbon
14 * **Feature Description:**  ODL Shiro-based AAA implementation
15 * **Top Level:** Yes
16 * **User Facing:** Yes
17 * **Experimental:** Yes
18 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
19
20 odl-aaa-authn
21 -------------
22
23 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
24 * **Feature Description:**  Existing AAA infrastructure, now wrapped by odl-aaa-shiro
25 * **Top Level:** Yes
26 * **User Facing:** Yes
27 * **Experimental:** Yes
28 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
29
30 odl-aaa-cert
31 ------------
32
33 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
34 * **Feature Description:**  MD-SAL based encrypted certificate management
35 * **Top Level:** Yes
36 * **User Facing:** Yes
37 * **Experimental:** Yes
38 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
39
40 odl-aaa-cli
41 ------------
42
43 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
44 * **Feature Description:**  Basic karaf CLI commands for interacting with AAA
45 * **Top Level:** Yes
46 * **User Facing:** Yes
47 * **Experimental:** Yes
48 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
49
50
51 Documentation
52 =============
53
54 Please provide the URL to each document at docs.opendaylight.org. If the document is under review, provide a link to the change in Gerrit.
55
56 * **User Guide(s):**
57
58   * :ref:`aaa-user-guide`
59
60 * **Developer Guide(s):**
61
62   * :ref:`aaa-dev-guide`
63
64 Security Considerations
65 =======================
66
67 * Do you have any external interfaces other than RESTCONF?
68
69   No.
70
71 * Other security issues?
72
73   N/A.
74
75 Quality Assurance
76 =================
77
78 * `Link to Sonar Report https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/`_ (56.39% code coverage)
79 * `Link to CSIT Jobs https://jenkins.opendaylight.org/releng/view/aaa/`_
80
81 Migration
82 ---------
83
84 * No data model changes occurred, so everything should work.  You can either copy the existing idmlight.db.mv.db into the new karaf distribution folder, or just start fresh with a new one.
85
86 Compatiblity
87 ------------
88
89 * Is this release compatible with the previous release?
90
91   Yes.
92
93 * Any API changes?
94
95   No.
96
97 * Any configuraiton changes?
98
99   Some CLI commands were modified for security and ease of use purposes.  Nothing else.
100
101 Bugs Fixed
102 ----------
103
104 * `8373 <https://bugs.opendaylight.org/show_bug.cgi?id=8373>`_ Unable to start blueprint container for bundle org.opendaylight.aaa.idmlight
105 * `8062 <https://bugs.opendaylight.org/show_bug.cgi?id=8062>`_ Bad padding in encrypted data
106 * `8214 <https://bugs.opendaylight.org/show_bug.cgi?id=8214>`_ NPE in org.opendaylight.aaa.shiro.realm.MDSALDynamicAuthorizationFilter
107 * `8313 <https://bugs.opendaylight.org/show_bug.cgi?id=8313>`_ AAA dependencies cause it not to come up
108 * `8157 <https://bugs.opendaylight.org/show_bug.cgi?id=8157>`_ Deleting a user and recreating it fails using the aaa-cli-jar
109 * `7527 <https://bugs.opendaylight.org/show_bug.cgi?id=7527>`_ Karaf 4 migration: provide Karaf 4 aaa features
110
111 Known Issues
112 ------------
113
114 * List key known issues with workarounds
115
116   N/A
117
118 * `Link to Open Bugs https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=78831&product=aaa&resolution=---`_
119
120 End-of-life
121 ===========
122
123 * N/A
124
125 Standards
126 =========
127
128 * LDAP, ActiveDirectory (less tested)
129
130 Release Mechanics
131 =================
132
133 * `Link to release plan https://wiki.opendaylight.org/view/AAA:Carbon:Release_Plan`_
134 * Describe any major shifts in release schedule from the release plan
135
136   None.