Merge "Refactor the rst"
[multicloud/framework.git] / docs / Release Notes.rst
1 ..
2  This work is licensed under a Creative Commons Attribution 4.0
3  International License.
4
5 =============
6 Release Notes
7 =============
8
9
10 Version: 3.0.0 (Casablanca Release)
11 -----------------------------------
12
13 :Release Date: 2018-11-30
14
15 **New Features**
16
17 * Enriched the documentaton with Architecture descriptions
18 * Verified the supports to end to end vCPE TOSCA VNF use case
19 * Upgraded to Northbound API v1 to support `Consistent ID of a Cloud Region`
20 * Added new Generic API to offload Infrastructure's workload LCM from SO to
21   MutliCloud
22 * Updated the plugin for Wind River to support Titanium Cloud R5
23 * Updated the plugin for VIO to support VIO 5.0
24 * Added a plugin to support OpenStack Pike
25 * Released Azure's plugin seed code
26 * Released Kubernetes' plugin seed code
27
28
29 **The MultiCloud services consists of following components:**
30
31 **MultiCloud Broker (version: 1.2.2)**
32
33 * Added plugin type for azure and pike
34 * Added API v1 to align to `Consistent ID of a Cloud Region`
35 * Added API infra_workload to enable SO and MultiCloud Integration
36
37 **MultiCloud Plugin for Wind River Titanium Cloud (version: 1.2.2)**
38
39 * Expanded the HPA discovery and registration to cover SR-IOV NICs.
40 * Decoupled AAI's cloud-region-id from OpenStack Region ID
41 * Automated the on-boarding multiple OpenStack instances leveraging OpenStack
42   multi-region feature.
43 * Enabled the on-boarding of subclouds of Titanium Cloud in Distributed Cloud
44   Mode
45 * Automated the decommission of a Cloud Region
46 * Automated the updating AAI with heat stack resources
47 * Enabled Server Operations API for Auto-Healing
48 * Cached the AAI cloud region data to improve the API handling performance
49 * Passed the vCPE TOSCA VNF use case with several critical issues fixed
50 * Fixed the keystone v2.0 endpoint issue
51
52 **MultiCloud Plugin for OpenStack (version: 1.2.2)**
53
54 * Expanded the HPA discovery and registration to cover SR-IOV NICs.
55 * Decoupled AAI's cloud-region-id from OpenStack Region ID
56 * Enabled Server Operations API for Auto-Healing
57 * Cached the AAI cloud region data to improve the API handling performance
58 * Passed the vCPE TOSCA VNF use case with several critical issues fixed
59 * Fixed the keystone v2.0 endpoint issue
60
61
62 **MultiCloud Plugin for VIO (version 1.2.2)**
63
64 * Expanded the HPA discovery and registration to cover SR-IOV NICs.
65 * Decoupled AAI's cloud-region-id from OpenStack Region ID
66 * Automated the on-boarding multiple OpenStack instances leveraging OpenStack
67   multi-region feature.
68 * Automated the decommission of a Cloud Region
69 * Supported Cloud Agnostic Placement Policies in VIO plugin
70 * Enabled Server Operations API for Auto-Healing
71 * Enabled marker support on logging
72
73
74 **MultiCloud Plugin for Azure (version 1.2.2)**
75
76 * Released inital seed code
77 * Enabled flavor discovery during on-boarding of azure cloud
78 * Supported for OOB vFW and vDNS use cases using the plugin
79
80 **MultiCloud Plugin for Kubernetes (version: N/A)**
81
82 * Released initial seed code
83 * Supported Service, Deployment and Namespace Kubernetes objects for this
84   initial phase
85 * Provided functional tests for ensuring its correct operation using an
86   emulated ONAP interaction
87 * Included a vagrant project for provisioning a Kubernetes deployment
88
89
90 **Bug Fixes**
91
92 - `MULTICLOUD-253 <https://jira.onap.org/browse/MULTICLOUD-253>`_
93   OPENO servers API: meta_data is generated in wrong type
94
95 - `MULTICLOUD-386 <https://jira.onap.org/browse/MULTICLOUD-386>`_
96   OPENO identity API: identity API cannot work with keystone endpoint v2.0
97
98 - `MULTICLOUD-390 <https://jira.onap.org/browse/MULTICLOUD-390>`_
99   OPENO servers API: pass userdata without contextArray, then "user_data"
100   is not being passed to nova instance API.
101
102 **Known Issues**
103
104 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
105   OPENO images API: image creating API cannot handle large image file
106
107 - `MULTICLOUD-389 <https://jira.onap.org/browse/MULTICLOUD-389>`_
108   OPENO servers API: keypair cannot be passed for nova instance creation
109
110 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
111   API request to multicloud with authorization header will be rejected
112
113
114
115 **Security Notes**
116
117 MULTICLOUD code has been formally scanned during build time using NexusIQ and
118 all Critical vulnerabilities have been addressed, items that remain open have
119 been assessed for risk and determined to be false positive.
120
121 The MULTICLOUD open Critical security vulnerabilities and their risk
122 assessment have been documented as part of the
123 `project <https://wiki.onap.org/pages/viewpage.action?pageId=43386067>`_.
124
125
126 Quick Links:
127   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
128
129   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
130   
131   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/pages/viewpage.action?pageId=43386067>`_
132
133 **Upgrade Notes**
134
135 None
136
137 **Deprecation Notes**
138
139 * The maintainance with regarding to MultiCloud plugin for OpenStack Newton
140   has been stopped from Casablanca Release.
141
142 **Other**
143
144 None
145
146
147 Version: 2.0.0 (Beijing Release)
148 --------------------------------
149
150 :Release Date: 2018-06-07
151
152
153 **New Features**
154
155 * Allow to check capacity capability for smart VNF placement across VIMs.
156 * Declarative template driven framework to generate API dynamically.
157 * Federate the events of VIM layer with ONAP message bus which provide direct
158   help to HA fencing and improve the
159   efficiency of VM recover with performance verification.
160 * Enable basic HPA discovery and representing at Multi VIM/Cloud when registry.
161 * Enable distributed log collection mechanism to a centralized logging
162   analysis system.
163 * Improve parallelism of Multi VIM/Cloud service framework with performance
164   verification.
165 * Upload and download images based on Cloud storage capabilities to support
166   remote image distribution requirement.
167
168 **Bug Fixes**
169
170 - `MULTICLOUD-225 <https://jira.onap.org/browse/MULTICLOUD-225>`_
171   Allow to forward header properties through Multi VIM/Cloud framework
172
173 - `MULTICLOUD-221 <https://jira.onap.org/browse/MULTICLOUD-221>`_
174   Fix VESAgent health check flow
175
176 - `MULTICLOUD-220 <https://jira.onap.org/browse/MULTICLOUD-220>`_
177   Fix Multi VIM/Cloud plugins to enable ID binding with each request.
178
179
180 **Known Issues**
181
182 - `MULTICLOUD-242 <https://jira.onap.org/browse/MULTICLOUD-242>`_
183   One known issue is that the Ocata image is not put into the consistent place
184   as R1 and please attention to the
185   download path when you choose manual installation of Ocata plugin from the
186   image pool.
187
188 **Security Notes**
189
190 MULTICLOUD code has been formally scanned during build time using NexusIQ and
191 no Critical vulnerability were found.
192
193 Quick Links:
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 **Upgrade Notes**
199
200 None
201
202 **Deprecation Notes**
203
204 None
205
206 **Other**
207
208 None
209
210 Version: 1.0.0 (Amsterdam Release)
211 ----------------------------------
212
213 :Release Date: 2017-11-16
214
215
216 **New Features**
217
218 * Keystone proxy for convenient integration with modules which depend on
219   original OpenStack functions
220 * Multiple VIM registry and unregister
221 * Resources LCM functions
222 * Auto-deployment support to both K8s and heat
223 * Hierarchical binding based integration with the third party SDN controller
224 * Basic Fcaps alert collection support, VM abnormal status is thrown out as
225   an example
226 * Fake cloud based Unit and system test framework
227 * Complete code coverage detection, CSIT, and document framework
228 * Provide several plugins of different backbends, including: Vanilla OpenStack
229   (based on Ocata) and commercial Clouds including OpenStack (including
230   Titanium - Mitaka from Wind River and VIO - Ocata from VMware)
231
232 **Bug Fixes**
233
234 - `MULTICLOUD-123 <https://jira.onap.org/browse/MULTICLOUD-123>`_
235   Append v3 to keystone url by default, if keystone version is missing.
236
237 - `MULTICLOUD-102 <https://jira.onap.org/browse/MULTICLOUD-102>`_
238   Throw exception in Multi Cloud when backend OpenStack throw exceptions.
239
240 - `MULTICLOUD-101 <https://jira.onap.org/browse/MULTICLOUD-101>`_
241   Fix failed to add image info to AAI if image name didn't contain '-'.
242
243
244 **Known Issues**
245
246 None
247
248 **Security Issues**
249
250 None
251
252 **Upgrade Notes**
253
254 None
255
256 **Deprecation Notes**
257
258 None
259
260 **Other**
261
262 None
263
264 ===========
265
266 End of Release Notes