Merge "workflow action should read config for max retries"
[so.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Intellectual Property.  All rights reserved.
4
5
6 Service Orchestrator Release Notes
7 ==================================
8
9 The SO provides the highest level of service orchestration in the ONAP architecture. 
10
11 Version: 1.3.7
12 --------------
13
14 :Release Date: 2019-01-31
15
16 This is the official release package that released for the Casablanca Maintenance.
17
18 Casablanca Release branch
19
20 **New Features**
21
22 This release is supporting the features of Casablanca and their defect fixes.
23 - `SO-1400 <https://jira.onap.org/browse/SO-1336>`_
24 - `SO-1408 <https://jira.onap.org/browse/SO-1408>`_
25 - `SO-1416 <https://jira.onap.org/browse/SO-1416>`_
26 - `SO-1417 <https://jira.onap.org/browse/SO-1417>`_
27
28 **Docker Images**
29
30 Dockers released for SO:
31
32  - onap/so/api-handler-infra,1.3.7
33  - onap/so/bpmn-infra,1.3.7
34  - onap/so/catalog-db-adapter,1.3.7
35  - onap/so/openstack-adapter,1.3.7
36  - onap/so/request-db-adapter,1.3.7
37  - onap/so/sdc-controller,1.3.7
38  - onap/so/sdnc-adapter,1.3.7
39  - onap/so/so-monitoring,1.3.7
40  - onap/so/vfc-adapter,1.3.7
41
42 **Known Issues**
43
44 - `SO-1419 <https://jira.onap.org/browse/SO-1419>`_ - is a stretch goal that is under examination.
45
46 - `SDC-1955 <https://jira.onap.org/browse/SDC-1955>`_ - tested with a workaround to avoid this scenario. To be tested further with updated dockers of SDC, UUI and SO.
47
48 **Security Notes**
49
50         SO 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 SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
51
52         Quick Links:
53
54  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
55  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
56  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
57
58
59 Version: 1.3.6
60 --------------
61
62 :Release Date: 2019-01-10
63
64 This is the official release package that released for the Casablanca Maintenance.
65
66 Casablanca Release branch
67
68 **New Features**
69
70 This release is supporting the features of Casablanca and their defect fixes.
71 - `SO-1336 <https://jira.onap.org/browse/SO-1336>`_
72 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
73 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
74 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
75 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
76 - `SO-1194 <https://jira.onap.org/browse/SO-1256>`_
77 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
78 - `SO-1184 <https://jira.onap.org/browse/SO-1184>`_
79
80 **Docker Images**
81
82 Dockers released for SO:
83
84  - onap/so/api-handler-infra,1.3.6
85  - onap/so/bpmn-infra,1.3.6
86  - onap/so/catalog-db-adapter,1.3.6
87  - onap/so/openstack-adapter,1.3.6
88  - onap/so/request-db-adapter,1.3.6
89  - onap/so/sdc-controller,1.3.6
90  - onap/so/sdnc-adapter,1.3.6
91  - onap/so/so-monitoring,1.3.6
92  - onap/so/vfc-adapter,1.3.6
93
94 **Known Issues**
95
96
97 **Security Notes**
98
99         SO 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 SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
100
101         Quick Links:
102
103  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
104  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
105  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
106
107 New  release over  master branch for Dublin development
108
109 Version: 1.3.3
110 --------------
111
112 :Release Date: 2018-11-30
113
114 This is the official release package that was tested against the 72 hour stability test in integration environment.
115
116 Casablanca Release branch
117
118 **New Features**
119
120 Features delivered in this release:
121
122  - Automatic scale out of VNFs.
123  - Extend the support of homing to vFW, vCPE usecases through HPA.
124  - Monitoring BPMN workflow capabilities through UI.
125  - SO internal architecture improvements.
126  - Support PNF resource type.
127  - Support to the CCVPN Usecase.
128  - Workflow Designer Integration.
129
130 **Docker Images**
131
132 Dockers released for SO:
133
134  - onap/so/api-handler-infra,1.3.3
135  - onap/so/bpmn-infra,1.3.3
136  - onap/so/catalog-db-adapter,1.3.3
137  - onap/so/openstack-adapter,1.3.3
138  - onap/so/request-db-adapter,1.3.3
139  - onap/so/sdc-controller,1.3.3
140  - onap/so/sdnc-adapter,1.3.3
141  - onap/so/so-monitoring,1.3.3
142  - onap/so/vfc-adapter,1.3.3
143
144 **Known Issues**
145
146 There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.5
147
148 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
149   The workflow for resource processing use the wrong default value.
150
151 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
152   Authorization header added to multicloud adapter breaks communication.
153   
154 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
155   OOF Directives are not passed through flows to Multicloud Adapter.
156
157 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
158   Permission support for Vfcadapter is missing.
159
160 - `SO-1194 <https://jira.onap.org/browse/SO-1194>`_
161   Unable to find TOSCA CSAR location using ServiceModelUUID in DoCreateResource BPMN flow.
162   
163         
164 Below issues will be resolved in the next release:
165
166 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
167   Csar needs to be manually placed into the bpmn corresponding directory.
168
169 - `SO-1184 <https://jira.onap.org/browse/SO-1184>`_
170   Database table is not populated for Generic NeutronNet resource.
171
172
173 **Security Notes**
174
175         SO 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 SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
176
177         Quick Links:
178
179  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
180  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
181  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
182
183 Version: 1.3.1
184 --------------
185
186 :Release Date: 2018-10-24
187
188 Branch cut for Casablanca post M4 for integration test.
189 **New Features**
190
191 Below  features are under test:
192  - Automatic scale out of VNFs.
193  - Extend the support of homing to vFW, vCPE usecases through HPA.
194  - Monitoring BPMN workflow capabilities through UI.
195  - SO internal architecture improvements.
196  - Support PNF resource type.
197  - Support to the CCVPN Usecase.
198  - Workflow Designer Integration.
199
200
201 Version: 1.3.0
202 --------------
203
204 :Release Date: 2018-08-22
205
206 New  release over  master branch for Casablanca development
207
208 Version: 1.2.2
209 --------------
210
211 :Release Date: 2018-06-07
212
213 The Beijing release is the second release of the Service Orchestrator (SO) project.
214
215 **New Features**
216
217 * Enhance Platform maturity by improving SO maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
218 * Manual scaling of network services and VNFs.
219 * Homing and placement capabilities through OOF interaction. 
220 * Ability to perform change management.
221 * Integrated to APPC
222 * Integrated to OOF 
223 * Integrated to OOM
224  
225 **Bug Fixes**
226
227         The defects fixed in this release could be found `here <https://jira.onap.org/issues/?jql=project%20%3D%20SO%20AND%20affectedVersion%20%3D%20%22Beijing%20Release%22%20AND%20status%20%3D%20Closed%20>`_.
228
229 **Known Issues**
230
231         SO docker image is still on ecmop and not onap in the repository. 
232         This will be addressed in the next release.
233
234 **Security Notes**
235
236         SO 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 SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_.
237
238 Quick Links:
239
240 - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
241 - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
242 - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_
243
244 **Upgrade Notes**
245         NA
246
247 **Deprecation Notes**
248         NA
249
250 Version: 1.1.2
251 --------------
252
253 :Release Date: 2018-01-18
254
255 Bug Fixes
256 ---------
257 The key defects fixed in this release :
258
259 - `SO-344 <https://jira.onap.org/browse/SO-344>`_
260   Only pass one VNF to DoCreateVnfAndModules.
261
262 - `SO-348 <https://jira.onap.org/browse/SO-348>`_
263   Json Analyze Exception in PreProcessRequest.
264
265 - `SO-352 <https://jira.onap.org/browse/SO-352>`_
266   SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process.
267
268 - `SO-354 <https://jira.onap.org/browse/SO-354>`_
269   Change the Service Type And Service Role
270
271
272 Version: 1.1.1
273 --------------
274
275 :Release Date: 2017-11-16
276
277
278 **New Features**
279
280 The SO provides the highest level of service orchestration in the ONAP architecture.
281 It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. 
282
283 The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. 
284
285 * Orchestration services will process workflows based on defined models and recipe. 
286 * The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
287 * Orchestration processes interact with other platform components or external systems via standard and well-defined APIs.
288
289
290 **Deprecation Notes**
291
292 There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system.  
293 The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release.
294 The Gerrit repos of mso/* are voided and already locked as read-only.
295 Following are the deprecated SO projects in gerrit repo:
296
297 - mso
298 - mso/chef-repo
299 - mso/docker-config
300 - mso/libs
301 - mso/mso-config
302         
303 **Other**
304         NA
305
306 ===========
307
308 End of Release Notes