docs/release-notes.rst - onap/multicloud/framework - Gitiles

 .. This work is licensed under a Creative Commons Attribution 4.0
    International License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) ONAP Project and its contributors
 .. _release_notes:

 ************************
 MultiCloud Release Notes
 ************************

 Abstract
 ========

 This document provides the release notes for the ``jakarta`` release.

 Summary
 =======


 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
 ============

 +---------------------------+-------------------------------------------------+
 | **Project**               | MultiCloud                                      |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+
 | **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                                         |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+


 New features
 ------------

 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-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-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-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
 ------------

 Software Deliverables
 ~~~~~~~~~~~~~~~~~~~~~


 Documentation Deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~


 Known Limitations, Issues and Workarounds
 =========================================

 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.

 The MULTICLOUD open Critical security vulnerabilities and their risk
 assessment have been documented as part of the
 `project
 <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_.

 Workarounds
 -----------

 N/A

 Security Notes
 --------------

 **Fixed Security Issues**

 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**


 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
 ============

 N/A

 References
 ==========

 For more information on the ONAP ``jakarta`` release, please see:

 #. `ONAP Home Page`_
 #. `ONAP Documentation`_
 #. `ONAP Release Downloads`_
 #. `ONAP Wiki Page`_


 .. _`ONAP Home Page`: https://www.onap.org
 .. _`ONAP Wiki Page`: https://wiki.onap.org
 .. _`ONAP Documentation`: https://docs.onap.org
 .. _`ONAP Release Downloads`: https://git.onap.org


 Quick Links
 ===========

   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_

   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_

   - `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>`_
	.. This work is licensed under a Creative Commons Attribution 4.0
	International License.
	.. http://creativecommons.org/licenses/by/4.0
	.. (c) ONAP Project and its contributors
	.. _release_notes:

	************************
	MultiCloud Release Notes
	************************

	Abstract
	========

	This document provides the release notes for the ``jakarta`` release.

	Summary
	=======


	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
	============

	+---------------------------+-------------------------------------------------+
	\| Project \| MultiCloud \|
	\| \| \|
	+---------------------------+-------------------------------------------------+
	\| 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 \|
	\| \| \|
	+---------------------------+-------------------------------------------------+


	New features
	------------

	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-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-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-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
	------------

	Software Deliverables
	~~~~~~~~~~~~~~~~~~~~~


	Documentation Deliverables
	~~~~~~~~~~~~~~~~~~~~~~~~~~


	Known Limitations, Issues and Workarounds
	=========================================

	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.

	The MULTICLOUD open Critical security vulnerabilities and their risk
	assessment have been documented as part of the
	`project
	<https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_.

	Workarounds
	-----------

	N/A

	Security Notes
	--------------

	Fixed Security Issues

	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


	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
	============

	N/A

	References
	==========

	For more information on the ONAP ``jakarta`` release, please see:

	#. `ONAP Home Page`_
	#. `ONAP Documentation`_
	#. `ONAP Release Downloads`_
	#. `ONAP Wiki Page`_


	.. _`ONAP Home Page`: https://www.onap.org
	.. _`ONAP Wiki Page`: https://wiki.onap.org
	.. _`ONAP Documentation`: https://docs.onap.org
	.. _`ONAP Release Downloads`: https://git.onap.org


	Quick Links
	===========

	- `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_

	- `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_

	- `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>`_