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