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