Gulian release notes for portal
[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-2020 AT&T Intellectual Property.  All rights reserved
4 .. _release_notes:
5
6
7 Portal Platform Release Notes
8 =============================
9 Version: 3.4.2
10 --------------
11 :Release Date: 2020-11-19
12
13 .. toctree::
14     :maxdepth: 1
15
16 This release contains security enhancement and Analytics Framework (aka Raptor) Upgrade to support reprots, charts, etc.
17
18 **New Features**
19
20         * Removed zookeeper dependency
21         * Code updates for Conformance to ONAP Logging specifications (Audit, Metrics, Error logs)
22
23 **Bug Fixes**
24
25         * Fix nexus-iq reported scan issues for portal and SDK components
26
27 **Known Issues**
28         * None
29
30 **Security Notes**
31
32         * Containers to run as Non-Root user: portal, portal-sdk, portal-widget, mariaDB backend db
33         * Removal of hard-coded passwords/security credentials in HELM charts and use secrets
34
35 *Fixed Security Issues*
36
37         * Portal-966 - Start portal mariadb/cassandra docker with non root user [`PORTAL-966 <hhttps://jira.onap.org/browse/PORTAL-966>`_]
38         * PORTAL - 946 - No root (superuser) access to database from application container - Portal [`PORTAL-946 <https://jira.onap.org/browse/PORTAL-946>`_]
39         * PORTAL - 944 - Continue hardcoded passwords removal - Portal [`PORTAL-944 <https://jira.onap.org/browse/PORTAL-944>`_]
40
41 *Known Security Issues*
42         * Cassandra docker image still needs to be updated, so that cassandra container starts as a non-root user
43
44 *Known Vulnerabilities in Used Modules*
45         * None
46
47 Quick Links:
48      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
49
50      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
51
52      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
53
54 **Upgrade Notes**
55         * These still apply:
56         1. 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.
57         2. For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
58         3. For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts. Different browsers use different methods to accomplish this, Firefox has a security icon near the URL that you can click on "Unblock" and "Disable protection for now"
59         4. 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.
60
61 **Deprecation Notes**
62         * Policy GUI depricated
63         * A&AI GUI depricated
64
65 **Other**
66         * Below are the docker images released as part of Portal Platform project:
67         * onap/portal-app:3.4.2
68         * onap/portal-db:3.4.1
69         * onap/portal-sdk:3.4.2
70         * onap/portal-wms:3.4.2
71         * portal/sdk java artifacts - (Release branch: “release-3.3.0”; Jar Version: "3.3.0")
72
73 Version: 3.2.0
74 --------------
75 :Release Date: 2020-05-21
76
77 .. toctree::
78     :maxdepth: 1
79
80 This release contains an Angular upgrade, bug fixes and security enhancements.
81
82 **New Features**
83
84         * Angular Upgrade from 1.X to 7.0 - Portal and SDK (Backward Compatible)
85         * OParent 2.0 Migration & Self Release Jobs
86         * UI/TypeScript Test Coverage - (Portal Coverage 60% and SDK Coverage 63%)
87         * Spring Boot Migration (Portal only/ Partially Completed)
88
89 **Bug Fixes**
90
91         * License scan issues addressed
92         * Fixed Sonar reported critical issues.
93
94 **Known Issues**
95         * User management pages do not work properly. We will be addressing this in the Guilin release. So, the work around is:
96
97            1.  If we try to add user role by navigating directly to an application, like A&AI, we are unable to add roles.
98            2.  However, With Portal admin privileges a user (in this case Demo user) can navigate to User screen and select Portal/Default from the drop down.
99            3.  Then update user roles for A&AI and other applications in the popup.
100            4.  We validated that this operation is correctly updating the role in AAF.
101
102 **Security Notes**
103
104         * Closed HTTP Ports (Portal, SDK)
105         * Address Security Vulnerabilities from Nexus-IQ (Jars and Javascript libraries)
106         * Containers to run as Non-Root user: portal, portal-sdk, portal-widget
107
108 *Fixed Security Issues*
109
110         * OJSI-97 - portal-app exposes plain text HTTP endpoint using port 8989 [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
111         * OJSI-105 - portal-sdk exposes plain text HTTP endpoint using port 30212 [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
112         * OJSI-106 - portal-app exposes plain text HTTP endpoint using port 30215 [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
113
114 *Known Security Issues*
115
116 *Known Vulnerabilities in Used Modules*
117         * Portal was granted a waiver by SECCOM for OJSI-190. Portal stores users passwords encrypted instead of hashed. This was not fixed for Frankfurt.
118
119 Quick Links:
120      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
121
122      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
123
124      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
125
126 **Upgrade Notes**
127         * These still apply:
128            1. 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            2. For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
130            3. For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts. Different browsers use different methods to accomplish this, Firefox has a security icon near the URL that you can click on "Unblock" and "Disable protection for now"
131            4. 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         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
135         * 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.
136         * 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.
137
138 **Other**
139         * Below are the docker images released as part of Portal Platform project:
140         * onap/portal-app:3.2.3
141         * onap/portal-db:3.2.3
142         * onap/portal-sdk:3.2.0
143         * onap/portal-wms:3.2.3
144         * portal/sdk java artifacts - (Release branch: “release-3.2.0”; Jar Version: "3.0.0")
145
146 Version: 2.6.0 Maintenance
147 --------------
148 :Release Date: 2020-08-24
149
150 El Alto Maintenance Release 1
151
152 The primary goal of this maintenance release is to address expired certificates.
153 PORTAL-878 Portal certificate renewal pwd patch
154
155 Version: 2.6.0
156 --------------
157 :Release Date: 2019-10-03
158
159 .. toctree::
160     :maxdepth: 1
161
162
163 **No New Features**
164
165 **Bug Fixes**
166         * Portal Setup - MariaDB issue.
167         * Issue editing application url.
168         * PORTAL-* charts now use nodePortPrefix variable.
169         * Fixed Sonar reported critical issues.
170
171 **Known Issues**
172         * AAI UI's new role "ui_view" is not registered in AAF, Portal cannot fetch it. So, the work around is
173
174            1. upload new role from Bulk Upload in Portal Roles page (create a csv file which has one line like:   ui_view,10 )
175            2. Sync Roles on same page
176            3. Assign this ui_view role to demo account in User page
177            4. Then demo user can access AAI UI app from Portal
178
179 **Security Notes**
180
181 *Fixed Security Issues*
182
183         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
184         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
185
186 *Known Security Issues*
187
188 *Known Vulnerabilities in Used Modules*
189         * Addressed security issues reported by NexusIQ Critical and Severe issues
190
191 Quick Links:
192      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
193
194      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
195
196      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
197
198 **Upgrade Notes**
199         * 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.
200         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
201         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
202         * 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.
203
204 **Deprecation Notes**
205         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
206         * 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.
207         * 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.
208
209 **Other**
210         * Below are the docker images released as part of Portal Platform project:
211         * onap/portal-app:2.6.0
212         * onap/portal-db:2.6.0
213         * onap/portal-sdk:2.6.0
214         * onap/portal-wms:2.6.0
215         * portal/sdk java artifacts - (Release branch: "release-2.6.0")
216
217
218 Version: 2.5.0
219 --------------
220 :Release Date: 2019-06-13
221
222 .. toctree::
223     :maxdepth: 1
224
225 We worked on SDK upgrade to integrate with AAF. We partially implemented multi-language.
226
227 **New Features**
228         * SDK upgrade to integrate with AAF
229             * Use of CADI
230         * 68% JUnit Test Coverage
231         * Addressing security issues
232         * Angular 6 upgrade delivered foundation code with sample screen
233             * 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>`_
234         * Internationalization language support - partially implemented.
235         * Reporting feature enhancement in portal/sdk - design and partial code changes
236         * There is more information about new features at `DEMOS - R4 Dublin Demos <https://wiki.onap.org/display/DW/DEMOS+-+R4+Dublin+Demos>`_
237
238 **Bug Fixes**
239         * Fixed Sonar reported critical issues.
240
241 **Known Issues**
242         * Mismatch while displaying active online user in Portal.
243         * Internationalization Language component partially completed.
244         * Functional Menu change requires manual refresh.
245         * 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.
246
247 **Security Notes**
248
249 *Fixed Security Issues*
250
251 *Known Security Issues*
252
253         * CVE-2019-12317 - Number of XSS vulnerabilities in Portal [`OJSI-15 <https://jira.onap.org/browse/OJSI-15>`_]
254         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
255         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
256         * In default deployment PORTAL (portal-app) exposes HTTP port 8989 outside of cluster. [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
257         * In default deployment PORTAL (portal-app) exposes HTTP port 30215 outside of cluster. [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
258         * In default deployment PORTAL (portal-sdk) exposes HTTP port 30212 outside of cluster. [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
259         * CVE-2019-12318 - Number of SQL Injections in Portal [`OJSI-174 <https://jira.onap.org/browse/OJSI-174>`_]
260         * Portal stores users passwords encrypted instead of hashed [`OJSI-190 <https://jira.onap.org/browse/OJSI-190>`_]
261
262 *Known Vulnerabilities in Used Modules*
263
264 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>`_.
265
266 Quick Links:
267      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
268
269      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
270
271      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_
272
273 **Upgrade Notes**
274         * 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.
275         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
276         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
277         * 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.
278
279 **Deprecation Notes**
280
281 **Other**
282         * Below are the docker images released as part of Portal Platform project:
283         * onap/portal-app:2.5.0
284         * onap/portal-db:2.5.0
285         * onap/portal-sdk:2.5.0
286         * onap/portal-wms:2.5.0
287         * portal/sdk java artifacts - (Release branch: "release-2.5.0")
288
289 Version: 2.3.2
290 --------------
291 :Release Date: 2019-04-15
292
293 .. toctree::
294     :maxdepth: 1
295
296 This is the official release notes for the Casablanca Maintenance Release 3.0.2.
297
298 **Known Issues**
299         * The issue is an application running on HTTPS will not open in Portal if the AAF root CA is missing.
300           An error message will appear in a separate tab in Portal. It will say something like:
301           "The webpage at https://portal.api.simpledemo.onap.org:30200/vid/welcome.htm?cc=........ might
302           be temporarily down or it may have moved permanently to a new web address."
303           Here is the work-around, copy above VID (or other app) URL and replace welcome.htm to login.htm
304           in a new browser window; after login come back to Portal home page and click VID, it will now work.
305
306         * For applications running on HTTP (for example SDC), the user needs to disable the security check in the browser to access the application.
307
308 **Other**
309         * Portal updated Keystore certificate from AAF to extend its expiry date; This change was made in OOM project.
310
311 Version: 2.3.1
312 --------------
313 :Release Date: 2019-01-31
314
315 .. toctree::
316     :maxdepth: 1
317
318 This is the official release notes for the Casablanca Maintenance.
319
320 **Bug Fixes**
321         * 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.
322
323 Version: 2.3.0
324 --------------
325 :Release Date: 2018-11-30
326
327 .. toctree::
328     :maxdepth: 1
329
330 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
331
332 **New Features**
333         * Platform Maturity Guidelines - Integrating with OOM
334         * SDK upgrade to integrate with AAF
335             * Use of Semantic Versioning - V3 is the supported version
336             * Integration with AAF via REST; Supports both SDK and Framework Applications
337         * 65% JUnit Test Coverage
338         * Addressing security issues
339         * Internationalization language support - design related
340         * Reporting feature enhancement in portal/sdk - design and partial code changes
341         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
342         * Angular 5 upgraded with sample POC in SDK to build rich UI
343
344 **Bug Fixes**
345         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
346         * Improved documentation to get access to Portal through port 8989.
347         * Fixed Sonar reported critical issues.
348         * Improved OOM deployment 30235 external port mapping for portal-sdk.
349
350 **Known Issues**
351         * Mismatch while displaying active online user in Portal.
352         * UI misaligned on updating widgets in Portal.
353         * On Logout redirect landing page needs to be corrected.
354         * Functional Menu change requires manual refresh.
355
356 **Security Notes**
357
358 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>`_.
359
360 Quick Links:
361      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
362
363      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
364
365      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_
366
367 **Upgrade Notes**
368         * 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.
369         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
370
371 **Deprecation Notes**
372
373 **Other**
374         * Below are the docker images released as part of Portal Platform project:
375         * onap/portal-app:2.3.1
376         * onap/portal-db:2.3.1
377         * onap/portal-sdk:2.3.1
378         * onap/portal-wms:2.3.1
379         * portal/sdk java artifacts - (Release branch: "release-2.4.0")
380
381 Version: 2.2.0
382 --------------
383
384 :Release Date: 2018-06-07
385
386 .. toctree::
387     :maxdepth: 1
388
389 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
390
391 **New Features**
392         * Platform Maturity Guidelines
393         * Integrating with MUSIC, OOM, and AAF
394         * 50% JUnit Test Coverage
395         * Addressing security issues
396         * Bootstrapping of VID roles and tighter integration with AAF
397         * Role Centralization capability for framework based partners - design related
398         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
399
400 **Bug Fixes**
401         * Issues with roles fixed in this release.
402         * Now able to deselect widget on Widget catalog page
403         * Replaced the word ECOMP to ONAP
404         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
405         * Upgraded software packages to resolve security issues
406
407 **Known Issues**
408         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
409         * Logging needs improvement
410         * Not able to delete portal admin user
411         * Add support to connect with AAF Runtime
412         * Portal's SDK UI documentation in ONAP wiki needs samples
413         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
414         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
415
416 **Security Issues**
417         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
418
419 **Security Notes**
420
421 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>`_.
422
423 Quick Links:
424      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
425
426      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
427
428      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
429
430 **Upgrade Notes**
431         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
432
433 **Deprecation Notes**
434         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
435
436 **Other**
437         * Below are the docker images released as part of Portal Platform project:
438         * onap/portal-db:v2.2.0
439         * onap/portal-apps:v2.2.0
440         * onap/portal-wms:v2.2.0
441         * onap//music/music-cassandra:v3.0
442         * zookeeper:v3.4.0
443         * portal/sdk - (Release branch: "release-2.2.0")
444
445 Version: 1.3.0
446 --------------
447
448 :Release Date: 2017-11-16
449
450 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).
451
452 **New Features**
453         * Digital Experience Control/UI upgrade.
454         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
455         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
456         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
457         * portal - (Release branch: "release-1.3.0")
458         * portal/sdk - (Release branch: "release-1.3.2")
459
460 **Bug Fixes**
461         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
462         * Fixed search and remove bugs in Widget Onboarding.
463         * Fixed issues in the Application Onboarding.
464         * Fixed issues in the Microservice Onboarding.
465         * Fixed deployment scripts and streamlined the reference variables.
466
467 **Known Issues**
468         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
469
470 **Security Issues**
471         * 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.
472
473 **Upgrade Notes**
474         * This is an initial release.
475
476 **Deprecation Notes**
477         * This is an initial release.
478
479 **Other**
480         * Below are the docker images released as part of Portal Platform project:
481         * onap/portal-db:v1.3.0
482         * onap/portal-apps:v1.3.0
483         * onap/portal-wms:v1.3.0
484
485 End of Release Notes