blob: 12ba12b0ae8c8ed33ff4ff223e4cb7e808d110c4 [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 Opasiakd9e8b342019-05-27 18:06:32 +0200108 * 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 +0200109 * 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 +0200110 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200111
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200112*Known Vulnerabilities in Used Modules*
113
Vijay VK6b0fa462019-05-20 16:06:11 +0100114DCAE 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>`_.
115
116Quick Links:
117 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
118
119 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
120
121 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
122
123
124**New component Notes**
125The following components are introduced in R4
126
127 - Dashboard
128 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
129 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
130 - Blueprint generator
131 - 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 +0200132 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100133 - RESTConf collector 
134 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
135 - Description: Provides RESTConf interfaces to events from external domain controllers
136 - VES/Universal Mapper
137 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200138 - 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 +0100139 - 3gpp PM-Mapper
140 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200141 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100142 - BBS Event processor
143 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200144 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100145 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100146 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200147 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100148 - Heartbeat MS
149 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
150 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200151
Vijay VK6b0fa462019-05-20 16:06:11 +0100152
153**Upgrade Notes**
154
155The following components are upgraded from R3
156 - Cloudify Manager:
157 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
158 - 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 +0200159 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100160 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200161 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
162 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100163 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
164 - Description: Code optimization and bug fixes
165 - Deployment Handler
166 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
167 - Include updates for health and service endpoint check and bug fixes
168 - Policy Handler
169 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
170 - Description: Policy Handler supports the new lifecycle API's from Policy framework
171 - Service Change Handler
172 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
173 - Description: No update from R3
174 - Inventory API
175 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
176 - Description: Refactoring and updates for health and service endpoint check
177 - VES Collector
178 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200179 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100180 - Threshold Crossing Analytics
181 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
182 - 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.
183 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100184 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100185 - Description : Code optimization, bug fixes, logging and performance improvement
186 - PNF Registrator handler
187 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200188 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100189 - HV-VES Collector
190 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
191 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
192 - SNMP Trap Collector
193 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200194 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100195
196
197
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500198
199Version: 3.0.1
200--------------
201
202:Release Date: 2019-01-31
203
204DCAE R3 Maintenance release includes following fixes
205
206**Bug Fixes**
207
208- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200209 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500210 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200211 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500212 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200213 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500214 Multiple Fileready notification not handled
215
216- HighVolume VES Collector (protobuf/tcp)
217 - DCAEGEN2-976
218 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
219
220- VESCollector (http)
221 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200222 Issue with VES batch event publish
223
224- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500225 - DCAEGEN2-1007
226 Removing obsolete services configuration
227
228
229The following containers are updated in R3.0.1
230
231 - DataFile Collector
232 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
233 - HV-VES Collector
234 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
235 - VES Collector
236 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
237
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500238**Known Issues**
239
240- 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
241
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200242- 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 +0100243 kubectl get deployments -n onap | grep deployment-handler
244 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
245 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
246
247
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500248
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500249
Vijay VK2648c6d2018-09-19 04:30:37 +0100250Version: 3.0.0
251--------------
252
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800253:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100254
255**New Features**
256
257DCAE R3 improves upon previous release with the following new features:
258
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200259- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100260 - Platform components
261 - Cloudify Manager
262 - Bootstrap container
263 - Configuration Binding Service
264 - Deployment Handler
265 - Policy Handler
266 - Service Change Handler
267 - Inventory API
268 - Service components
269 - VES Collector
270 - SNMP Collector
271 - Threshold Crossing Analytics
272 - Holmes Rule Management *
273 - Holmes Engine Management *
274 - Additional resources that DCAE utilizes:
275 - Postgres Database
276 - Redis Cluster Database
277 - Consul Cluster
278
279 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000280 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100281
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200282- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100283
284 - 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".
285 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
286
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200287- 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 +0100288
289- All DCAE components are designed to support platform maturity requirements.
290
291
292**Source Code**
293
294Source code of DCAE components are released under the following repositories on gerrit.onap.org:
295 - dcaegen2
296 - dcaegen2.analytics
297 - dcaegen2.analytics.tca
298 - dcaegen2.collectors
299 - dcaegen2.collectors.snmptrap
300 - dcaegen2.collectors.ves
301 - dcaegen2.collectors.hv-ves
302 - dcaegen2.collectors.datafile
303 - dcaegen2.deployments
304 - dcaegen2.platform
305 - dcaegen2.platform.blueprints
306 - dcaegen2.platform.cli
307 - dcaegen2.platform.configbinding
308 - dcaegen2.platform.deployment-handler
309 - dcaegen2.platform.inventory-api
310 - dcaegen2.platform.plugins
311 - dcaegen2.platform.policy-handler
312 - dcaegen2.platform.servicechange-handler
313 - dcaegen2.services.heartbeat
314 - dcaegen2.services.mapper
315 - dcaegen2.services.prh
316 - dcaegen2.utils
317
318**Bug Fixes**
319
320**Known Issues**
321
322- 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.
323
324**Security Notes**
325
326DCAE 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>`_.
327
328Quick Links:
329 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
330
331 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
332
Vijay VKab471f62018-11-26 17:49:43 +0000333 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100334
335
Vijay VKf6659fc2018-11-02 05:07:27 +0100336**New component Notes**
337The following components are introduced in R3
338
339 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000340 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100341 - Description : Bulk data file collector to fetch non-realtime PM data
342 - PNF Registrator handler
343 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200344 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100345 - HV-VES Collector
346 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
347 - Description : High Volume VES Collector for fetching real-time PM measurement data
348 - SNMP Trap Collector
349 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200350 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100351
Vijay VK2648c6d2018-09-19 04:30:37 +0100352
353**Upgrade Notes**
354
355The following components are upgraded from R2:
356 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100357 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100358 - 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 +0200359 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100360 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100361 - 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 +0200362 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100363 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
364 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
365 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100366 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100367 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100368 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100369 - Description: Policy Handler now supports the new configuration policy format and support for TLS
370 - Service Change Handler
371 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
372 - Description: Refactoring.
373 - Inventory API
374 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
375 - Description: Refactoring.
376 - VES Collector
377 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500378 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100379 - Threshold Crossing Analytics
380 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
381 - 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.
382
383
384
385
Lusheng Jib2a561b2018-03-27 23:24:33 -0400386Version: 2.0.0
387--------------
388
Gildas Lanilis82799c72018-05-30 13:22:48 -0700389:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400390
391**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400392
Lusheng Jib2a561b2018-03-27 23:24:33 -0400393DCAE R2 improves upon previous release with the following new features:
394
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200395- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400396 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400397 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400398 - Bootstrap container
399 - Configuration Binding Service
400 - Deployment Handler
401 - Policy Handler
402 - Service Change Handler
403 - Inventory API
404 - Service components
405 - VES Collector
406 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400407 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400408 - Holmes Rule Management *
409 - Holmes Engine Management *
410 - Additional resources that DCAE utilizes:
411 - Postgres Database
412 - Redis Cluster Database
413 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400414
Lusheng Ji768421b2018-06-01 16:36:54 -0400415 Notes:
416 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400417
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200418- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400419
Lusheng Ji768421b2018-06-01 16:36:54 -0400420 - 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 -0400421 - 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 -0400422
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200423- 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 -0400424
425- All DCAE components are designed to support platform maturity requirements.
426
427
428**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400429
430Source code of DCAE components are released under the following repositories on gerrit.onap.org:
431 - dcaegen2
432 - dcaegen2.analytics
433 - dcaegen2.analytics.tca
434 - dcaegen2.collectors
435 - dcaegen2.collectors.snmptrap
436 - dcaegen2.collectors.ves
437 - dcaegen2.deployments
438 - dcaegen2.platform
439 - dcaegen2.platform.blueprints
440 - dcaegen2.platform.cli
441 - dcaegen2.platform.configbinding
442 - dcaegen2.platform.deployment-handler
443 - dcaegen2.platform.inventory-api
444 - dcaegen2.platform.plugins
445 - dcaegen2.platform.policy-handler
446 - dcaegen2.platform.servicechange-handler
447 - dcaegen2.services.heartbeat
448 - dcaegen2.services.mapper
449 - dcaegen2.services.prh
450 - dcaegen2.utils
451
452**Bug Fixes**
453
454**Known Issues**
455
Lusheng Ji768421b2018-06-01 16:36:54 -0400456- 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.
457
Gildas Lanilis82799c72018-05-30 13:22:48 -0700458**Security Notes**
459
460DCAE 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>`_.
461
462Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400463 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
464
465 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
466
467 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
468
469
Lusheng Jib2a561b2018-03-27 23:24:33 -0400470
471**Upgrade Notes**
472
Lusheng Ji768421b2018-06-01 16:36:54 -0400473The following components are upgraded from R1:
474 - Cloudify Manager:
475 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
476 - 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 +0200477 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400478 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400479 - 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 +0200480 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400481 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
482 - Description: Configuration Binding Sevice now supports the new configuration policy format.
483 - Deployment Handler
484 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
485 - Policy Handler
486 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
487 - Description: Policy Handler now supports the new configuration policy format.
488 - Service Change Handler
489 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
490 - Description: Refactoring.
491 - Inventory API
492 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
493 - Description: Refactoring.
494 - VES Collector
495 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
496 - Threshold Crossing Analytics
497 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
498 - 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.
499
Lusheng Jib2a561b2018-03-27 23:24:33 -0400500
501
Lusheng Ji8fafa432017-11-06 21:52:26 -0500502Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000503--------------
504
Lusheng Ji8fafa432017-11-06 21:52:26 -0500505:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000506
507
508**New Features**
509
Lusheng Ji8fafa432017-11-06 21:52:26 -0500510DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
511sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
512DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
513vDNS, vCPU, and vVoLTE.
514
515Specifically, DCAE R1 includes the following components:
516
517- Core platform
518 - Cloudify manager
519 - Consul cluster
520- Extended platform
521 - Platform component docker host
522 - Service component docker host
523 - CDAP cluster
524 - PostgreSQL database (*)
525- Platform docker container components
526 - Configuration binding service
527 - Deployment handler
528 - Service change handler
529 - Inventory
530 - Policy handler
531 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200532- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500533 - Docker container components
534 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000535 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500536 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000537 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500538
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200539(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
540VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500541other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200542(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500543in R1.
544
545Source codes of DCAE are released under the following repositories on gerrit.onap.org:
546
547- dcaegen2
548- dcaegen2/analytics
549- dcaegen2/analytics/tca
550- dcaegen2/collectors
551- dcaegen2/collectors/snmptrap
552- dcaegen2/collectors/ves
553- dcaegen2/deployments
554- dcaegen2/platform
555- dcaegen2/platform/blueprints
556- dcaegen2/platform/cdapbroker
557- dcaegen2/platform/cli
558- dcaegen2/platform/configbinding
559- dcaegen2/platform/deployment-handler
560- dcaegen2/platform/inventory-api
561- dcaegen2/platform/plugins
562- dcaegen2/platform/policy-handler
563- dcaegen2/platform/servicechange-handler
564- dcaegen2/utils
565
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000566
567**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500568
569This is the initial release.
570
571
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000572**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500573
574- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
575- Need to provide a dev configuration DCAE.
576
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000577
578**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000579
ankatare30c4cb42018-09-28 14:26:59 +0530580- 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 -0400581- 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.
582
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000583
584**Upgrade Notes**
585
Lusheng Ji8fafa432017-11-06 21:52:26 -0500586This is the initial release.
587
588
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000589**Deprecation Notes**
590
Lusheng Ji8fafa432017-11-06 21:52:26 -0500591There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
592DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
593following Gerrit repos are voided and already locked as read-only.
594
595- dcae
596- dcae/apod
597- dcae/apod/analytics
598- dcae/apod/buildtools
599- dcae/apod/cdap
600- dcae/collectors
601- dcae/collectors/ves
602- dcae/controller
603- dcae/controller/analytics
604- dcae/dcae-inventory
605- dcae/demo
606- dcae/demo/startup
607- dcae/demo/startup/aaf
608- dcae/demo/startup/controller
609- dcae/demo/startup/message-router
610- dcae/dmaapbc
611- dcae/operation
612- dcae/operation/utils
613- dcae/orch-dispatcher
614- dcae/pgaas
615- dcae/utils
616- dcae/utils/buildtools
617- ncomp
618- ncomp/cdap
619- ncomp/core
620- ncomp/docker
621- ncomp/maven
622- ncomp/openstack
623- ncomp/sirius
624- ncomp/sirius/manager
625- ncomp/utils
626
627
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000628**Other**
629
Vijay0fbc6732017-11-08 13:55:01 +0000630SNMP trap collector is seed code delivery only.