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