Update Release-Notes.rst
[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                         
37 **Security Issues**
38         * https://wiki.onap.org/pages/viewpage.action?pageId=35522356
39
40 **Security Notes**
41
42 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>`_.
43
44 Quick Links:
45         - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
46
47         - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
48
49         - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
50
51 **Upgrade Notes**
52
53 **Deprecation Notes**
54
55 **Other**
56         * Below are the docker images released as part of Portal Platform project:
57         * onap/portal-db:v2.3.0
58         * onap/portal-apps:v2.3.0
59         * onap/portal-wms:v2.3.0
60         * portal/sdk - (Release branch: "release-2.4.0")   
61
62 Version: 2.2.0
63 --------------
64
65 :Release Date: 2018-06-07
66
67 .. toctree::
68     :maxdepth: 1
69
70 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
71
72 **New Features**
73         * Platform Maturity Guidelines
74         * Integrating with MUSIC, OOM, and AAF
75         * 50% JUnit Test Coverage
76         * Addressing security issues
77         * Bootstrapping of VID roles and tighter integration with AAF
78         * Role Centralization capability for framework based partners - design related
79         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
80
81 **Bug Fixes**
82         * Issues with roles fixed in this release.
83         * Now able to deselect widget on Widget catalog page
84         * Replaced the word ECOMP to ONAP
85         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
86         * Upgraded software packages to resolve security issues
87
88 **Known Issues**
89         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
90         * Logging needs improvement
91         * Not able to delete portal admin user
92         * Add support to connect with AAF Runtime
93         * Portal's SDK UI documentation in ONAP wiki needs samples
94         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
95         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
96
97 **Security Issues**
98         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
99
100 **Security Notes**
101
102 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>`_.
103
104 Quick Links:
105         - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
106
107         - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
108
109         - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
110
111 **Upgrade Notes**
112         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
113
114 **Deprecation Notes**
115         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
116
117 **Other**
118         * Below are the docker images released as part of Portal Platform project:
119         * onap/portal-db:v2.2.0
120         * onap/portal-apps:v2.2.0
121         * onap/portal-wms:v2.2.0
122         * onap//music/music-cassandra:v3.0
123         * zookeeper:v3.4.0
124         * portal/sdk - (Release branch: "release-2.2.0")
125
126 Version: 1.3.0
127 --------------
128
129 :Release Date: 2017-11-16
130
131 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).
132
133 **New Features**
134         * Digital Experience Control/UI upgrade.
135         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
136         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
137         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
138         * portal - (Release branch: "release-1.3.0")
139         * portal/sdk - (Release branch: "release-1.3.2")
140
141 **Bug Fixes**
142         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
143         * Fixed search and remove bugs in Widget Onboarding.
144         * Fixed issues in the Application Onboarding.
145         * Fixed issues in the Microservice Onboarding.
146         * Fixed deployment scripts and streamlined the reference variables.
147
148 **Known Issues**
149         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
150
151 **Security Issues**
152         * 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.
153
154 **Upgrade Notes**
155         * This is an initial release.
156
157 **Deprecation Notes**
158         * This is an initial release.
159
160 **Other**
161         * Below are the docker images released as part of Portal Platform project:
162         * onap/portal-db:v1.3.0
163         * onap/portal-apps:v1.3.0
164         * onap/portal-wms:v1.3.0
165
166 End of Release Notes