Force py3.8 in tox.ini
[multicloud/framework.git] / docs / release-notes.rst
index ab79eaf..085252f 100644 (file)
@@ -11,13 +11,20 @@ MultiCloud Release Notes
 Abstract
 ========
 
-This document provides the release notes for the ``honolulu`` maintenance release.
+This document provides the release notes for the ``jakarta`` release.
 
 Summary
 =======
 
-This release introduces new features into k8s plugin that enhance Day 2 configuration support for k8s resources and brings features for monitoring of CNF health.
-Maintenance Release provided additional changes compared to Honolulu release in k8splugin (see Bug fixes and Docker images sections).
+
+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
 ============
@@ -26,15 +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-k8s:0.8.2**                   |
+| **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**   | honolulu 8.1.0                                  |
+| **Release designation**   | jakarta                                         |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+
 
@@ -42,25 +49,21 @@ Release Data
 New features
 ------------
 
-New features in k8s Plugin:
-- Refined Configuration API allows for flexible modification of the CNF configuration. Configuration API allows to create, modify and delete k8s resource templates and it allows their parameterization base on dedicated or inherited from the CNF instance input parameters.
+New features in k8s Plugin related with CNF support implemented by:
 
-- Query API allows for the gathering of the filtered out the status of CNF what can be helpful to get precise information for particular resources belonging to the CNF. Query API produces results in the same format as Status API that offers the full set of information about CNF status.
-
-- HealthCheck API allows for the execution of dedicated healthcheck jobs (similar to helm test operation) that can verify on demand the current status of the CNF. The API can be used also to retrieved the results of healthcheck job execution, which can be extended with Status/Query API
-
-All new the features of k8splugin are explained and showcased as a part of `vFW CNF Use Case <https://docs.onap.org/projects/onap-integration/en/honolulu/docs_vFW_CNF_CDS.html>` and in the k8s API documentation.
+- `<https://jira.onap.org/browse/MULTICLOUD-1386>`_
+- `<https://jira.onap.org/browse/REQ-890>`_
 
 **Bug fixes**
 
-- `MULTICLOUD-1295 <https://jira.onap.org/browse/MULTICLOUD-1295>`_
-  MultiCloud k8s: Bug in Multicloud K8S Plugin Detemplating
+- `MULTICLOUD-1468 <https://jira.onap.org/browse/MULTICLOUD-1468>`_
+  MultiCloud k8s: Etcd connection is not validated on k8splugin start
 
-- `MULTICLOUD-1338 <https://jira.onap.org/browse/MULTICLOUD-1338>`_
-  MultiCloud k8s: Foreground delete policy prevents deletion of the pods
+- `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-1348 <https://jira.onap.org/browse/MULTICLOUD-1348>`_
-  MultiCloud k8s: Regression in Multicloud-k8s
+- `MULTICLOUD-1443 <https://jira.onap.org/browse/MULTICLOUD-1443>`_
+  Multicloud k8s: Fix log4j cve
 
 **Known Issues**
 
@@ -73,12 +76,6 @@ All new the features of k8splugin are explained and showcased as a part of `vFW
 - `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-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
-  MultiCloud k8s: K8s Plugins keeps failed RB Instance
-
 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
   MultiCloud k8s: Query API returns 500 instead of 404
 
@@ -91,6 +88,9 @@ All new the features of k8splugin are explained and showcased as a part of `vFW
 - `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
 ------------
 
@@ -120,7 +120,7 @@ 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
 -----------
@@ -132,11 +132,26 @@ 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
 ============
@@ -146,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`_
@@ -167,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>`_