Release note for jakarta release
[multicloud/framework.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2    International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) ONAP Project and its contributors
5 .. _release_notes:
6
7 ************************
8 MultiCloud Release Notes
9 ************************
10
11 Abstract
12 ========
13
14 This document provides the release notes for the ``jakarta`` release.
15
16 Summary
17 =======
18
19
20 Version: 10.0.0
21 --------------
22
23 The ``jakarta`` release introduces following enhancements in k8splugin.
24
25 - Better Configuration API support including rollback, improved deletion of the configuration with or without removal of the configuration resources in the cluster.
26 - 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.
27 - 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.
28
29 Release Data
30 ============
31
32 +---------------------------+-------------------------------------------------+
33 | **Project**               | MultiCloud                                      |
34 |                           |                                                 |
35 +---------------------------+-------------------------------------------------+
36 | **Docker images**         | onap/multicloud-framework:1.7.3                 |
37 |                           | onap/multicloud-framework-artifactbroker:1.7.3  |
38 |                           | onap/multicloud-openstack-starlingx:1.5.7       |
39 |                           | onap/multicloud-openstack-windriver:1.5.7       |
40 |                           | onap/multicloud-openstack-fcaps:1.5.7           |
41 |                           | onap/multicloud-openstack-pike:1.5.7            |
42 |                           | onap/multicloud-k8s:0.10.1                      |
43 +---------------------------+-------------------------------------------------+
44 | **Release designation**   | jakarta                                         |
45 |                           |                                                 |
46 +---------------------------+-------------------------------------------------+
47
48
49 New features
50 ------------
51
52 New features in k8s Plugin related with CNF support implemented by:
53
54 - `<https://jira.onap.org/browse/MULTICLOUD-1386>`_
55 - `<https://jira.onap.org/browse/REQ-890>`_
56
57 **Bug fixes**
58
59 - `MULTICLOUD-1468 <https://jira.onap.org/browse/MULTICLOUD-1468>`_
60   MultiCloud k8s: Etcd connection is not validated on k8splugin start
61
62 - `MULTICLOUD-1446 <https://jira.onap.org/browse/MULTICLOUD-1446>`_
63   Multicloud k8s: Multicloud K8S Plugin does not delete namespace during the SO delete CNF instance macro flow
64
65 - `MULTICLOUD-1443 <https://jira.onap.org/browse/MULTICLOUD-1443>`_
66   Multicloud k8s: Fix log4j cve
67
68 **Known Issues**
69
70 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
71   MultiCloud OpenStack: image creating API cannot handle large image file
72
73 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
74   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
75
76 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
77   MultiCloud k8s: move to sigs yaml from ghodss
78
79 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
80   MultiCloud k8s: Query API returns 500 instead of 404
81
82 - `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
83   MultiCloud k8s: Redundant data in MongoDB created
84
85 - `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
86   MultiCloud k8s: Consul operation interface problems
87
88 - `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
89   MultiCloud k8s: Instance status update failure
90
91 - `MULTICLOUD-1459 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
92   MultiCloud k8s: Multicloud-k8s dockers contain GPLv3
93
94 Deliverables
95 ------------
96
97 Software Deliverables
98 ~~~~~~~~~~~~~~~~~~~~~
99
100
101 Documentation Deliverables
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~
103
104
105 Known Limitations, Issues and Workarounds
106 =========================================
107
108 System Limitations
109 ------------------
110
111 N/A
112
113 Known Vulnerabilities
114 ---------------------
115
116 MULTICLOUD code has been formally scanned during build time using NexusIQ and
117 all Critical vulnerabilities have been addressed, items that remain open have
118 been assessed for risk and determined to be false positive.
119
120 The MULTICLOUD open Critical security vulnerabilities and their risk
121 assessment have been documented as part of the
122 `project
123 <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_.
124
125 Workarounds
126 -----------
127
128 N/A
129
130 Security Notes
131 --------------
132
133 **Fixed Security Issues**
134
135 CVE issue pertained to multicloud-openstack components reported
136 by https://wiki.onap.org/display/SV/Istanbul+Multicloud
137 has been fixed by upgrading dependencies
138
139 CVE issue pertained to multicloud-framework components reported
140 by https://wiki.onap.org/display/SV/Istanbul+Multicloud
141 has been fixed by upgrading dependencies
142
143 **Known Security Issues**
144
145
146 Fixing of CVE issue pertained to multicloud-framework-artifactbroker components
147 reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
148 is an ongoing effort
149
150
151 Fixing of CVE issue pertained to multicloud-openstack-vmware components
152 reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
153 will not be fixed due to lack of commitment from community
154
155
156 Test Results
157 ============
158
159 N/A
160
161 References
162 ==========
163
164 For more information on the ONAP ``jakarta`` release, please see:
165
166 #. `ONAP Home Page`_
167 #. `ONAP Documentation`_
168 #. `ONAP Release Downloads`_
169 #. `ONAP Wiki Page`_
170
171
172 .. _`ONAP Home Page`: https://www.onap.org
173 .. _`ONAP Wiki Page`: https://wiki.onap.org
174 .. _`ONAP Documentation`: https://docs.onap.org
175 .. _`ONAP Release Downloads`: https://git.onap.org
176
177
178 Quick Links
179 ===========
180
181   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
182
183   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
184
185   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_
186
187   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_