Updated releast notes for transitive dependency on multicloud log4j
[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 ``istanbul`` release.
15
16 Summary
17 =======
18
19
20 Version: 9.0.1
21 --------------
22
23 The ``istanbul`` maintenance release addresses some vulnerabilities mainly
24 for the log4j dependencies.
25
26 - Updated the direct dependency log4j libraries to 2.14.1
27 - Please note log4j is still on older versions in a transitive dependencies for
28   * onap/multicloud-framework-artifactbroker:1.7.2
29
30
31 Version: 9.0.0
32 --------------
33
34 This release introduces new features in k8splugin, including many bug-fixes bringing better compatibility with Helm 3.5 specification.
35
36 Release Data
37 ============
38
39 +---------------------------+-------------------------------------------------+
40 | **Project**               | MultiCloud                                      |
41 |                           |                                                 |
42 +---------------------------+-------------------------------------------------+
43 | **Docker images**         | onap/multicloud-framework:1.7.1                 |
44 |                           | onap/multicloud-framework-artifactbroker:1.7.1  |
45 |                           | onap/multicloud-openstack-starlingx:1.5.6       |
46 |                           | onap/multicloud-openstack-windriver:1.5.6       |
47 |                           | onap/multicloud-openstack-fcaps:1.5.6           |
48 |                           | onap/multicloud-openstack-pike:1.5.6            |
49 |                           | onap/multicloud-k8s:0.9.3                       |
50 +---------------------------+-------------------------------------------------+
51 | **Release designation**   | istanbul                                        |
52 |                           |                                                 |
53 +---------------------------+-------------------------------------------------+
54
55
56 New features
57 ------------
58
59 New features in k8s Plugin related with CNF support implemented by *REQ-627*:
60
61 - Implement Query API on the main level to let reading the k8s resources for specified cluster and namespace but not related with particular Instance
62 - Implement pre- and post-install/delete hooks
63 - Modify Instance API POST Response to include hook information
64 - Update Ready flag in Status API to indicate the real status of the Instance
65 - Update Status API and Instance API GET to return hook information but only when additional query param is specified
66
67 - `<https://jira.onap.org/browse/MULTICLOUD-1345>`_
68 - `<https://jira.onap.org/browse/REQ-627>`_
69
70 **Bug fixes**
71
72 - `MULTICLOUD-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
73   MultiCloud k8s: K8s Plugins keeps failed RB Instance
74
75 - `MULTICLOUD-1332 <https://jira.onap.org/browse/MULTICLOUD-1332>`_
76   MultiCloud k8s: k8s resource from configuration are not being deleted with instance
77
78 - `MULTICLOUD-1334 <https://jira.onap.org/browse/MULTICLOUD-1334>`_
79   MultiCloud framework: Update or Remove Java 8
80
81 - `MULTICLOUD-1338 <https://jira.onap.org/browse/MULTICLOUD-1338>`_
82   MultiCloud k8s: Foreground delete policy prevents deletion of the pods
83
84 - `MULTICLOUD-1377 <https://jira.onap.org/browse/MULTICLOUD-1377>`_
85   MultiCloud k8s: Wrong parameter used for creation of rb-definition-version
86
87 - `MULTICLOUD-1397 <https://jira.onap.org/browse/MULTICLOUD-1397>`_
88   MultiCloud k8s: CRD installation problem
89
90 - `MULTICLOUD-1398 <https://jira.onap.org/browse/MULTICLOUD-1398>`_
91   MultiCloud k8s: K8s Resource Delete order the same like for installation
92
93 - `MULTICLOUD-1409 <https://jira.onap.org/browse/MULTICLOUD-1409>`_
94   MultiCloud k8s: Query API for Instance returns resources that do not belong to Instance
95
96 - `MULTICLOUD-1414 <https://jira.onap.org/browse/MULTICLOUD-1414>`_
97   MultiCloud k8s: Config API takes values only from Config create request
98
99 **Known Issues**
100
101 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
102   MultiCloud OpenStack: image creating API cannot handle large image file
103
104 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
105   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
106
107 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
108   MultiCloud k8s: move to sigs yaml from ghodss
109
110 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
111   MultiCloud k8s: Query API returns 500 instead of 404
112
113 - `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
114   MultiCloud k8s: Redundant data in MongoDB created
115
116 - `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
117   MultiCloud k8s: Consul operation interface problems
118
119 - `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
120   MultiCloud k8s: Instance status update failure
121
122 Deliverables
123 ------------
124
125 Software Deliverables
126 ~~~~~~~~~~~~~~~~~~~~~
127
128
129 Documentation Deliverables
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~
131
132
133 Known Limitations, Issues and Workarounds
134 =========================================
135
136 System Limitations
137 ------------------
138
139 N/A
140
141 Known Vulnerabilities
142 ---------------------
143
144 MULTICLOUD code has been formally scanned during build time using NexusIQ and
145 all Critical vulnerabilities have been addressed, items that remain open have
146 been assessed for risk and determined to be false positive.
147
148 The MULTICLOUD open Critical security vulnerabilities and their risk
149 assessment have been documented as part of the
150 `project
151 <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_.
152
153 Workarounds
154 -----------
155
156 N/A
157
158 Security Notes
159 --------------
160
161 **Fixed Security Issues**
162
163 CVE issue pertained to multicloud-openstack components reported
164 by https://wiki.onap.org/display/SV/Istanbul+Multicloud
165 has been fixed by upgrading dependencies
166
167 CVE issue pertained to multicloud-framework components reported
168 by https://wiki.onap.org/display/SV/Istanbul+Multicloud
169 has been fixed by upgrading dependencies
170
171 **Known Security Issues**
172
173
174 Fixing of CVE issue pertained to multicloud-framework-artifactbroker components
175 reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
176 is an ongoing effort
177
178
179 Fixing of CVE issue pertained to multicloud-openstack-vmware components
180 reported by https://wiki.onap.org/display/SV/Istanbul+Multicloud
181 will not be fixed due to lack of commitment from community
182
183
184 Test Results
185 ============
186
187 N/A
188
189 References
190 ==========
191
192 For more information on the ONAP ``istanbul`` release, please see:
193
194 #. `ONAP Home Page`_
195 #. `ONAP Documentation`_
196 #. `ONAP Release Downloads`_
197 #. `ONAP Wiki Page`_
198
199
200 .. _`ONAP Home Page`: https://www.onap.org
201 .. _`ONAP Wiki Page`: https://wiki.onap.org
202 .. _`ONAP Documentation`: https://docs.onap.org
203 .. _`ONAP Release Downloads`: https://git.onap.org
204
205
206 Quick Links
207 ===========
208
209   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
210
211   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
212
213   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/display/SV/Istanbul+Multicloud>`_
214
215   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_