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