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