blob: e43b1c502e278d0f8cf079e1c6df2b4f66389361 [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
108*Known Vulnerabilities in Used Modules*
109
Vijay VK6b0fa462019-05-20 16:06:11 +0100110DCAE 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>`_.
111
112Quick Links:
113 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
114
115 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
116
117 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
118
119
120**New component Notes**
121The following components are introduced in R4
122
123 - Dashboard
124 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
125 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
126 - Blueprint generator
127 - 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 +0200128 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100129 - RESTConf collector 
130 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
131 - Description: Provides RESTConf interfaces to events from external domain controllers
132 - VES/Universal Mapper
133 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200134 - 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 +0100135 - 3gpp PM-Mapper
136 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200137 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100138 - BBS Event processor
139 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200140 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100141 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100142 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200143 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100144 - Heartbeat MS
145 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
146 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200147
Vijay VK6b0fa462019-05-20 16:06:11 +0100148
149**Upgrade Notes**
150
151The following components are upgraded from R3
152 - Cloudify Manager:
153 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
154 - 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 +0200155 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100156 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200157 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
158 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100159 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
160 - Description: Code optimization and bug fixes
161 - Deployment Handler
162 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
163 - Include updates for health and service endpoint check and bug fixes
164 - Policy Handler
165 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
166 - Description: Policy Handler supports the new lifecycle API's from Policy framework
167 - Service Change Handler
168 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
169 - Description: No update from R3
170 - Inventory API
171 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
172 - Description: Refactoring and updates for health and service endpoint check
173 - VES Collector
174 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200175 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100176 - Threshold Crossing Analytics
177 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
178 - 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.
179 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100180 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100181 - Description : Code optimization, bug fixes, logging and performance improvement
182 - PNF Registrator handler
183 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200184 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100185 - HV-VES Collector
186 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
187 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
188 - SNMP Trap Collector
189 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200190 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100191
192
193
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500194
195Version: 3.0.1
196--------------
197
198:Release Date: 2019-01-31
199
200DCAE R3 Maintenance release includes following fixes
201
202**Bug Fixes**
203
204- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200205 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500206 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200207 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500208 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200209 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500210 Multiple Fileready notification not handled
211
212- HighVolume VES Collector (protobuf/tcp)
213 - DCAEGEN2-976
214 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
215
216- VESCollector (http)
217 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200218 Issue with VES batch event publish
219
220- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500221 - DCAEGEN2-1007
222 Removing obsolete services configuration
223
224
225The following containers are updated in R3.0.1
226
227 - DataFile Collector
228 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
229 - HV-VES Collector
230 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
231 - VES Collector
232 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
233
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500234**Known Issues**
235
236- 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
237
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200238- 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 +0100239 kubectl get deployments -n onap | grep deployment-handler
240 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
241 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
242
243
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500244
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500245
Vijay VK2648c6d2018-09-19 04:30:37 +0100246Version: 3.0.0
247--------------
248
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800249:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100250
251**New Features**
252
253DCAE R3 improves upon previous release with the following new features:
254
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200255- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100256 - Platform components
257 - Cloudify Manager
258 - Bootstrap container
259 - Configuration Binding Service
260 - Deployment Handler
261 - Policy Handler
262 - Service Change Handler
263 - Inventory API
264 - Service components
265 - VES Collector
266 - SNMP Collector
267 - Threshold Crossing Analytics
268 - Holmes Rule Management *
269 - Holmes Engine Management *
270 - Additional resources that DCAE utilizes:
271 - Postgres Database
272 - Redis Cluster Database
273 - Consul Cluster
274
275 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000276 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100277
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200278- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100279
280 - 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".
281 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
282
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200283- 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 +0100284
285- All DCAE components are designed to support platform maturity requirements.
286
287
288**Source Code**
289
290Source code of DCAE components are released under the following repositories on gerrit.onap.org:
291 - dcaegen2
292 - dcaegen2.analytics
293 - dcaegen2.analytics.tca
294 - dcaegen2.collectors
295 - dcaegen2.collectors.snmptrap
296 - dcaegen2.collectors.ves
297 - dcaegen2.collectors.hv-ves
298 - dcaegen2.collectors.datafile
299 - dcaegen2.deployments
300 - dcaegen2.platform
301 - dcaegen2.platform.blueprints
302 - dcaegen2.platform.cli
303 - dcaegen2.platform.configbinding
304 - dcaegen2.platform.deployment-handler
305 - dcaegen2.platform.inventory-api
306 - dcaegen2.platform.plugins
307 - dcaegen2.platform.policy-handler
308 - dcaegen2.platform.servicechange-handler
309 - dcaegen2.services.heartbeat
310 - dcaegen2.services.mapper
311 - dcaegen2.services.prh
312 - dcaegen2.utils
313
314**Bug Fixes**
315
316**Known Issues**
317
318- 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.
319
320**Security Notes**
321
322DCAE 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>`_.
323
324Quick Links:
325 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
326
327 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
328
Vijay VKab471f62018-11-26 17:49:43 +0000329 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100330
331
Vijay VKf6659fc2018-11-02 05:07:27 +0100332**New component Notes**
333The following components are introduced in R3
334
335 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000336 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100337 - Description : Bulk data file collector to fetch non-realtime PM data
338 - PNF Registrator handler
339 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200340 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100341 - HV-VES Collector
342 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
343 - Description : High Volume VES Collector for fetching real-time PM measurement data
344 - SNMP Trap Collector
345 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200346 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100347
Vijay VK2648c6d2018-09-19 04:30:37 +0100348
349**Upgrade Notes**
350
351The following components are upgraded from R2:
352 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100353 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100354 - 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 +0200355 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100356 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100357 - 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 +0200358 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100359 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
360 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
361 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100362 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100363 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100364 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100365 - Description: Policy Handler now supports the new configuration policy format and support for TLS
366 - Service Change Handler
367 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
368 - Description: Refactoring.
369 - Inventory API
370 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
371 - Description: Refactoring.
372 - VES Collector
373 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500374 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100375 - Threshold Crossing Analytics
376 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
377 - 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.
378
379
380
381
Lusheng Jib2a561b2018-03-27 23:24:33 -0400382Version: 2.0.0
383--------------
384
Gildas Lanilis82799c72018-05-30 13:22:48 -0700385:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400386
387**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400388
Lusheng Jib2a561b2018-03-27 23:24:33 -0400389DCAE R2 improves upon previous release with the following new features:
390
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200391- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400392 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400393 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400394 - Bootstrap container
395 - Configuration Binding Service
396 - Deployment Handler
397 - Policy Handler
398 - Service Change Handler
399 - Inventory API
400 - Service components
401 - VES Collector
402 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400403 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400404 - Holmes Rule Management *
405 - Holmes Engine Management *
406 - Additional resources that DCAE utilizes:
407 - Postgres Database
408 - Redis Cluster Database
409 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400410
Lusheng Ji768421b2018-06-01 16:36:54 -0400411 Notes:
412 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400413
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200414- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400415
Lusheng Ji768421b2018-06-01 16:36:54 -0400416 - 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 -0400417 - 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 -0400418
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200419- 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 -0400420
421- All DCAE components are designed to support platform maturity requirements.
422
423
424**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400425
426Source code of DCAE components are released under the following repositories on gerrit.onap.org:
427 - dcaegen2
428 - dcaegen2.analytics
429 - dcaegen2.analytics.tca
430 - dcaegen2.collectors
431 - dcaegen2.collectors.snmptrap
432 - dcaegen2.collectors.ves
433 - dcaegen2.deployments
434 - dcaegen2.platform
435 - dcaegen2.platform.blueprints
436 - dcaegen2.platform.cli
437 - dcaegen2.platform.configbinding
438 - dcaegen2.platform.deployment-handler
439 - dcaegen2.platform.inventory-api
440 - dcaegen2.platform.plugins
441 - dcaegen2.platform.policy-handler
442 - dcaegen2.platform.servicechange-handler
443 - dcaegen2.services.heartbeat
444 - dcaegen2.services.mapper
445 - dcaegen2.services.prh
446 - dcaegen2.utils
447
448**Bug Fixes**
449
450**Known Issues**
451
Lusheng Ji768421b2018-06-01 16:36:54 -0400452- 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.
453
Gildas Lanilis82799c72018-05-30 13:22:48 -0700454**Security Notes**
455
456DCAE 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>`_.
457
458Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400459 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
460
461 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
462
463 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
464
465
Lusheng Jib2a561b2018-03-27 23:24:33 -0400466
467**Upgrade Notes**
468
Lusheng Ji768421b2018-06-01 16:36:54 -0400469The following components are upgraded from R1:
470 - Cloudify Manager:
471 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
472 - 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 +0200473 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400474 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400475 - 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 +0200476 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400477 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
478 - Description: Configuration Binding Sevice now supports the new configuration policy format.
479 - Deployment Handler
480 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
481 - Policy Handler
482 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
483 - Description: Policy Handler now supports the new configuration policy format.
484 - Service Change Handler
485 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
486 - Description: Refactoring.
487 - Inventory API
488 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
489 - Description: Refactoring.
490 - VES Collector
491 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
492 - Threshold Crossing Analytics
493 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
494 - 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.
495
Lusheng Jib2a561b2018-03-27 23:24:33 -0400496
497
Lusheng Ji8fafa432017-11-06 21:52:26 -0500498Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000499--------------
500
Lusheng Ji8fafa432017-11-06 21:52:26 -0500501:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000502
503
504**New Features**
505
Lusheng Ji8fafa432017-11-06 21:52:26 -0500506DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
507sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
508DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
509vDNS, vCPU, and vVoLTE.
510
511Specifically, DCAE R1 includes the following components:
512
513- Core platform
514 - Cloudify manager
515 - Consul cluster
516- Extended platform
517 - Platform component docker host
518 - Service component docker host
519 - CDAP cluster
520 - PostgreSQL database (*)
521- Platform docker container components
522 - Configuration binding service
523 - Deployment handler
524 - Service change handler
525 - Inventory
526 - Policy handler
527 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200528- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500529 - Docker container components
530 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000531 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500532 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000533 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500534
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200535(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
536VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500537other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200538(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500539in R1.
540
541Source codes of DCAE are released under the following repositories on gerrit.onap.org:
542
543- dcaegen2
544- dcaegen2/analytics
545- dcaegen2/analytics/tca
546- dcaegen2/collectors
547- dcaegen2/collectors/snmptrap
548- dcaegen2/collectors/ves
549- dcaegen2/deployments
550- dcaegen2/platform
551- dcaegen2/platform/blueprints
552- dcaegen2/platform/cdapbroker
553- dcaegen2/platform/cli
554- dcaegen2/platform/configbinding
555- dcaegen2/platform/deployment-handler
556- dcaegen2/platform/inventory-api
557- dcaegen2/platform/plugins
558- dcaegen2/platform/policy-handler
559- dcaegen2/platform/servicechange-handler
560- dcaegen2/utils
561
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000562
563**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500564
565This is the initial release.
566
567
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000568**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500569
570- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
571- Need to provide a dev configuration DCAE.
572
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000573
574**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000575
ankatare30c4cb42018-09-28 14:26:59 +0530576- 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 -0400577- 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.
578
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000579
580**Upgrade Notes**
581
Lusheng Ji8fafa432017-11-06 21:52:26 -0500582This is the initial release.
583
584
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000585**Deprecation Notes**
586
Lusheng Ji8fafa432017-11-06 21:52:26 -0500587There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
588DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
589following Gerrit repos are voided and already locked as read-only.
590
591- dcae
592- dcae/apod
593- dcae/apod/analytics
594- dcae/apod/buildtools
595- dcae/apod/cdap
596- dcae/collectors
597- dcae/collectors/ves
598- dcae/controller
599- dcae/controller/analytics
600- dcae/dcae-inventory
601- dcae/demo
602- dcae/demo/startup
603- dcae/demo/startup/aaf
604- dcae/demo/startup/controller
605- dcae/demo/startup/message-router
606- dcae/dmaapbc
607- dcae/operation
608- dcae/operation/utils
609- dcae/orch-dispatcher
610- dcae/pgaas
611- dcae/utils
612- dcae/utils/buildtools
613- ncomp
614- ncomp/cdap
615- ncomp/core
616- ncomp/docker
617- ncomp/maven
618- ncomp/openstack
619- ncomp/sirius
620- ncomp/sirius/manager
621- ncomp/utils
622
623
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000624**Other**
625
Vijay0fbc6732017-11-08 13:55:01 +0000626SNMP trap collector is seed code delivery only.