Merge "Updated Release-notes for Known Issues"
[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-2018 AT&T Intellectual Property.  All rights reserved
4
5
6 Portal Platform Release Notes
7 =============================
8
9 Version: 2.3.0
10 --------------
11 :Release Date: 2018-11-15
12
13 .. toctree::
14     :maxdepth: 1
15
16 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
17
18 **New Features**
19         * Platform Maturity Guidelines - Integrating with OOM
20         * SDK upgrade to integrate with AAF
21             * Use of Semantic Versioning - V3 is the supported version
22             * Integration with AAF via REST; Supports both SDK and Framework Applications
23         * 65% JUnit Test Coverage
24         * Addressing security issues
25         * Internationalization language support - design related
26         * Reporting feature enhancement in portal/sdk - design and partial code changes
27         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
28            
29 **Bug Fixes**
30         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
31         * Improved documentation to get access to Portal through port 8989.
32         * Fixed Sonar reported critical issues.
33         * Improved OOM deployment 30235 external port mapping for portal-sdk.
34
35 **Known Issues**
36         * Mismatch while displaying active online user in Portal.
37         * UI misaligned on updating widgets in Portal.
38         * On Logout redirect landing page needs to be corrected.
39         * Functional Menu change requires manual refresh.
40        
41 **Security Issues**
42     * https://wiki.onap.org/pages/viewpage.action?pageId=35522356
43
44 **Security Notes**
45
46 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>`_.
47
48 Quick Links:
49      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
50
51      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
52
53      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
54
55 **Upgrade Notes**
56
57 **Deprecation Notes**
58
59 **Other**
60         * Below are the docker images released as part of Portal Platform project:
61         * onap/portal-db:2.3.0
62         * onap/portal-apps:2.3.0
63         * onap/portal-wms:2.3.0
64         * portal/sdk - (Release branch: "release-2.4.0")  
65
66 Version: 2.2.0
67 --------------
68
69 :Release Date: 2018-06-07
70
71 .. toctree::
72     :maxdepth: 1
73
74 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
75
76 **New Features**
77         * Platform Maturity Guidelines
78         * Integrating with MUSIC, OOM, and AAF
79         * 50% JUnit Test Coverage
80         * Addressing security issues
81         * Bootstrapping of VID roles and tighter integration with AAF
82         * Role Centralization capability for framework based partners - design related
83         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
84
85 **Bug Fixes**
86         * Issues with roles fixed in this release.
87         * Now able to deselect widget on Widget catalog page
88         * Replaced the word ECOMP to ONAP
89         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
90         * Upgraded software packages to resolve security issues
91
92 **Known Issues**
93         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
94         * Logging needs improvement
95         * Not able to delete portal admin user
96         * Add support to connect with AAF Runtime
97         * Portal's SDK UI documentation in ONAP wiki needs samples
98         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
99         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
100
101 **Security Issues**
102         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
103
104 **Security Notes**
105
106 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>`_.
107
108 Quick Links:
109      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
110
111      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
112
113      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
114
115 **Upgrade Notes**
116         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
117
118 **Deprecation Notes**
119         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
120
121 **Other**
122         * Below are the docker images released as part of Portal Platform project:
123         * onap/portal-db:v2.2.0
124         * onap/portal-apps:v2.2.0
125         * onap/portal-wms:v2.2.0
126         * onap//music/music-cassandra:v3.0
127         * zookeeper:v3.4.0
128         * portal/sdk - (Release branch: "release-2.2.0")
129
130 Version: 1.3.0
131 --------------
132
133 :Release Date: 2017-11-16
134
135 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).
136
137 **New Features**
138         * Digital Experience Control/UI upgrade.
139         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
140         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
141         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
142         * portal - (Release branch: "release-1.3.0")
143         * portal/sdk - (Release branch: "release-1.3.2")
144
145 **Bug Fixes**
146         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
147         * Fixed search and remove bugs in Widget Onboarding.
148         * Fixed issues in the Application Onboarding.
149         * Fixed issues in the Microservice Onboarding.
150         * Fixed deployment scripts and streamlined the reference variables.
151
152 **Known Issues**
153         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
154
155 **Security Issues**
156         * 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.
157
158 **Upgrade Notes**
159         * This is an initial release.
160
161 **Deprecation Notes**
162         * This is an initial release.
163
164 **Other**
165         * Below are the docker images released as part of Portal Platform project:
166         * onap/portal-db:v1.3.0
167         * onap/portal-apps:v1.3.0
168         * onap/portal-wms:v1.3.0
169
170 End of Release Notes