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