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