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