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