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