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