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