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