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