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