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