Merge "Updated El-Alto Release Notes"
[portal.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017-2019 AT&T Intellectual Property.  All rights reserved
4
5
6 Portal Platform Release Notes
7 =============================
8 Version: 2.6.0
9 --------------
10 :Release Date: 2019-10-03
11
12 .. toctree::
13     :maxdepth: 1
14
15 Maintenance release with bug fixes and security enhancements.
16
17 **No New Features**
18
19 **Bug Fixes**
20         * Portal Setup - MariaDB issue.
21         * Issue editing application url.
22         * PORTAL-* charts now use nodePortPrefix variable.
23         * Fixed Sonar reported critical issues.
24
25 **Known Issues**
26         * AAI UI’s new role "ui_view" is not registered in AAF, Portal cannot fetch it. So, the work around is
27
28            1. upload new role from Bulk Upload in Portal Roles page (create a csv file which has one line like:   ui_view,10 )
29            2. Sync Roles on same page
30            3. Assign this ui_view role to demo account in User page
31            4. Then demo user can access AAI UI app from Portal
32
33 **Security Notes**
34
35 *Fixed Security Issues*
36
37         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
38         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
39
40 *Known Security Issues*
41
42 *Known Vulnerabilities in Used Modules*
43         * Addressed security issues reported by NexusIQ Critical and Severe issues
44
45 Quick Links:
46      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
47
48      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
49
50      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
51
52 **Upgrade Notes**
53         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
54         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
55         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
56         * The first time some apps are selected in the Applications panel, an error stating the webpage might be temporarily down, copy the presented URL to a new browser; once that is done, the application will open in the Portal.
57
58 **Deprecation Notes**
59         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
60         * Expect upgrade on Angular frontend and SpringBoot backend in next releases: The components like Policy, VID, SDC, AAI, MSB, SO – if any of them use portal/sdk java libraries, then please anticipate MAJOR changes to portal/sdk with respect to technology stack upgrade which is pending for long time on Angular frontend and SpringBoot backend.
61         * The tech stack upgrade helps resolve many security vulnerabilities and also provides latest rich UI and microservices features that components can take advantage of, just by upgrading to latest portal/sdk.
62
63 **Other**
64         * Below are the docker images released as part of Portal Platform project:
65         * onap/portal-app:2.6.0
66         * onap/portal-db:2.6.0
67         * onap/portal-sdk:2.6.0
68         * onap/portal-wms:2.6.0
69         * portal/sdk java artifacts - (Release branch: “release-2.6.0”)
70
71
72 Version: 2.5.0
73 --------------
74 :Release Date: 2019-06-13
75
76 .. toctree::
77     :maxdepth: 1
78
79 We worked on SDK upgrade to integrate with AAF. We partially implemented multi-language.
80
81 **New Features**
82         * SDK upgrade to integrate with AAF
83             * Use of CADI
84         * 68% JUnit Test Coverage
85         * Addressing security issues
86         * Angular 6 upgrade delivered foundation code with sample screen
87             * Documentation on the Angular 6 upgrade can be found `here <https://docs.onap.org/en/latest/submodules/portal.git/docs/tutorials/portal-sdk/your-angular-app.html>`_
88         * Internationalization language support - partially implemented.
89         * Reporting feature enhancement in portal/sdk - design and partial code changes
90         * There is more information about new features at `DEMOS - R4 Dublin Demos <https://wiki.onap.org/display/DW/DEMOS+-+R4+Dublin+Demos>`_
91
92 **Bug Fixes**
93         * Fixed Sonar reported critical issues.
94
95 **Known Issues**
96         * Mismatch while displaying active online user in Portal.
97         * Internationalization Language component partially completed.
98         * Functional Menu change requires manual refresh.
99         * Modifying Onboarded App configurations from the onboarding page malfunctions but changes to the App configuration can be done through accessing the database (portal:fn_app table) directly.
100
101 **Security Notes**
102
103 *Fixed Security Issues*
104
105 *Known Security Issues*
106
107         * CVE-2019-12317 - Number of XSS vulnerabilities in Portal [`OJSI-15 <https://jira.onap.org/browse/OJSI-15>`_]
108         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
109         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
110         * In default deployment PORTAL (portal-app) exposes HTTP port 8989 outside of cluster. [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
111         * In default deployment PORTAL (portal-app) exposes HTTP port 30215 outside of cluster. [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
112         * In default deployment PORTAL (portal-sdk) exposes HTTP port 30212 outside of cluster. [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
113         * CVE-2019-12318 - Number of SQL Injections in Portal [`OJSI-174 <https://jira.onap.org/browse/OJSI-174>`_]
114         * Portal stores users passwords encrypted instead of hashed [`OJSI-190 <https://jira.onap.org/browse/OJSI-190>`_]
115
116 *Known Vulnerabilities in Used Modules*
117
118 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_.
119
120 Quick Links:
121      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
122
123      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
124
125      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_
126
127 **Upgrade Notes**
128         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
129         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
130         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
131         * The first time some apps are selected in the Applications panel, an error stating the webpage might be temporarily down, copy the presented URL to a new browser; once that is done, the application will open in the Portal.
132
133 **Deprecation Notes**
134
135 **Other**
136         * Below are the docker images released as part of Portal Platform project:
137         * onap/portal-app:2.5.0
138         * onap/portal-db:2.5.0
139         * onap/portal-sdk:2.5.0
140         * onap/portal-wms:2.5.0
141         * portal/sdk java artifacts - (Release branch: “release-2.5.0”)
142
143 Version: 2.3.2
144 --------------
145 :Release Date: 2019-04-15
146
147 .. toctree::
148     :maxdepth: 1
149
150 This is the official release notes for the Casablanca Maintenance Release 3.0.2.
151
152 **Known Issues**
153         * The issue is an application running on HTTPS will not open in Portal if the AAF root CA is missing.
154           An error message will appear in a separate tab in Portal. It will say something like:
155           “The webpage at https://portal.api.simpledemo.onap.org:30200/vid/welcome.htm?cc=........ might
156           be temporarily down or it may have moved permanently to a new web address.”
157           Here is the work-around, copy above VID (or other app) URL and replace welcome.htm to login.htm
158           in a new browser window; after login come back to Portal home page and click VID, it will now work.
159
160         * For applications running on HTTP (for example SDC), the user needs to disable the security check in the browser to access the application.
161
162 **Other**
163         * Portal updated Keystore certificate from AAF to extend its expiry date; This change was made in OOM project.
164
165 Version: 2.3.1
166 --------------
167 :Release Date: 2019-01-31
168
169 .. toctree::
170     :maxdepth: 1
171
172 This is the official release notes for the Casablanca Maintenance.
173
174 **Bug Fixes**
175         * During installation Maria DB can now be accessed from within the portal-db container. The fix was made in OOM scripts to handle the db issue identified in the previous release.
176
177 Version: 2.3.0
178 --------------
179 :Release Date: 2018-11-30
180
181 .. toctree::
182     :maxdepth: 1
183
184 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
185
186 **New Features**
187         * Platform Maturity Guidelines - Integrating with OOM
188         * SDK upgrade to integrate with AAF
189             * Use of Semantic Versioning - V3 is the supported version
190             * Integration with AAF via REST; Supports both SDK and Framework Applications
191         * 65% JUnit Test Coverage
192         * Addressing security issues
193         * Internationalization language support - design related
194         * Reporting feature enhancement in portal/sdk - design and partial code changes
195         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
196         * Angular 5 upgraded with sample POC in SDK to build rich UI
197
198 **Bug Fixes**
199         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
200         * Improved documentation to get access to Portal through port 8989.
201         * Fixed Sonar reported critical issues.
202         * Improved OOM deployment 30235 external port mapping for portal-sdk.
203
204 **Known Issues**
205         * Mismatch while displaying active online user in Portal.
206         * UI misaligned on updating widgets in Portal.
207         * On Logout redirect landing page needs to be corrected.
208         * Functional Menu change requires manual refresh.
209
210 **Security Notes**
211
212 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_.
213
214 Quick Links:
215      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
216
217      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
218
219      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_
220
221 **Upgrade Notes**
222         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
223         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
224
225 **Deprecation Notes**
226
227 **Other**
228         * Below are the docker images released as part of Portal Platform project:
229         * onap/portal-app:2.3.1
230         * onap/portal-db:2.3.1
231         * onap/portal-sdk:2.3.1
232         * onap/portal-wms:2.3.1
233         * portal/sdk java artifacts - (Release branch: “release-2.4.0”)
234
235 Version: 2.2.0
236 --------------
237
238 :Release Date: 2018-06-07
239
240 .. toctree::
241     :maxdepth: 1
242
243 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
244
245 **New Features**
246         * Platform Maturity Guidelines
247         * Integrating with MUSIC, OOM, and AAF
248         * 50% JUnit Test Coverage
249         * Addressing security issues
250         * Bootstrapping of VID roles and tighter integration with AAF
251         * Role Centralization capability for framework based partners - design related
252         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
253
254 **Bug Fixes**
255         * Issues with roles fixed in this release.
256         * Now able to deselect widget on Widget catalog page
257         * Replaced the word ECOMP to ONAP
258         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
259         * Upgraded software packages to resolve security issues
260
261 **Known Issues**
262         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
263         * Logging needs improvement
264         * Not able to delete portal admin user
265         * Add support to connect with AAF Runtime
266         * Portal's SDK UI documentation in ONAP wiki needs samples
267         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
268         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
269
270 **Security Issues**
271         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
272
273 **Security Notes**
274
275 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_.
276
277 Quick Links:
278      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
279
280      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
281
282      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
283
284 **Upgrade Notes**
285         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
286
287 **Deprecation Notes**
288         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
289
290 **Other**
291         * Below are the docker images released as part of Portal Platform project:
292         * onap/portal-db:v2.2.0
293         * onap/portal-apps:v2.2.0
294         * onap/portal-wms:v2.2.0
295         * onap//music/music-cassandra:v3.0
296         * zookeeper:v3.4.0
297         * portal/sdk - (Release branch: "release-2.2.0")
298
299 Version: 1.3.0
300 --------------
301
302 :Release Date: 2017-11-16
303
304 The ONAP Portal is a platform that provides the ability to integrate different ONAP applications into a centralized Portal Core. The platform seed code is improved with below listed enhancements in this release. This is technically the first release of ONAP Portal Platform, previous release was the seed code contribution. As such, the defects fixed in this release were raised during the course of the release and while its integration testing. Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira (jira.onap.org).
305
306 **New Features**
307         * Digital Experience Control/UI upgrade.
308         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
309         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
310         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
311         * portal - (Release branch: "release-1.3.0")
312         * portal/sdk - (Release branch: "release-1.3.2")
313
314 **Bug Fixes**
315         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
316         * Fixed search and remove bugs in Widget Onboarding.
317         * Fixed issues in the Application Onboarding.
318         * Fixed issues in the Microservice Onboarding.
319         * Fixed deployment scripts and streamlined the reference variables.
320
321 **Known Issues**
322         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
323
324 **Security Issues**
325         * The issue "`PORTAL-137 <https://jira.onap.org/browse/PORTAL-137>`_ -Enhance Authentication" is fixed in Portal and in its SDK. The Portal team recommend partnering apps like Policy, VID, AAI, and SDC to upgrade to SDK's 1.3.2 or latest version to address the login vulnerability.
326
327 **Upgrade Notes**
328         * This is an initial release.
329
330 **Deprecation Notes**
331         * This is an initial release.
332
333 **Other**
334         * Below are the docker images released as part of Portal Platform project:
335         * onap/portal-db:v1.3.0
336         * onap/portal-apps:v1.3.0
337         * onap/portal-wms:v1.3.0
338
339 End of Release Notes