Force py3.8 in tox.ini
[multicloud/framework.git] / docs / release-notes.rst
index 41c83c5..085252f 100644 (file)
@@ -11,14 +11,20 @@ MultiCloud Release Notes
 Abstract
 ========
 
-This document provides the release notes for the ``guilin`` release.
+This document provides the release notes for the ``jakarta`` release.
 
 Summary
 =======
 
-MultiCloud Project enhances artifactbroker to support CNF orchestration with
-artifact format of helm charts (without wrapping in a dummy heat template)
 
+Version: 10.0.0
+--------------
+
+The ``jakarta`` release introduces following enhancements in k8splugin.
+
+- Better Configuration API support including rollback, improved deletion of the configuration with or without removal of the configuration resources in the cluster.
+- Creation of the configuration template without a dedicated helm chart which allows for easy update of the override values by configuration API without a need to duplicate the configuration template helm chart from the main helm chart. The configuration template (Helm chart) is taken from the main definition.
+- Instance upgrade endpoint that allows upgrading existing CNF instance. We can change the definition (Helm chart), and override values of even the cluster in which the instance is deployed which in consequence allows the realization of the migration procedure.
 
 Release Data
 ============
@@ -27,16 +33,15 @@ Release Data
 | **Project**               | MultiCloud                                      |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+
-| **Docker images**         | onap/multicloud-framework:1.6.0                 |
-|                           | onap/multicloud-framework-artifactbroker:1.6.0  |
-|                           | onap/multicloud-openstack-starlingx:1.5.5       |
-|                           | onap/multicloud-openstack-windriver:1.5.5       |
-|                           | onap/multicloud-openstack-fcaps:1.5.5           |
-|                           | onap/multicloud-openstack-pike:1.5.5            |
-|                           | onap/multicloud-azure:1.2.4                     |
-|                           | onap/multicloud-k8s:0.7.0                       |
-+--------------------------------------+--------------------------------------+
-| **Release designation**   | Guilin 7.0.0                                    |
+| **Docker images**         | onap/multicloud-framework:1.7.3                 |
+|                           | onap/multicloud-framework-artifactbroker:1.7.3  |
+|                           | onap/multicloud-openstack-starlingx:1.5.7       |
+|                           | onap/multicloud-openstack-windriver:1.5.7       |
+|                           | onap/multicloud-openstack-fcaps:1.5.7           |
+|                           | onap/multicloud-openstack-pike:1.5.7            |
+|                           | onap/multicloud-k8s:0.10.1                      |
++---------------------------+-------------------------------------------------+
+| **Release designation**   | jakarta                                         |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+
 
@@ -44,30 +49,47 @@ Release Data
 New features
 ------------
 
-Enables CNF orchestration with artifact format of helm charts
+New features in k8s Plugin related with CNF support implemented by:
+
+- `<https://jira.onap.org/browse/MULTICLOUD-1386>`_
+- `<https://jira.onap.org/browse/REQ-890>`_
 
 **Bug fixes**
 
-- `MULTICLOUD-1195 <https://jira.onap.org/browse/MULTICLOUD-1195>`_
-  Multicloud used wrong MSB URL
-  
+- `MULTICLOUD-1468 <https://jira.onap.org/browse/MULTICLOUD-1468>`_
+  MultiCloud k8s: Etcd connection is not validated on k8splugin start
+
+- `MULTICLOUD-1446 <https://jira.onap.org/browse/MULTICLOUD-1446>`_
+  Multicloud k8s: Multicloud K8S Plugin does not delete namespace during the SO delete CNF instance macro flow
+
+- `MULTICLOUD-1443 <https://jira.onap.org/browse/MULTICLOUD-1443>`_
+  Multicloud k8s: Fix log4j cve
+
 **Known Issues**
 
 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
   MultiCloud OpenStack: image creating API cannot handle large image file
 
-- `MULTICLOUD-389 <https://jira.onap.org/browse/MULTICLOUD-389>`_
-  MultiCloud OpenStack: keypair cannot be passed for nova instance creation
-
 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
 
 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
   MultiCloud k8s: move to sigs yaml from ghodss
 
-- `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
-  MultiCloud k8s: OVN Installation issues
+- `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
+  MultiCloud k8s: Query API returns 500 instead of 404
+
+- `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
+  MultiCloud k8s: Redundant data in MongoDB created
+
+- `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
+  MultiCloud k8s: Consul operation interface problems
+
+- `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
+  MultiCloud k8s: Instance status update failure
 
+- `MULTICLOUD-1459 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
+  MultiCloud k8s: Multicloud-k8s dockers contain GPLv3
 
 Deliverables
 ------------
@@ -88,11 +110,9 @@ System Limitations
 
 N/A
 
-
 Known Vulnerabilities
 ---------------------
 
-
 MULTICLOUD 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.
@@ -100,25 +120,38 @@ been assessed for risk and determined to be false positive.
 The MULTICLOUD open Critical security vulnerabilities and their risk
 assessment have been documented as part of the
 `project
-<https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_.
-
+<https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_.
 
 Workarounds
 -----------
 
 N/A
 
-
 Security Notes
 --------------
 
 **Fixed Security Issues**
 
-N/A
+CVE issue pertained to multicloud-openstack components reported
+by https://wiki.onap.org/display/SV/Istanbul+Multicloud
+has been fixed by upgrading dependencies
+
+CVE issue pertained to multicloud-framework components reported
+by https://wiki.onap.org/display/SV/Istanbul+Multicloud
+has been fixed by upgrading dependencies
 
 **Known Security Issues**
 
-N/A
+
+Fixing of CVE issue pertained to multicloud-framework-artifactbroker components
+reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
+is an ongoing effort
+
+
+Fixing of CVE issue pertained to multicloud-openstack-vmware components
+reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
+will not be fixed due to lack of commitment from community
+
 
 Test Results
 ============
@@ -128,7 +161,7 @@ N/A
 References
 ==========
 
-For more information on the ONAP ``guilin`` release, please see:
+For more information on the ONAP ``jakarta`` release, please see:
 
 #. `ONAP Home Page`_
 #. `ONAP Documentation`_
@@ -149,6 +182,6 @@ Quick Links
 
   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
 
-  - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_
+  - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_
 
   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_