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