Bump VID master version to 7.0.0 (Guilin)
[vid.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. _release_notes:
3
4 VID Release Notes
5 =================
6
7 Version: Frankfurt (6.0.x)
8 ------------------------
9 **Known Issues**
10
11
12 **Resolved Issues**
13
14   - `<https://jira.onap.org/browse/VID-365>`__ Upgrade AAI version to v16
15   - `<https://jira.onap.org/browse/VID-479>`__ VID Does not refresh after Add VF Module fails
16   - `<https://jira.onap.org/browse/VID-659>`__ VID generates always the same VF module name during scale out
17   - `<https://jira.onap.org/browse/VID-773>`__ SDNC Preload URL updated to https
18
19   - `<https://jira.onap.org/browse/VID-755>`__ Upgrade direct dependent packages to the latest version
20   - `<https://jira.onap.org/browse/VID-498>`__ Java 11 migration from JDK 8
21   - `<https://jira.onap.org/browse/VID-471>`__ Update to Portal SDK v2.6
22
23
24 **Security Notes**
25
26 *Fixed Security Issues*
27
28 *Known Security Issues*
29
30
31
32 Version: Guilin (7.0.x)
33 ------------------------
34 **Known Issues**
35
36
37 **Resolved Issues**
38
39
40 **Security Notes**
41
42 *Fixed Security Issues*
43
44 *Known Security Issues*
45
46
47
48 Version: El-Alto (5.0.x)
49 ------------------------
50 **Known Issues**
51
52   - `<https://jira.onap.org/browse/VID-659>`__ VID generates always the same VF module name during scale out
53
54 **Resolved Issues**
55
56   - `<https://jira.onap.org/browse/VID-520>`__ Remove "Dissociate" button for Macro-orchestrated PNF resources
57   - `<https://jira.onap.org/browse/VID-517>`__ Added liquidBase for follow changes in DB
58   - `<https://jira.onap.org/browse/VID-488>`__ Added "Report" popup for common diagnosable cases
59   - `<https://jira.onap.org/browse/VID-358>`__ vid-mariadb-galera runs in high-availability mode
60
61
62 **Security Notes**
63
64 *Fixed Security Issues*
65
66   - `<https://jira.onap.org/browse/OJSI-119>`__ Closed plain-text HTTP endpoint, port 30238
67
68 *Known Security Issues*
69
70
71
72
73 Version: 4.3.2
74 --------------
75
76 **Resolved Issues**
77
78 Reverted the soft-delete feature, to resolve this:
79   - `VID-503 <https://jira.onap.org/browse/VID-503>`_ Delete VF module does not trigger any action
80
81
82 Version: 4.3.0
83 --------------
84
85 :Release Date: 2019-05-25
86
87 New Features
88 ------------
89
90 -  [`VID-246`_] - *Centralized Representation and Consistent ID of Cloud Regions*
91 -  [`VID-397`_] - *Change Management - Flexible Designer & Orchestrator*: Utilize SO as a repository of workflows, instead of VID's workflows' configuration
92
93 .. _VID-246: /browse/VID-246
94 .. _VID-397: /browse/VID-397
95
96 **Security Notes**
97
98 *Fixed Security Issues*
99
100 *Known Security Issues*
101
102 - In default deployment VID (vid) exposes HTTP port 30238 outside of cluster. [`OJSI-119 <https://jira.onap.org/browse/OJSI-119>`_]
103
104 *Known Vulnerabilities in Used Modules*
105
106 Version: 3.2.3
107 --------------
108
109 :Release Date: 2019-03-28
110
111 **Notes**
112
113 It's v3.2.2, but repackaged with a new certificate valid until March 12, 2020.
114
115 **Resolved Issues**
116
117 VID certificates have been renewed to extend their expiry dates
118   - `VID-446 <https://jira.onap.org/browse/VID-446>`_ Fix Certificate Expiry.
119
120
121 Version: 3.2.2
122 --------------
123
124 :Release Date: 2018-11-30
125
126 New Features
127 ------------
128 1. PNF plug & play services instantiation.
129 2. HTTPS support.
130 3. Manual vNF Scale Out enhancements.
131
132 **Epics**
133
134 -  [`VID-159`_] - AAF integration
135 -  [`VID-194`_] - PNF Use case support
136 -  [`VID-248`_] - Support scaling use case
137 -  [`VID-254`_] - Usability
138 -  [`VID-258`_] - Security
139
140 .. _VID-159: /browse/VID-159
141 .. _VID-194: /browse/VID-194
142 .. _VID-248: /browse/VID-248
143 .. _VID-254: /browse/VID-254
144 .. _VID-258: /browse/VID-258
145
146 **Stories**
147
148 -  [`VID-166`_] - Improve CSIT coverage
149 -  [`VID-203`_] - PNF Plug & Play use case with vCPE flow
150 -  [`VID-236`_] - Align OOM templates
151 -  [`VID-249`_] - Change Manual Scaling Use Case to use the same SO API that Policy is using in Auto Scaling
152 -  [`VID-250`_] - Remove Controller Type from the VID GUI and from the request sent to SO
153 -  [`VID-256`_] - Add tutorials/user guides
154 -  [`VID-257`_] - AAF integration
155 -  [`VID-260`_] - Use HTTPS for external interfaces
156 -  [`VID-261`_] - Use HTTPS for internal interfaces
157
158 .. _VID-166: /browse/VID-166
159 .. _VID-203: /browse/VID-203
160 .. _VID-236: /browse/VID-236
161 .. _VID-249: /browse/VID-249
162 .. _VID-250: /browse/VID-250
163 .. _VID-256: /browse/VID-256
164 .. _VID-257: /browse/VID-257
165 .. _VID-260: /browse/VID-260
166 .. _VID-261: /browse/VID-261
167
168 **Security Notes**
169
170 VID 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 VID open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45300871>`_.
171
172 Quick Links:
173
174 - `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`__
175 - `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`__
176 - `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=45300871>`__
177
178 **Other**
179
180 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
181
182 Version: 2.0.0
183 --------------
184
185 :Release Date: 2018-06-07
186
187 New Features
188 ------------
189 1. VoLTE E2E services instantiation.
190 2. Change Management - invoking vNF In-Place SW Update without a scheduler.
191 3. Manual vNF Scale Out.
192
193 **Epics**
194
195 -  [`VID-101`_] - Port Mirroring
196 -  [`VID-106`_] - Cancel "Pending" workflows
197 -  [`VID-110`_] - Owning Entity
198 -  [`VID-114`_] - Preload Automation
199 -  [`VID-116`_] - Tenant Isolation
200 -  [`VID-120`_] - Active/Deactivate service type transport
201 -  [`VID-124`_] - Agnostic vNF In-Place SW Update
202 -  [`VID-127`_] - Agnostic vNF Configuration Update
203 -  [`VID-131`_] - Port mirroring - pProbe configuration
204 -  [`VID-136`_] - Support for pProbes
205 -  [`VID-139`_] - Refactor Scheduler
206 -  [`VID-148`_] - Non-Functional requirements - Resiliency
207 -  [`VID-154`_] - Non-Functional requirements - Stability
208 -  [`VID-157`_] - Non-Functional requirements - Performance
209 -  [`VID-158`_] - Non-Functional requirements - Usability
210 -  [`VID-160`_] - Non-Functional requirements - Scalability
211 -  [`VID-161`_] - Non-Functional requirements - Security (CII passing badge + 50% test coverage)
212 -  [`VID-162`_] - OOM integration
213 -  [`VID-179`_] - Change management - working without scheduler
214 -  [`VID-180`_] - Support manual scale out
215 -  [`VID-192`_] - Verify features merged from ECOMP 1802
216
217 .. _VID-101: https://jira.onap.org/browse/VID-101
218 .. _VID-106: https://jira.onap.org/browse/VID-106
219 .. _VID-110: https://jira.onap.org/browse/VID-110
220 .. _VID-114: https://jira.onap.org/browse/VID-114
221 .. _VID-116: https://jira.onap.org/browse/VID-116
222 .. _VID-120: https://jira.onap.org/browse/VID-120
223 .. _VID-124: https://jira.onap.org/browse/VID-124
224 .. _VID-127: https://jira.onap.org/browse/VID-127
225 .. _VID-131: https://jira.onap.org/browse/VID-131
226 .. _VID-136: https://jira.onap.org/browse/VID-136
227 .. _VID-139: https://jira.onap.org/browse/VID-139
228 .. _VID-148: https://jira.onap.org/browse/VID-148
229 .. _VID-154: https://jira.onap.org/browse/VID-154
230 .. _VID-157: https://jira.onap.org/browse/VID-157
231 .. _VID-158: https://jira.onap.org/browse/VID-158
232 .. _VID-160: https://jira.onap.org/browse/VID-160
233 .. _VID-161: https://jira.onap.org/browse/VID-161
234 .. _VID-162: https://jira.onap.org/browse/VID-162
235 .. _VID-179: https://jira.onap.org/browse/VID-179
236 .. _VID-180: https://jira.onap.org/browse/VID-180
237 .. _VID-192: https://jira.onap.org/browse/VID-192
238
239 **Stories**
240
241 -  [`VID-16`_] - Replace any remaining openecomp reference by onap
242 -  [`VID-86`_] - Migrate to org.onap
243 -  [`VID-102`_] - Create "Port mirror" configuration - Attach Source & collector VNFs
244 -  [`VID-103`_] - Create "Port mirror" configuration - General Required Fields
245 -  [`VID-104`_] - Configuration supporting actions
246 -  [`VID-105`_] - Create "Port mirror" configuration - Get model information
247 -  [`VID-107`_] - 3rd party simulator
248 -  [`VID-108`_] - Cancel Scheduled workflows
249 -  [`VID-109`_] - Change information of columns in the "Pending" section of the "dashboard"
250 -  [`VID-111`_] - New properties logic
251 -  [`VID-112`_] - Filter service instance by new properties
252 -  [`VID-113`_] - Implement new properties & their values
253 -  [`VID-115`_] - Resume VF- module (after pause)
254 -  [`VID-117`_] - Create Application ENV
255 -  [`VID-118`_] - Deploy Services on VID operational
256 -  [`VID-119`_] - Activate/Deactivate Application ENV
257 -  [`VID-121`_] - Deactivate a Transport service logic
258 -  [`VID-122`_] - Service Instance Deactivate - API MSO
259 -  [`VID-123`_] - "Activate" avilable only for service instance from type= transport
260 -  [`VID-125`_] - VNF In Place Software Update API - MSO
261 -  [`VID-126`_] - Support new workflow "Agnostic vNF In-Place SW Update"
262 -  [`VID-128`_] - Support workflow "vnf Config Update"
263 -  [`VID-129`_] - Rules For Converting Payload Spreadsheet To JSON
264 -  [`VID-130`_] - VNF Config Update - API MSO
265 -  [`VID-132`_] - Get pnf-fromModel-byRegion - A&AI API
266 -  [`VID-133`_] - pProbe config create request - MSO API
267 -  [`VID-134`_] - Associate PNF instance to port mirroring configuration by policy
268 -  [`VID-135`_] - Get Port Mirroring Configuration By Policy Node type
269 -  [`VID-137`_] - Associate PNF instance to service instance
270 -  [`VID-138`_] - Disassociate PNF instance from service instance
271 -  [`VID-140`_] - New function to support Scheduler in widget
272 -  [`VID-151`_] - ONAP Support
273 -  [`VID-174`_] - Change management: bypassing scheduler for immediate operations
274 -  [`VID-185`_] - UI changes for working without scheduler
275 -  [`VID-186`_] - docker alignment analyzes
276 -  [`VID-188`_] - UI for Scale Out workflow
277 -  [`VID-189`_] - VoLTE use case support
278 -  [`VID-191`_] - Changes to API to SO for Manual scale out use case
279 -  [`VID-197`_] - Reach 50% unit test coverage
280 -  [`VID-201`_] - User inteface for invoking upgrade workflow
281 -  [`VID-202`_] - Verify R1 and R2 features - integration and regression tests
282 -  [`VID-216`_] - Update ReadTheDocs docs folder
283
284 .. _VID-16: https://jira.onap.org/browse/VID-16
285 .. _VID-86: https://jira.onap.org/browse/VID-86
286 .. _VID-102: https://jira.onap.org/browse/VID-102
287 .. _VID-103: https://jira.onap.org/browse/VID-103
288 .. _VID-104: https://jira.onap.org/browse/VID-104
289 .. _VID-105: https://jira.onap.org/browse/VID-105
290 .. _VID-107: https://jira.onap.org/browse/VID-107
291 .. _VID-108: https://jira.onap.org/browse/VID-108
292 .. _VID-109: https://jira.onap.org/browse/VID-109
293 .. _VID-111: https://jira.onap.org/browse/VID-111
294 .. _VID-112: https://jira.onap.org/browse/VID-112
295 .. _VID-113: https://jira.onap.org/browse/VID-113
296 .. _VID-115: https://jira.onap.org/browse/VID-115
297 .. _VID-117: https://jira.onap.org/browse/VID-117
298 .. _VID-118: https://jira.onap.org/browse/VID-118
299 .. _VID-119: https://jira.onap.org/browse/VID-119
300 .. _VID-121: https://jira.onap.org/browse/VID-121
301 .. _VID-122: https://jira.onap.org/browse/VID-122
302 .. _VID-123: https://jira.onap.org/browse/VID-123
303 .. _VID-125: https://jira.onap.org/browse/VID-125
304 .. _VID-126: https://jira.onap.org/browse/VID-126
305 .. _VID-128: https://jira.onap.org/browse/VID-128
306 .. _VID-129: https://jira.onap.org/browse/VID-129
307 .. _VID-130: https://jira.onap.org/browse/VID-130
308 .. _VID-132: https://jira.onap.org/browse/VID-132
309 .. _VID-133: https://jira.onap.org/browse/VID-133
310 .. _VID-134: https://jira.onap.org/browse/VID-134
311 .. _VID-135: https://jira.onap.org/browse/VID-135
312 .. _VID-137: https://jira.onap.org/browse/VID-137
313 .. _VID-138: https://jira.onap.org/browse/VID-138
314 .. _VID-140: https://jira.onap.org/browse/VID-140
315 .. _VID-151: https://jira.onap.org/browse/VID-151
316 .. _VID-174: https://jira.onap.org/browse/VID-174
317 .. _VID-185: https://jira.onap.org/browse/VID-185
318 .. _VID-186: https://jira.onap.org/browse/VID-186
319 .. _VID-188: https://jira.onap.org/browse/VID-188
320 .. _VID-189: https://jira.onap.org/browse/VID-189
321 .. _VID-191: https://jira.onap.org/browse/VID-191
322 .. _VID-197: https://jira.onap.org/browse/VID-197
323 .. _VID-201: https://jira.onap.org/browse/VID-201
324 .. _VID-202: https://jira.onap.org/browse/VID-202
325 .. _VID-216: https://jira.onap.org/browse/VID-216
326
327 **Security Notes**
328
329 VID 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 VID open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`__.
330
331 Quick Links:
332
333 - `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`_
334 - `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`_
335 - `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_
336
337 **Other**
338
339 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
340
341 Version: 1.1.1
342 --------------
343
344 :Release Date: 2017-11-16
345
346 New Features
347 ------------
348
349 1. Improved TOSCA parser.
350 2. Change Management - Provides the Operators a single tool for installing and maintaining the services as a self service activity. Provides the ability to schedule and execute change management workflows, Maintenance activities for vNFs that are already installed .
351 3. PNF Instantiation - PNFs are already installed on the edges of the cloud. In order to configure the PNF, the service needs to be connected to the PNF.
352
353 **Epics**
354
355 -  [`VID-25`_] - Role management: Global Read only role
356 -  [`VID-26`_] - Role management: Support VID specific Roles
357 -  [`VID-27`_] - Change management: Schedule workflow
358 -  [`VID-28`_] - Change management: Status of workflow
359 -  [`VID-29`_] - Change management: Manual intervention
360 -  [`VID-30`_] - PNF instantiation: Trigger PNF service information to SO
361 -  [`VID-31`_] - PNF Instantiation: support service type PNF & display new fields
362
363 .. _VID-25: https://jira.onap.org/browse/VID-25
364 .. _VID-26: https://jira.onap.org/browse/VID-26
365 .. _VID-27: https://jira.onap.org/browse/VID-27
366 .. _VID-28: https://jira.onap.org/browse/VID-28
367 .. _VID-29: https://jira.onap.org/browse/VID-29
368 .. _VID-30: https://jira.onap.org/browse/VID-30
369 .. _VID-31: https://jira.onap.org/browse/VID-31
370
371 **Stories**
372
373 -  [`VID-44`_] - Implement change management phase 1
374 -  [`VID-48`_] - Change management: Schedule workflow
375 -  [`VID-49`_] - Change management: Status of workflow
376 -  [`VID-50`_] - Change management: Manual intervention
377 -  [`VID-51`_] - Trigger PNF service information to MSO
378 -  [`VID-52`_] - support service type PNF & display new fields
379
380 .. _VID-44: https://jira.onap.org/browse/VID-44
381 .. _VID-48: https://jira.onap.org/browse/VID-48
382 .. _VID-49: https://jira.onap.org/browse/VID-49
383 .. _VID-50: https://jira.onap.org/browse/VID-50
384 .. _VID-51: https://jira.onap.org/browse/VID-51
385 .. _VID-52: https://jira.onap.org/browse/VID-52
386
387
388 Bug Fixes
389 ----------
390
391 -  [`VID-20`_] - Failed to get service models from ASDC in VID
392 -  [`VID-59`_] - VID Fails Robot Health Check
393 -  [`VID-62`_] - VID healthcheck failure in RS ORD ONAP 1.1.0
394 -  [`VID-64`_] - Got 500 from role/user API call
395 -  [`VID-79`_] - Not able to create service instance using VID portal
396 -  [`VID-82`_] - Create VF module with SDNC preload is throwing
397    exception
398
399 .. _VID-20: https://jira.onap.org/browse/VID-20
400 .. _VID-59: https://jira.onap.org/browse/VID-59
401 .. _VID-62: https://jira.onap.org/browse/VID-62
402 .. _VID-64: https://jira.onap.org/browse/VID-64
403 .. _VID-79: https://jira.onap.org/browse/VID-79
404 .. _VID-82: https://jira.onap.org/browse/VID-82
405
406
407 **Known Issues**
408
409 - `VID-78 <https://jira.onap.org/browse/VID-78>`_ VID shows the HTML code output whenever the customer list is empty (Cosmetic)
410
411 **Upgrade Notes**
412
413 A scheduler is needed for the change management feature to work (not included in the Amsterdam release).
414
415 **Other**
416
417 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
418
419 End of Release Notes