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