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