blob: 0c6d86d5ec095bc1a574ed65fbe20a63902e4ac4 [file] [log] [blame]
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3Release Notes
4=============
5
Vijay VK6b0fa462019-05-20 16:06:11 +01006Version: 4.0.0
7--------------
8
9:Release Date: 2019-06-06
10
11**New Features**
12
13DCAE R4 improves upon previous release with the following new features:
14
15- DCAE Platform Enhancement
16 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
17 - Support helm chart deployment in DCAE using new Helm cloudify plugin
18 - DCAE Healthcheck enhancement to cover static and dynamic deployments
19 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
20 - Dashboard Integration (UI for deployment/verification)
21 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
22 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020023 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +010024
25- Following new services are delivered with Dublin
26 - Collectors
27 - RESTConf collector 
28 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +010029 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +010030 - 3gpp PM-Mapper
31 - BBS Event processor
32 - Analytics/RCA
33 - SON-Handler
34 - Heartbeat MS
35
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020036Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
Vijay VK6b0fa462019-05-20 16:06:11 +010037 - Platform components
38 - Cloudify Manager (helm chart)
39 - Bootstrap container (helm chart)
40 - Configuration Binding Service (helm chart)
41 - Deployment Handler (helm chart)
42 - Policy Handler (helm chart
43 - Service Change Handler (helm chart)
44 - Inventory API (helm chart)
45 - Dashboard (Cloudify Blueprint)
46 - Service components
47 - VES Collector
48 - SNMP Collector
49 - Threshold Crossing Analytics
50 - HV-VES Collector
51 - PNF-Registration Handler
52 - Holmes Rule Management *
53 - Holmes Engine Management *
54 - Additional resources that DCAE utilizes:
55 - Postgres Database
56 - Redis Cluster Database
57 - Consul Cluster *
58
59 Notes:
60 \* These components are delivered by the Holmes project.
61
62
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020063Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Vijay VK6b0fa462019-05-20 16:06:11 +010064
65- All DCAE components are designed to support platform maturity requirements.
66
67
68**Source Code**
69
70Source code of DCAE components are released under the following repositories on gerrit.onap.org:
71 - dcaegen2
72 - dcaegen2.analytics.tca
73 - dcaegen2.collectors.snmptrap
74 - dcaegen2.collectors.ves
75 - dcaegen2.collectors.hv-ves
76 - dcaegen2.collectors.datafile
77 - dcaegen2.collectors.restconf
78 - dcaegen2.deployments
79 - dcaegen2.platform.blueprints
80 - dcaegen2.platform.cli
81 - dcaegen2.platform.configbinding
82 - dcaegen2.platform.deployment-handler
83 - dcaegen2.platform.inventory-api
84 - dcaegen2.platform.plugins
85 - dcaegen2.platform.policy-handler
86 - dcaegen2.platform.servicechange-handler
87 - dcaegen2.services.heartbeat
88 - dcaegen2.services.mapper
89 - dcaegen2.services.pm-mapper
90 - dcaegen2.services.prh
91 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020092 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +010093 - dcaegen2.services.sdk
94 - dcaegen2.utils
95 - ccsdk.platform.plugins
96 - ccsdk.dashboard
97
98**Bug Fixes**
99
100**Known Issues**
101
102**Security Notes**
103
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200104*Fixed Security Issues*
105
106*Known Security Issues*
107
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200108 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200109 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
Krzysztof Opasiakf38f8392019-05-27 18:11:02 +0200110 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
Krzysztof Opasiak01a58302019-05-27 18:11:28 +0200111 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
Krzysztof Opasiak7c269dc2019-05-30 23:57:24 +0200112 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
Krzysztof Opasiakf0b14642019-05-27 18:13:16 +0200113 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200114
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200115*Known Vulnerabilities in Used Modules*
116
Vijay VK6b0fa462019-05-20 16:06:11 +0100117DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
118
119Quick Links:
120 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
121
122 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
123
124 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
125
126
127**New component Notes**
128The following components are introduced in R4
129
130 - Dashboard
131 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
132 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
133 - Blueprint generator
134 - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200135 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100136 - RESTConf collector 
137 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
138 - Description: Provides RESTConf interfaces to events from external domain controllers
139 - VES/Universal Mapper
140 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200141 - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
Vijay VK6b0fa462019-05-20 16:06:11 +0100142 - 3gpp PM-Mapper
143 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200144 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100145 - BBS Event processor
146 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200147 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100148 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100149 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200150 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100151 - Heartbeat MS
152 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
153 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200154
Vijay VK6b0fa462019-05-20 16:06:11 +0100155
156**Upgrade Notes**
157
158The following components are upgraded from R3
159 - Cloudify Manager:
160 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
161 - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200162 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100163 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200164 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
165 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100166 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
167 - Description: Code optimization and bug fixes
168 - Deployment Handler
169 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
170 - Include updates for health and service endpoint check and bug fixes
171 - Policy Handler
172 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
173 - Description: Policy Handler supports the new lifecycle API's from Policy framework
174 - Service Change Handler
175 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
176 - Description: No update from R3
177 - Inventory API
178 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
179 - Description: Refactoring and updates for health and service endpoint check
180 - VES Collector
181 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200182 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100183 - Threshold Crossing Analytics
184 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
185 - Description: Config updates. Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
186 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100187 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100188 - Description : Code optimization, bug fixes, logging and performance improvement
189 - PNF Registrator handler
190 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200191 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100192 - HV-VES Collector
193 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
194 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
195 - SNMP Trap Collector
196 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200197 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100198
199
200
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500201
202Version: 3.0.1
203--------------
204
205:Release Date: 2019-01-31
206
207DCAE R3 Maintenance release includes following fixes
208
209**Bug Fixes**
210
211- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200212 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500213 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200214 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500215 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200216 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500217 Multiple Fileready notification not handled
218
219- HighVolume VES Collector (protobuf/tcp)
220 - DCAEGEN2-976
221 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
222
223- VESCollector (http)
224 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200225 Issue with VES batch event publish
226
227- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500228 - DCAEGEN2-1007
229 Removing obsolete services configuration
230
231
232The following containers are updated in R3.0.1
233
234 - DataFile Collector
235 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
236 - HV-VES Collector
237 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
238 - VES Collector
239 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
240
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500241**Known Issues**
242
243- An issue related to VESCollector basic authentication was noted and tracked under DCAEGEN2-1130. This configuration is not enabled by default for R3.0.1; and fix will be handled in Dublin
244
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200245- Certificates under onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 has expired March'2019 and impacting CL deployment from CLAMP. Follow below workaround to update the certificate
Vijay VK6b0fa462019-05-20 16:06:11 +0100246 kubectl get deployments -n onap | grep deployment-handler
247 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
248 Search and change tag onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 to onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3
249
250
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500251
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500252
Vijay VK2648c6d2018-09-19 04:30:37 +0100253Version: 3.0.0
254--------------
255
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800256:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100257
258**New Features**
259
260DCAE R3 improves upon previous release with the following new features:
261
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200262- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100263 - Platform components
264 - Cloudify Manager
265 - Bootstrap container
266 - Configuration Binding Service
267 - Deployment Handler
268 - Policy Handler
269 - Service Change Handler
270 - Inventory API
271 - Service components
272 - VES Collector
273 - SNMP Collector
274 - Threshold Crossing Analytics
275 - Holmes Rule Management *
276 - Holmes Engine Management *
277 - Additional resources that DCAE utilizes:
278 - Postgres Database
279 - Redis Cluster Database
280 - Consul Cluster
281
282 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000283 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100284
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200285- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100286
287 - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
288 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
289
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200290- DCAE R3 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Vijay VK2648c6d2018-09-19 04:30:37 +0100291
292- All DCAE components are designed to support platform maturity requirements.
293
294
295**Source Code**
296
297Source code of DCAE components are released under the following repositories on gerrit.onap.org:
298 - dcaegen2
299 - dcaegen2.analytics
300 - dcaegen2.analytics.tca
301 - dcaegen2.collectors
302 - dcaegen2.collectors.snmptrap
303 - dcaegen2.collectors.ves
304 - dcaegen2.collectors.hv-ves
305 - dcaegen2.collectors.datafile
306 - dcaegen2.deployments
307 - dcaegen2.platform
308 - dcaegen2.platform.blueprints
309 - dcaegen2.platform.cli
310 - dcaegen2.platform.configbinding
311 - dcaegen2.platform.deployment-handler
312 - dcaegen2.platform.inventory-api
313 - dcaegen2.platform.plugins
314 - dcaegen2.platform.policy-handler
315 - dcaegen2.platform.servicechange-handler
316 - dcaegen2.services.heartbeat
317 - dcaegen2.services.mapper
318 - dcaegen2.services.prh
319 - dcaegen2.utils
320
321**Bug Fixes**
322
323**Known Issues**
324
325- DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine. Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image. DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
326
327**Security Notes**
328
329DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
330
331Quick Links:
332 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
333
334 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
335
Vijay VKab471f62018-11-26 17:49:43 +0000336 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100337
338
Vijay VKf6659fc2018-11-02 05:07:27 +0100339**New component Notes**
340The following components are introduced in R3
341
342 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000343 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100344 - Description : Bulk data file collector to fetch non-realtime PM data
345 - PNF Registrator handler
346 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200347 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100348 - HV-VES Collector
349 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
350 - Description : High Volume VES Collector for fetching real-time PM measurement data
351 - SNMP Trap Collector
352 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200353 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100354
Vijay VK2648c6d2018-09-19 04:30:37 +0100355
356**Upgrade Notes**
357
358The following components are upgraded from R2:
359 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100360 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100361 - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.7.23, which is based on Cloudify Manager 4.3.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200362 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100363 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100364 - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications. The bootstrap is for OOM (Kubernetes) based deployment.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200365 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100366 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
367 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
368 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100369 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100370 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100371 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100372 - Description: Policy Handler now supports the new configuration policy format and support for TLS
373 - Service Change Handler
374 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
375 - Description: Refactoring.
376 - Inventory API
377 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
378 - Description: Refactoring.
379 - VES Collector
380 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500381 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100382 - Threshold Crossing Analytics
383 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
384 - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
385
386
387
388
Lusheng Jib2a561b2018-03-27 23:24:33 -0400389Version: 2.0.0
390--------------
391
Gildas Lanilis82799c72018-05-30 13:22:48 -0700392:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400393
394**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400395
Lusheng Jib2a561b2018-03-27 23:24:33 -0400396DCAE R2 improves upon previous release with the following new features:
397
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200398- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400399 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400400 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400401 - Bootstrap container
402 - Configuration Binding Service
403 - Deployment Handler
404 - Policy Handler
405 - Service Change Handler
406 - Inventory API
407 - Service components
408 - VES Collector
409 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400410 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400411 - Holmes Rule Management *
412 - Holmes Engine Management *
413 - Additional resources that DCAE utilizes:
414 - Postgres Database
415 - Redis Cluster Database
416 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400417
Lusheng Ji768421b2018-06-01 16:36:54 -0400418 Notes:
419 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400420
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200421- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400422
Lusheng Ji768421b2018-06-01 16:36:54 -0400423 - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
Lusheng Jieaac78d2018-06-06 00:20:03 -0400424 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400425
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200426- DCAE R2 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Lusheng Ji768421b2018-06-01 16:36:54 -0400427
428- All DCAE components are designed to support platform maturity requirements.
429
430
431**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400432
433Source code of DCAE components are released under the following repositories on gerrit.onap.org:
434 - dcaegen2
435 - dcaegen2.analytics
436 - dcaegen2.analytics.tca
437 - dcaegen2.collectors
438 - dcaegen2.collectors.snmptrap
439 - dcaegen2.collectors.ves
440 - dcaegen2.deployments
441 - dcaegen2.platform
442 - dcaegen2.platform.blueprints
443 - dcaegen2.platform.cli
444 - dcaegen2.platform.configbinding
445 - dcaegen2.platform.deployment-handler
446 - dcaegen2.platform.inventory-api
447 - dcaegen2.platform.plugins
448 - dcaegen2.platform.policy-handler
449 - dcaegen2.platform.servicechange-handler
450 - dcaegen2.services.heartbeat
451 - dcaegen2.services.mapper
452 - dcaegen2.services.prh
453 - dcaegen2.utils
454
455**Bug Fixes**
456
457**Known Issues**
458
Lusheng Ji768421b2018-06-01 16:36:54 -0400459- DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine. Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image. DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
460
Gildas Lanilis82799c72018-05-30 13:22:48 -0700461**Security Notes**
462
463DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
464
465Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400466 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
467
468 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
469
470 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
471
472
Lusheng Jib2a561b2018-03-27 23:24:33 -0400473
474**Upgrade Notes**
475
Lusheng Ji768421b2018-06-01 16:36:54 -0400476The following components are upgraded from R1:
477 - Cloudify Manager:
478 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
479 - Description: R2 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200480 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400481 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400482 - Description: R2 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications. The bootstrap is for OOM (Kubernetes) based deployment.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200483 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400484 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
485 - Description: Configuration Binding Sevice now supports the new configuration policy format.
486 - Deployment Handler
487 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
488 - Policy Handler
489 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
490 - Description: Policy Handler now supports the new configuration policy format.
491 - Service Change Handler
492 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
493 - Description: Refactoring.
494 - Inventory API
495 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
496 - Description: Refactoring.
497 - VES Collector
498 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
499 - Threshold Crossing Analytics
500 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
501 - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
502
Lusheng Jib2a561b2018-03-27 23:24:33 -0400503
504
Lusheng Ji8fafa432017-11-06 21:52:26 -0500505Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000506--------------
507
Lusheng Ji8fafa432017-11-06 21:52:26 -0500508:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000509
510
511**New Features**
512
Lusheng Ji8fafa432017-11-06 21:52:26 -0500513DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
514sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
515DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
516vDNS, vCPU, and vVoLTE.
517
518Specifically, DCAE R1 includes the following components:
519
520- Core platform
521 - Cloudify manager
522 - Consul cluster
523- Extended platform
524 - Platform component docker host
525 - Service component docker host
526 - CDAP cluster
527 - PostgreSQL database (*)
528- Platform docker container components
529 - Configuration binding service
530 - Deployment handler
531 - Service change handler
532 - Inventory
533 - Policy handler
534 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200535- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500536 - Docker container components
537 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000538 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500539 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000540 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500541
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200542(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
543VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500544other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200545(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500546in R1.
547
548Source codes of DCAE are released under the following repositories on gerrit.onap.org:
549
550- dcaegen2
551- dcaegen2/analytics
552- dcaegen2/analytics/tca
553- dcaegen2/collectors
554- dcaegen2/collectors/snmptrap
555- dcaegen2/collectors/ves
556- dcaegen2/deployments
557- dcaegen2/platform
558- dcaegen2/platform/blueprints
559- dcaegen2/platform/cdapbroker
560- dcaegen2/platform/cli
561- dcaegen2/platform/configbinding
562- dcaegen2/platform/deployment-handler
563- dcaegen2/platform/inventory-api
564- dcaegen2/platform/plugins
565- dcaegen2/platform/policy-handler
566- dcaegen2/platform/servicechange-handler
567- dcaegen2/utils
568
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000569
570**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500571
572This is the initial release.
573
574
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000575**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500576
577- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
578- Need to provide a dev configuration DCAE.
579
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000580
581**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000582
ankatare30c4cb42018-09-28 14:26:59 +0530583- The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches. This key is currently passed in as a Heat template parameter. Tracked by JIRA `DCAEGEN2-178 <https://jira.onap.org/browse/DCAEGEN2-178>`_.>`_.
Lusheng Jieaac78d2018-06-06 00:20:03 -0400584- The RESTful API calls are generally not secure. That is, they are either over http, or https without certificate verification. Once there is an ONAP wide solution for handling certificates, DCAE will switch to https.
585
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000586
587**Upgrade Notes**
588
Lusheng Ji8fafa432017-11-06 21:52:26 -0500589This is the initial release.
590
591
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000592**Deprecation Notes**
593
Lusheng Ji8fafa432017-11-06 21:52:26 -0500594There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
595DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
596following Gerrit repos are voided and already locked as read-only.
597
598- dcae
599- dcae/apod
600- dcae/apod/analytics
601- dcae/apod/buildtools
602- dcae/apod/cdap
603- dcae/collectors
604- dcae/collectors/ves
605- dcae/controller
606- dcae/controller/analytics
607- dcae/dcae-inventory
608- dcae/demo
609- dcae/demo/startup
610- dcae/demo/startup/aaf
611- dcae/demo/startup/controller
612- dcae/demo/startup/message-router
613- dcae/dmaapbc
614- dcae/operation
615- dcae/operation/utils
616- dcae/orch-dispatcher
617- dcae/pgaas
618- dcae/utils
619- dcae/utils/buildtools
620- ncomp
621- ncomp/cdap
622- ncomp/core
623- ncomp/docker
624- ncomp/maven
625- ncomp/openstack
626- ncomp/sirius
627- ncomp/sirius/manager
628- ncomp/utils
629
630
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000631**Other**
632
Vijay0fbc6732017-11-08 13:55:01 +0000633SNMP trap collector is seed code delivery only.