7236d84868440fa8ea196d40cbe1f54f3f0eafce
[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 Maintanance 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 *Known Security Issues*
38
39 *Known Vulnerabilities in Used Modules*
40         * Addressed security issues reported by NexusIQ Critical and Severe issues
41
42 Quick Links:
43      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
44
45      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
46
47      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
48
49 **Upgrade Notes**
50         * 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.
51         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
52         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
53         * 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.
54
55 **Deprecation Notes**
56         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
57         * 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.
58         * 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.
59
60 **Other**
61         * Below are the docker images released as part of Portal Platform project:
62         * onap/portal-app:2.6.0
63         * onap/portal-db:2.6.0
64         * onap/portal-sdk:2.6.0
65         * onap/portal-wms:2.6.0
66         * portal/sdk java artifacts - (Release branch: “release-2.6.0”)
67
68
69 Version: 2.5.0
70 --------------
71 :Release Date: 2019-06-13
72
73 .. toctree::
74     :maxdepth: 1
75
76 We worked on SDK upgrade to integrate with AAF. We partially implemented multi-language.
77
78 **New Features**
79         * SDK upgrade to integrate with AAF
80             * Use of CADI
81         * 68% JUnit Test Coverage
82         * Addressing security issues
83         * Angular 6 upgrade delivered foundation code with sample screen
84             * 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>`_
85         * Internationalization language support - partially implemented.
86         * Reporting feature enhancement in portal/sdk - design and partial code changes
87         * There is more information about new features at `DEMOS - R4 Dublin Demos <https://wiki.onap.org/display/DW/DEMOS+-+R4+Dublin+Demos>`_
88
89 **Bug Fixes**
90         * Fixed Sonar reported critical issues.
91
92 **Known Issues**
93         * Mismatch while displaying active online user in Portal.
94         * Internationalization Language component partially completed.
95         * Functional Menu change requires manual refresh.
96         * 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.
97
98 **Security Notes**
99
100 *Fixed Security Issues*
101
102 *Known Security Issues*
103
104         * CVE-2019-12317 - Number of XSS vulnerabilities in Portal [`OJSI-15 <https://jira.onap.org/browse/OJSI-15>`_]
105         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
106         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
107         * In default deployment PORTAL (portal-app) exposes HTTP port 8989 outside of cluster. [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
108         * In default deployment PORTAL (portal-app) exposes HTTP port 30215 outside of cluster. [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
109         * In default deployment PORTAL (portal-sdk) exposes HTTP port 30212 outside of cluster. [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
110         * CVE-2019-12318 - Number of SQL Injections in Portal [`OJSI-174 <https://jira.onap.org/browse/OJSI-174>`_]
111         * Portal stores users passwords encrypted instead of hashed [`OJSI-190 <https://jira.onap.org/browse/OJSI-190>`_]
112
113 *Known Vulnerabilities in Used Modules*
114
115 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>`_.
116
117 Quick Links:
118      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
119
120      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
121
122      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_
123
124 **Upgrade Notes**
125         * 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.
126         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
127         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
128         * 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.
129
130 **Deprecation Notes**
131
132 **Other**
133         * Below are the docker images released as part of Portal Platform project:
134         * onap/portal-app:2.5.0
135         * onap/portal-db:2.5.0
136         * onap/portal-sdk:2.5.0
137         * onap/portal-wms:2.5.0
138         * portal/sdk java artifacts - (Release branch: “release-2.5.0”)
139
140 Version: 2.3.2
141 --------------
142 :Release Date: 2019-04-15
143
144 .. toctree::
145     :maxdepth: 1
146
147 This is the official release notes for the Casablanca Maintenance Release 3.0.2.
148
149 **Known Issues**
150         * The issue is an application running on HTTPS will not open in Portal if the AAF root CA is missing.
151           An error message will appear in a separate tab in Portal. It will say something like:
152           “The webpage at https://portal.api.simpledemo.onap.org:30200/vid/welcome.htm?cc=........ might
153           be temporarily down or it may have moved permanently to a new web address.”
154           Here is the work-around, copy above VID (or other app) URL and replace welcome.htm to login.htm
155           in a new browser window; after login come back to Portal home page and click VID, it will now work.
156
157         * For applications running on HTTP (for example SDC), the user needs to disable the security check in the browser to access the application.
158
159 **Other**
160         * Portal updated Keystore certificate from AAF to extend its expiry date; This change was made in OOM project.
161
162 Version: 2.3.1
163 --------------
164 :Release Date: 2019-01-31
165
166 .. toctree::
167     :maxdepth: 1
168
169 This is the official release notes for the Casablanca Maintenance.
170
171 **Bug Fixes**
172         * 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.
173
174 Version: 2.3.0
175 --------------
176 :Release Date: 2018-11-30
177
178 .. toctree::
179     :maxdepth: 1
180
181 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
182
183 **New Features**
184         * Platform Maturity Guidelines - Integrating with OOM
185         * SDK upgrade to integrate with AAF
186             * Use of Semantic Versioning - V3 is the supported version
187             * Integration with AAF via REST; Supports both SDK and Framework Applications
188         * 65% JUnit Test Coverage
189         * Addressing security issues
190         * Internationalization language support - design related
191         * Reporting feature enhancement in portal/sdk - design and partial code changes
192         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
193         * Angular 5 upgraded with sample POC in SDK to build rich UI
194
195 **Bug Fixes**
196         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
197         * Improved documentation to get access to Portal through port 8989.
198         * Fixed Sonar reported critical issues.
199         * Improved OOM deployment 30235 external port mapping for portal-sdk.
200
201 **Known Issues**
202         * Mismatch while displaying active online user in Portal.
203         * UI misaligned on updating widgets in Portal.
204         * On Logout redirect landing page needs to be corrected.
205         * Functional Menu change requires manual refresh.
206
207 **Security Notes**
208
209 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>`_.
210
211 Quick Links:
212      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
213
214      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
215
216      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_
217
218 **Upgrade Notes**
219         * 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.
220         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
221
222 **Deprecation Notes**
223
224 **Other**
225         * Below are the docker images released as part of Portal Platform project:
226         * onap/portal-app:2.3.1
227         * onap/portal-db:2.3.1
228         * onap/portal-sdk:2.3.1
229         * onap/portal-wms:2.3.1
230         * portal/sdk java artifacts - (Release branch: “release-2.4.0”)
231
232 Version: 2.2.0
233 --------------
234
235 :Release Date: 2018-06-07
236
237 .. toctree::
238     :maxdepth: 1
239
240 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
241
242 **New Features**
243         * Platform Maturity Guidelines
244         * Integrating with MUSIC, OOM, and AAF
245         * 50% JUnit Test Coverage
246         * Addressing security issues
247         * Bootstrapping of VID roles and tighter integration with AAF
248         * Role Centralization capability for framework based partners - design related
249         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
250
251 **Bug Fixes**
252         * Issues with roles fixed in this release.
253         * Now able to deselect widget on Widget catalog page
254         * Replaced the word ECOMP to ONAP
255         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
256         * Upgraded software packages to resolve security issues
257
258 **Known Issues**
259         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
260         * Logging needs improvement
261         * Not able to delete portal admin user
262         * Add support to connect with AAF Runtime
263         * Portal's SDK UI documentation in ONAP wiki needs samples
264         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
265         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
266
267 **Security Issues**
268         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
269
270 **Security Notes**
271
272 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>`_.
273
274 Quick Links:
275      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
276
277      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
278
279      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
280
281 **Upgrade Notes**
282         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
283
284 **Deprecation Notes**
285         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
286
287 **Other**
288         * Below are the docker images released as part of Portal Platform project:
289         * onap/portal-db:v2.2.0
290         * onap/portal-apps:v2.2.0
291         * onap/portal-wms:v2.2.0
292         * onap//music/music-cassandra:v3.0
293         * zookeeper:v3.4.0
294         * portal/sdk - (Release branch: "release-2.2.0")
295
296 Version: 1.3.0
297 --------------
298
299 :Release Date: 2017-11-16
300
301 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).
302
303 **New Features**
304         * Digital Experience Control/UI upgrade.
305         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
306         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
307         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
308         * portal - (Release branch: "release-1.3.0")
309         * portal/sdk - (Release branch: "release-1.3.2")
310
311 **Bug Fixes**
312         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
313         * Fixed search and remove bugs in Widget Onboarding.
314         * Fixed issues in the Application Onboarding.
315         * Fixed issues in the Microservice Onboarding.
316         * Fixed deployment scripts and streamlined the reference variables.
317
318 **Known Issues**
319         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
320
321 **Security Issues**
322         * 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.
323
324 **Upgrade Notes**
325         * This is an initial release.
326
327 **Deprecation Notes**
328         * This is an initial release.
329
330 **Other**
331         * Below are the docker images released as part of Portal Platform project:
332         * onap/portal-db:v1.3.0
333         * onap/portal-apps:v1.3.0
334         * onap/portal-wms:v1.3.0
335
336 End of Release Notes