d60d08c857ab01c5cac030c7c0f72394a49fcc4f
[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: Honolulu (8.0.x)
8 ------------------------
9
10 :In a nutshell...:
11
12 The following areas have received improvements in Honolulu Release
13
14    * VID development (back-end for SO BB).
15      In R6/R7 SO BB were implemented for more streamlined processing of W/F. BPMN to BB. Completed in R7.
16      Modern UI for PNFs in VID was not rendering the models (empty UI). This is now built.
17      Introduced VNF GUI to fit the SO BB work using SO API from R7.
18
19      More details at: https://jira.onap.org/browse/REQ-430
20
21    * Place-Geolocation Development for PnP completed in VID:
22      Please see for more details  https://wiki.onap.org/display/DW/Proposed+Location+Model
23
24 *Security Issues*
25
26 This section is empty.
27
28 *Bug fixes*
29
30 This section is empty.
31
32 **Known Issues**
33
34 This section is empty.
35
36 **Resolved Issues**
37        https://jira.onap.org/browse/VID-890
38        https://jira.onap.org/browse/VID-902
39        https://jira.onap.org/browse/VID-917
40        https://jira.onap.org/browse/VID-922
41        https://jira.onap.org/browse/VID-694
42        https://jira.onap.org/browse/VID-921
43        https://jira.onap.org/browse/VID-924
44        https://jira.onap.org/browse/VID-925
45        https://jira.onap.org/browse/VID-695
46        https://jira.onap.org/browse/VID-927
47        https://jira.onap.org/browse/VID-928
48        https://jira.onap.org/browse/VID-903
49        https://jira.onap.org/browse/VID-943
50        https://jira.onap.org/browse/VID-944
51        https://jira.onap.org/browse/VID-945
52        https://jira.onap.org/browse/VID-970
53        https://jira.onap.org/browse/VID-679
54
55 **Security Notes**
56
57 *Fixed Security Issues*
58
59 This section is empty.
60
61 *Known Security Issues*
62
63 This section is empty.
64
65
66 Version: Guilin (7.0.x)
67 ------------------------
68
69 :In a nutshell...:
70
71
72 The following areas have received improvements in Guilin Release
73
74    Pause:
75       * Pause/Stop on Failures.
76       * Pause Point Addition on Edit window inside the drawing board.
77       * Pause Point removal feature.
78
79    Audit Info:
80       * Overhauling of the Audit Info screen popup.
81       * MSO Status table can now be exported and viewed as .csv files (in Excel and other type software)
82       * Audit Info page is also refreshable now. New status from MSO will arrive upon pressing the refresh button.
83           * More detailed info fetched from MSO now in Additional Info column, most recent request to be displayed at the top.
84
85    VF Module Sequencing and Base Module Related Rules:
86      * The sequence of VF Modules can now be changed by dragging up and down in the drawing board.
87      * A sequence number box is introduced bearing the current position of the VF Module in the the list.
88      * Various rules have been put in place for special check on the Base module in the drawing board.
89
90 *Security Issues*
91
92 This section is empty.
93
94 *Bug fixes*
95
96 This section is empty.
97
98 **Known Issues**
99
100 This section is empty.
101
102 **Resolved Issues**
103
104        https://jira.onap.org/browse/VID-862
105        https://jira.onap.org/browse/VID-902
106        https://jira.onap.org/browse/VID-889
107        https://jira.onap.org/browse/VID-875
108        https://jira.onap.org/browse/VID-861
109        https://jira.onap.org/browse/VID-860
110        https://jira.onap.org/browse/VID-858
111        https://jira.onap.org/browse/VID-890
112
113
114 **Security Notes**
115
116 *Fixed Security Issues*
117
118 This section is empty.
119
120
121 *Known Security Issues*
122
123 This section is empty.
124
125
126
127 Version: Frankfurt (6.0.x)
128 ------------------------
129
130 :In a nutshell...:
131
132     For an end-user VID is easier to use.
133
134     For a system admin, VID is easier to deploy and manage.
135
136     *Security*
137
138     - Adherence to ONAP Logging Spec v1.2
139     - Update to Portal SDK v2.6
140     - Use common secret template to generate DB credentials
141     - Java 11 migration from JDK 8
142     - And more...
143
144     *Bug fixes*
145
146     - Refresh after Add VF Module fails
147     - Generates different VF module name during scale out
148     - And many more...
149
150 **Known Issues**
151
152 This section is empty.
153
154
155 **Resolved Issues**
156
157   - `<https://jira.onap.org/browse/VID-365>`__ Upgrade AAI version to v16
158   - `<https://jira.onap.org/browse/VID-479>`__ VID Does not refresh after Add VF Module fails
159   - `<https://jira.onap.org/browse/VID-659>`__ VID generates always the same VF module name during scale out
160   - `<https://jira.onap.org/browse/VID-773>`__ SDNC Preload URL updated to https
161
162   - `<https://jira.onap.org/browse/VID-755>`__ Upgrade direct dependent packages to the latest version
163   - `<https://jira.onap.org/browse/VID-498>`__ Java 11 migration from JDK 8
164   - `<https://jira.onap.org/browse/VID-471>`__ Update to Portal SDK v2.6
165
166
167 **Security Notes**
168
169 *Fixed Security Issues*
170
171 This section is empty.
172
173
174 *Known Security Issues*
175
176 This section is empty.
177
178
179 Version: El-Alto (5.0.x)
180 ------------------------
181 **Known Issues**
182
183   - `<https://jira.onap.org/browse/VID-659>`__ VID generates always the same VF module name during scale out
184
185 **Resolved Issues**
186
187   - `<https://jira.onap.org/browse/VID-520>`__ Remove "Dissociate" button for Macro-orchestrated PNF resources
188   - `<https://jira.onap.org/browse/VID-517>`__ Added liquidBase for follow changes in DB
189   - `<https://jira.onap.org/browse/VID-488>`__ Added "Report" popup for common diagnosable cases
190   - `<https://jira.onap.org/browse/VID-358>`__ vid-mariadb-galera runs in high-availability mode
191
192
193 **Security Notes**
194
195 *Fixed Security Issues*
196
197   - `<https://jira.onap.org/browse/OJSI-119>`__ Closed plain-text HTTP endpoint, port 30238
198
199 *Known Security Issues*
200
201
202
203
204 Version: 4.3.2
205 --------------
206
207 **Resolved Issues**
208
209 Reverted the soft-delete feature, to resolve this:
210   - `VID-503 <https://jira.onap.org/browse/VID-503>`_ Delete VF module does not trigger any action
211
212
213 Version: 4.3.0
214 --------------
215
216 :Release Date: 2019-05-25
217
218 New Features
219 ------------
220
221 -  [`VID-246`_] - *Centralized Representation and Consistent ID of Cloud Regions*
222 -  [`VID-397`_] - *Change Management - Flexible Designer & Orchestrator*: Utilize SO as a repository of workflows, instead of VID's workflows' configuration
223
224 .. _VID-246: /browse/VID-246
225 .. _VID-397: /browse/VID-397
226
227 **Security Notes**
228
229 *Fixed Security Issues*
230
231 *Known Security Issues*
232
233 - In default deployment VID (vid) exposes HTTP port 30238 outside of cluster. [`OJSI-119 <https://jira.onap.org/browse/OJSI-119>`_]
234
235 *Known Vulnerabilities in Used Modules*
236
237 Version: 3.2.3
238 --------------
239
240 :Release Date: 2019-03-28
241
242 **Notes**
243
244 It's v3.2.2, but repackaged with a new certificate valid until March 12, 2020.
245
246 **Resolved Issues**
247
248 VID certificates have been renewed to extend their expiry dates
249   - `VID-446 <https://jira.onap.org/browse/VID-446>`_ Fix Certificate Expiry.
250
251
252 Version: 3.2.2
253 --------------
254
255 :Release Date: 2018-11-30
256
257 New Features
258 ------------
259 1. PNF plug & play services instantiation.
260 2. HTTPS support.
261 3. Manual vNF Scale Out enhancements.
262
263 **Epics**
264
265 -  [`VID-159`_] - AAF integration
266 -  [`VID-194`_] - PNF Use case support
267 -  [`VID-248`_] - Support scaling use case
268 -  [`VID-254`_] - Usability
269 -  [`VID-258`_] - Security
270
271 .. _VID-159: /browse/VID-159
272 .. _VID-194: /browse/VID-194
273 .. _VID-248: /browse/VID-248
274 .. _VID-254: /browse/VID-254
275 .. _VID-258: /browse/VID-258
276
277 **Stories**
278
279 -  [`VID-166`_] - Improve CSIT coverage
280 -  [`VID-203`_] - PNF Plug & Play use case with vCPE flow
281 -  [`VID-236`_] - Align OOM templates
282 -  [`VID-249`_] - Change Manual Scaling Use Case to use the same SO API that Policy is using in Auto Scaling
283 -  [`VID-250`_] - Remove Controller Type from the VID GUI and from the request sent to SO
284 -  [`VID-256`_] - Add tutorials/user guides
285 -  [`VID-257`_] - AAF integration
286 -  [`VID-260`_] - Use HTTPS for external interfaces
287 -  [`VID-261`_] - Use HTTPS for internal interfaces
288
289 .. _VID-166: /browse/VID-166
290 .. _VID-203: /browse/VID-203
291 .. _VID-236: /browse/VID-236
292 .. _VID-249: /browse/VID-249
293 .. _VID-250: /browse/VID-250
294 .. _VID-256: /browse/VID-256
295 .. _VID-257: /browse/VID-257
296 .. _VID-260: /browse/VID-260
297 .. _VID-261: /browse/VID-261
298
299 **Security Notes**
300
301 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>`_.
302
303 Quick Links:
304
305 - `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`__
306 - `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`__
307 - `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=45300871>`__
308
309 **Other**
310
311 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
312
313 Version: 2.0.0
314 --------------
315
316 :Release Date: 2018-06-07
317
318 New Features
319 ------------
320 1. VoLTE E2E services instantiation.
321 2. Change Management - invoking vNF In-Place SW Update without a scheduler.
322 3. Manual vNF Scale Out.
323
324 **Epics**
325
326 -  [`VID-101`_] - Port Mirroring
327 -  [`VID-106`_] - Cancel "Pending" workflows
328 -  [`VID-110`_] - Owning Entity
329 -  [`VID-114`_] - Preload Automation
330 -  [`VID-116`_] - Tenant Isolation
331 -  [`VID-120`_] - Active/Deactivate service type transport
332 -  [`VID-124`_] - Agnostic vNF In-Place SW Update
333 -  [`VID-127`_] - Agnostic vNF Configuration Update
334 -  [`VID-131`_] - Port mirroring - pProbe configuration
335 -  [`VID-136`_] - Support for pProbes
336 -  [`VID-139`_] - Refactor Scheduler
337 -  [`VID-148`_] - Non-Functional requirements - Resiliency
338 -  [`VID-154`_] - Non-Functional requirements - Stability
339 -  [`VID-157`_] - Non-Functional requirements - Performance
340 -  [`VID-158`_] - Non-Functional requirements - Usability
341 -  [`VID-160`_] - Non-Functional requirements - Scalability
342 -  [`VID-161`_] - Non-Functional requirements - Security (CII passing badge + 50% test coverage)
343 -  [`VID-162`_] - OOM integration
344 -  [`VID-179`_] - Change management - working without scheduler
345 -  [`VID-180`_] - Support manual scale out
346 -  [`VID-192`_] - Verify features merged from ECOMP 1802
347
348 .. _VID-101: https://jira.onap.org/browse/VID-101
349 .. _VID-106: https://jira.onap.org/browse/VID-106
350 .. _VID-110: https://jira.onap.org/browse/VID-110
351 .. _VID-114: https://jira.onap.org/browse/VID-114
352 .. _VID-116: https://jira.onap.org/browse/VID-116
353 .. _VID-120: https://jira.onap.org/browse/VID-120
354 .. _VID-124: https://jira.onap.org/browse/VID-124
355 .. _VID-127: https://jira.onap.org/browse/VID-127
356 .. _VID-131: https://jira.onap.org/browse/VID-131
357 .. _VID-136: https://jira.onap.org/browse/VID-136
358 .. _VID-139: https://jira.onap.org/browse/VID-139
359 .. _VID-148: https://jira.onap.org/browse/VID-148
360 .. _VID-154: https://jira.onap.org/browse/VID-154
361 .. _VID-157: https://jira.onap.org/browse/VID-157
362 .. _VID-158: https://jira.onap.org/browse/VID-158
363 .. _VID-160: https://jira.onap.org/browse/VID-160
364 .. _VID-161: https://jira.onap.org/browse/VID-161
365 .. _VID-162: https://jira.onap.org/browse/VID-162
366 .. _VID-179: https://jira.onap.org/browse/VID-179
367 .. _VID-180: https://jira.onap.org/browse/VID-180
368 .. _VID-192: https://jira.onap.org/browse/VID-192
369
370 **Stories**
371
372 -  [`VID-16`_] - Replace any remaining openecomp reference by onap
373 -  [`VID-86`_] - Migrate to org.onap
374 -  [`VID-102`_] - Create "Port mirror" configuration - Attach Source & collector VNFs
375 -  [`VID-103`_] - Create "Port mirror" configuration - General Required Fields
376 -  [`VID-104`_] - Configuration supporting actions
377 -  [`VID-105`_] - Create "Port mirror" configuration - Get model information
378 -  [`VID-107`_] - 3rd party simulator
379 -  [`VID-108`_] - Cancel Scheduled workflows
380 -  [`VID-109`_] - Change information of columns in the "Pending" section of the "dashboard"
381 -  [`VID-111`_] - New properties logic
382 -  [`VID-112`_] - Filter service instance by new properties
383 -  [`VID-113`_] - Implement new properties & their values
384 -  [`VID-115`_] - Resume VF- module (after pause)
385 -  [`VID-117`_] - Create Application ENV
386 -  [`VID-118`_] - Deploy Services on VID operational
387 -  [`VID-119`_] - Activate/Deactivate Application ENV
388 -  [`VID-121`_] - Deactivate a Transport service logic
389 -  [`VID-122`_] - Service Instance Deactivate - API MSO
390 -  [`VID-123`_] - "Activate" avilable only for service instance from type= transport
391 -  [`VID-125`_] - VNF In Place Software Update API - MSO
392 -  [`VID-126`_] - Support new workflow "Agnostic vNF In-Place SW Update"
393 -  [`VID-128`_] - Support workflow "vnf Config Update"
394 -  [`VID-129`_] - Rules For Converting Payload Spreadsheet To JSON
395 -  [`VID-130`_] - VNF Config Update - API MSO
396 -  [`VID-132`_] - Get pnf-fromModel-byRegion - A&AI API
397 -  [`VID-133`_] - pProbe config create request - MSO API
398 -  [`VID-134`_] - Associate PNF instance to port mirroring configuration by policy
399 -  [`VID-135`_] - Get Port Mirroring Configuration By Policy Node type
400 -  [`VID-137`_] - Associate PNF instance to service instance
401 -  [`VID-138`_] - Disassociate PNF instance from service instance
402 -  [`VID-140`_] - New function to support Scheduler in widget
403 -  [`VID-151`_] - ONAP Support
404 -  [`VID-174`_] - Change management: bypassing scheduler for immediate operations
405 -  [`VID-185`_] - UI changes for working without scheduler
406 -  [`VID-186`_] - docker alignment analyzes
407 -  [`VID-188`_] - UI for Scale Out workflow
408 -  [`VID-189`_] - VoLTE use case support
409 -  [`VID-191`_] - Changes to API to SO for Manual scale out use case
410 -  [`VID-197`_] - Reach 50% unit test coverage
411 -  [`VID-201`_] - User inteface for invoking upgrade workflow
412 -  [`VID-202`_] - Verify R1 and R2 features - integration and regression tests
413 -  [`VID-216`_] - Update ReadTheDocs docs folder
414
415 .. _VID-16: https://jira.onap.org/browse/VID-16
416 .. _VID-86: https://jira.onap.org/browse/VID-86
417 .. _VID-102: https://jira.onap.org/browse/VID-102
418 .. _VID-103: https://jira.onap.org/browse/VID-103
419 .. _VID-104: https://jira.onap.org/browse/VID-104
420 .. _VID-105: https://jira.onap.org/browse/VID-105
421 .. _VID-107: https://jira.onap.org/browse/VID-107
422 .. _VID-108: https://jira.onap.org/browse/VID-108
423 .. _VID-109: https://jira.onap.org/browse/VID-109
424 .. _VID-111: https://jira.onap.org/browse/VID-111
425 .. _VID-112: https://jira.onap.org/browse/VID-112
426 .. _VID-113: https://jira.onap.org/browse/VID-113
427 .. _VID-115: https://jira.onap.org/browse/VID-115
428 .. _VID-117: https://jira.onap.org/browse/VID-117
429 .. _VID-118: https://jira.onap.org/browse/VID-118
430 .. _VID-119: https://jira.onap.org/browse/VID-119
431 .. _VID-121: https://jira.onap.org/browse/VID-121
432 .. _VID-122: https://jira.onap.org/browse/VID-122
433 .. _VID-123: https://jira.onap.org/browse/VID-123
434 .. _VID-125: https://jira.onap.org/browse/VID-125
435 .. _VID-126: https://jira.onap.org/browse/VID-126
436 .. _VID-128: https://jira.onap.org/browse/VID-128
437 .. _VID-129: https://jira.onap.org/browse/VID-129
438 .. _VID-130: https://jira.onap.org/browse/VID-130
439 .. _VID-132: https://jira.onap.org/browse/VID-132
440 .. _VID-133: https://jira.onap.org/browse/VID-133
441 .. _VID-134: https://jira.onap.org/browse/VID-134
442 .. _VID-135: https://jira.onap.org/browse/VID-135
443 .. _VID-137: https://jira.onap.org/browse/VID-137
444 .. _VID-138: https://jira.onap.org/browse/VID-138
445 .. _VID-140: https://jira.onap.org/browse/VID-140
446 .. _VID-151: https://jira.onap.org/browse/VID-151
447 .. _VID-174: https://jira.onap.org/browse/VID-174
448 .. _VID-185: https://jira.onap.org/browse/VID-185
449 .. _VID-186: https://jira.onap.org/browse/VID-186
450 .. _VID-188: https://jira.onap.org/browse/VID-188
451 .. _VID-189: https://jira.onap.org/browse/VID-189
452 .. _VID-191: https://jira.onap.org/browse/VID-191
453 .. _VID-197: https://jira.onap.org/browse/VID-197
454 .. _VID-201: https://jira.onap.org/browse/VID-201
455 .. _VID-202: https://jira.onap.org/browse/VID-202
456 .. _VID-216: https://jira.onap.org/browse/VID-216
457
458 **Security Notes**
459
460 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>`__.
461
462 Quick Links:
463
464 - `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`_
465 - `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`_
466 - `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_
467
468 **Other**
469
470 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
471
472 Version: 1.1.1
473 --------------
474
475 :Release Date: 2017-11-16
476
477 New Features
478 ------------
479
480 1. Improved TOSCA parser.
481 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 .
482 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.
483
484 **Epics**
485
486 -  [`VID-25`_] - Role management: Global Read only role
487 -  [`VID-26`_] - Role management: Support VID specific Roles
488 -  [`VID-27`_] - Change management: Schedule workflow
489 -  [`VID-28`_] - Change management: Status of workflow
490 -  [`VID-29`_] - Change management: Manual intervention
491 -  [`VID-30`_] - PNF instantiation: Trigger PNF service information to SO
492 -  [`VID-31`_] - PNF Instantiation: support service type PNF & display new fields
493
494 .. _VID-25: https://jira.onap.org/browse/VID-25
495 .. _VID-26: https://jira.onap.org/browse/VID-26
496 .. _VID-27: https://jira.onap.org/browse/VID-27
497 .. _VID-28: https://jira.onap.org/browse/VID-28
498 .. _VID-29: https://jira.onap.org/browse/VID-29
499 .. _VID-30: https://jira.onap.org/browse/VID-30
500 .. _VID-31: https://jira.onap.org/browse/VID-31
501
502 **Stories**
503
504 -  [`VID-44`_] - Implement change management phase 1
505 -  [`VID-48`_] - Change management: Schedule workflow
506 -  [`VID-49`_] - Change management: Status of workflow
507 -  [`VID-50`_] - Change management: Manual intervention
508 -  [`VID-51`_] - Trigger PNF service information to MSO
509 -  [`VID-52`_] - support service type PNF & display new fields
510
511 .. _VID-44: https://jira.onap.org/browse/VID-44
512 .. _VID-48: https://jira.onap.org/browse/VID-48
513 .. _VID-49: https://jira.onap.org/browse/VID-49
514 .. _VID-50: https://jira.onap.org/browse/VID-50
515 .. _VID-51: https://jira.onap.org/browse/VID-51
516 .. _VID-52: https://jira.onap.org/browse/VID-52
517
518
519 Bug Fixes
520 ----------
521
522 -  [`VID-20`_] - Failed to get service models from ASDC in VID
523 -  [`VID-59`_] - VID Fails Robot Health Check
524 -  [`VID-62`_] - VID healthcheck failure in RS ORD ONAP 1.1.0
525 -  [`VID-64`_] - Got 500 from role/user API call
526 -  [`VID-79`_] - Not able to create service instance using VID portal
527 -  [`VID-82`_] - Create VF module with SDNC preload is throwing
528    exception
529
530 .. _VID-20: https://jira.onap.org/browse/VID-20
531 .. _VID-59: https://jira.onap.org/browse/VID-59
532 .. _VID-62: https://jira.onap.org/browse/VID-62
533 .. _VID-64: https://jira.onap.org/browse/VID-64
534 .. _VID-79: https://jira.onap.org/browse/VID-79
535 .. _VID-82: https://jira.onap.org/browse/VID-82
536
537
538 **Known Issues**
539
540 - `VID-78 <https://jira.onap.org/browse/VID-78>`_ VID shows the HTML code output whenever the customer list is empty (Cosmetic)
541
542 **Upgrade Notes**
543
544 A scheduler is needed for the change management feature to work (not included in the Amsterdam release).
545
546 **Other**
547
548 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
549
550 End of Release Notes