Merge "update OperationStatus Based On ResourceStatus" into casablanca
[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.3
12 --------------
13
14 :Release Date: 2018-11-30
15
16 This is the official release package that was tested against the 72 hour stability test in integration environment.
17
18 Casablanca Release branch
19
20 **New Features**
21
22 Features delivered in this release:
23
24  - Automatic scale out of VNFs.
25  - Extend the support of homing to vFW, vCPE usecases through HPA.
26  - Monitoring BPMN workflow capabilities through UI.
27  - SO internal architecture improvements.
28  - Support PNF resource type.
29  - Support to the CCVPN Usecase.
30  - Workflow Designer Integration.
31
32 **Docker Images**
33
34 Dockers released for SO:
35
36  - onap/so/api-handler-infra,1.3.3
37  - onap/so/bpmn-infra,1.3.3
38  - onap/so/catalog-db-adapter,1.3.3
39  - onap/so/openstack-adapter,1.3.3
40  - onap/so/request-db-adapter,1.3.3
41  - onap/so/sdc-controller,1.3.3
42  - onap/so/sdnc-adapter,1.3.3
43  - onap/so/so-monitoring,1.3.3
44  - onap/so/vfc-adapter,1.3.3
45
46 **Known Issues**
47
48 There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.5
49 - `SO-1249 <https://jira.onap.org/browse/SO-1249>`_
50 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
51         
52 Below issues will be resolved in the next release:
53
54 - `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
55 - `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
56 - `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
57 - `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
58
59
60 **Security Notes**
61
62         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>`_.
63
64         Quick Links:
65
66  - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
67  - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
68  - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
69
70 Version: 1.3.1
71 --------------
72
73 :Release Date: 2018-10-24
74
75 Branch cut for Casablanca post M4 for integration test.
76 **New Features**
77
78 Below  features are under test:
79  - Automatic scale out of VNFs.
80  - Extend the support of homing to vFW, vCPE usecases through HPA.
81  - Monitoring BPMN workflow capabilities through UI.
82  - SO internal architecture improvements.
83  - Support PNF resource type.
84  - Support to the CCVPN Usecase.
85  - Workflow Designer Integration.
86
87
88 Version: 1.3.0
89 --------------
90
91 :Release Date: 2018-08-22
92
93 New  release over  master branch for Casablanca development
94
95 Version: 1.2.2
96 --------------
97
98 :Release Date: 2018-06-07
99
100 The Beijing release is the second release of the Service Orchestrator (SO) project.
101
102 **New Features**
103
104 * Enhance Platform maturity by improving SO maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
105 * Manual scaling of network services and VNFs.
106 * Homing and placement capabilities through OOF interaction. 
107 * Ability to perform change management.
108 * Integrated to APPC
109 * Integrated to OOF 
110 * Integrated to OOM
111  
112 **Bug Fixes**
113
114         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>`_.
115
116 **Known Issues**
117
118         SO docker image is still on ecmop and not onap in the repository. 
119         This will be addressed in the next release.
120
121 **Security Notes**
122
123         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>`_.
124
125 Quick Links:
126
127 - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
128 - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
129 - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_
130
131 **Upgrade Notes**
132         NA
133
134 **Deprecation Notes**
135         NA
136
137 Version: 1.1.2
138 --------------
139
140 :Release Date: 2018-01-18
141
142 Bug Fixes
143 ---------
144 The key defects fixed in this release :
145
146 - `SO-344 <https://jira.onap.org/browse/SO-344>`_
147   Only pass one VNF to DoCreateVnfAndModules.
148
149 - `SO-348 <https://jira.onap.org/browse/SO-348>`_
150   Json Analyze Exception in PreProcessRequest.
151
152 - `SO-352 <https://jira.onap.org/browse/SO-352>`_
153   SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process.
154
155 - `SO-354 <https://jira.onap.org/browse/SO-354>`_
156   Change the Service Type And Service Role
157
158
159 Version: 1.1.1
160 --------------
161
162 :Release Date: 2017-11-16
163
164
165 **New Features**
166
167 The SO provides the highest level of service orchestration in the ONAP architecture.
168 It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. 
169
170 The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. 
171
172 * Orchestration services will process workflows based on defined models and recipe. 
173 * The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
174 * Orchestration processes interact with other platform components or external systems via standard and well-defined APIs.
175
176
177 **Deprecation Notes**
178
179 There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system.  
180 The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release.
181 The Gerrit repos of mso/* are voided and already locked as read-only.
182 Following are the deprecated SO projects in gerrit repo:
183
184 - mso
185 - mso/chef-repo
186 - mso/docker-config
187 - mso/libs
188 - mso/mso-config
189         
190 **Other**
191         NA
192
193 ===========
194
195 End of Release Notes