blob: b26dacc44da67996ed444cba40d6ad48f70efc11 [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 Opasiakd9e8b342019-05-27 18:06:32 +0200110
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200111*Known Vulnerabilities in Used Modules*
112
Vijay VK6b0fa462019-05-20 16:06:11 +0100113DCAE 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>`_.
114
115Quick Links:
116 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
117
118 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
119
120 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
121
122
123**New component Notes**
124The following components are introduced in R4
125
126 - Dashboard
127 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
128 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
129 - Blueprint generator
130 - 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 +0200131 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100132 - RESTConf collector 
133 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
134 - Description: Provides RESTConf interfaces to events from external domain controllers
135 - VES/Universal Mapper
136 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200137 - 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 +0100138 - 3gpp PM-Mapper
139 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200140 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100141 - BBS Event processor
142 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200143 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100144 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100145 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200146 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100147 - Heartbeat MS
148 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
149 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200150
Vijay VK6b0fa462019-05-20 16:06:11 +0100151
152**Upgrade Notes**
153
154The following components are upgraded from R3
155 - Cloudify Manager:
156 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
157 - 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 +0200158 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100159 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200160 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
161 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100162 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
163 - Description: Code optimization and bug fixes
164 - Deployment Handler
165 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
166 - Include updates for health and service endpoint check and bug fixes
167 - Policy Handler
168 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
169 - Description: Policy Handler supports the new lifecycle API's from Policy framework
170 - Service Change Handler
171 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
172 - Description: No update from R3
173 - Inventory API
174 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
175 - Description: Refactoring and updates for health and service endpoint check
176 - VES Collector
177 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200178 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100179 - Threshold Crossing Analytics
180 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
181 - 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.
182 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100183 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100184 - Description : Code optimization, bug fixes, logging and performance improvement
185 - PNF Registrator handler
186 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200187 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100188 - HV-VES Collector
189 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
190 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
191 - SNMP Trap Collector
192 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200193 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100194
195
196
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500197
198Version: 3.0.1
199--------------
200
201:Release Date: 2019-01-31
202
203DCAE R3 Maintenance release includes following fixes
204
205**Bug Fixes**
206
207- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200208 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500209 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200210 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500211 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200212 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500213 Multiple Fileready notification not handled
214
215- HighVolume VES Collector (protobuf/tcp)
216 - DCAEGEN2-976
217 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
218
219- VESCollector (http)
220 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200221 Issue with VES batch event publish
222
223- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500224 - DCAEGEN2-1007
225 Removing obsolete services configuration
226
227
228The following containers are updated in R3.0.1
229
230 - DataFile Collector
231 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
232 - HV-VES Collector
233 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
234 - VES Collector
235 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
236
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500237**Known Issues**
238
239- 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
240
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200241- 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 +0100242 kubectl get deployments -n onap | grep deployment-handler
243 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
244 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
245
246
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500247
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500248
Vijay VK2648c6d2018-09-19 04:30:37 +0100249Version: 3.0.0
250--------------
251
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800252:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100253
254**New Features**
255
256DCAE R3 improves upon previous release with the following new features:
257
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200258- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100259 - Platform components
260 - Cloudify Manager
261 - Bootstrap container
262 - Configuration Binding Service
263 - Deployment Handler
264 - Policy Handler
265 - Service Change Handler
266 - Inventory API
267 - Service components
268 - VES Collector
269 - SNMP Collector
270 - Threshold Crossing Analytics
271 - Holmes Rule Management *
272 - Holmes Engine Management *
273 - Additional resources that DCAE utilizes:
274 - Postgres Database
275 - Redis Cluster Database
276 - Consul Cluster
277
278 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000279 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100280
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200281- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100282
283 - 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".
284 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
285
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200286- 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 +0100287
288- All DCAE components are designed to support platform maturity requirements.
289
290
291**Source Code**
292
293Source code of DCAE components are released under the following repositories on gerrit.onap.org:
294 - dcaegen2
295 - dcaegen2.analytics
296 - dcaegen2.analytics.tca
297 - dcaegen2.collectors
298 - dcaegen2.collectors.snmptrap
299 - dcaegen2.collectors.ves
300 - dcaegen2.collectors.hv-ves
301 - dcaegen2.collectors.datafile
302 - dcaegen2.deployments
303 - dcaegen2.platform
304 - dcaegen2.platform.blueprints
305 - dcaegen2.platform.cli
306 - dcaegen2.platform.configbinding
307 - dcaegen2.platform.deployment-handler
308 - dcaegen2.platform.inventory-api
309 - dcaegen2.platform.plugins
310 - dcaegen2.platform.policy-handler
311 - dcaegen2.platform.servicechange-handler
312 - dcaegen2.services.heartbeat
313 - dcaegen2.services.mapper
314 - dcaegen2.services.prh
315 - dcaegen2.utils
316
317**Bug Fixes**
318
319**Known Issues**
320
321- 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.
322
323**Security Notes**
324
325DCAE 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>`_.
326
327Quick Links:
328 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
329
330 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
331
Vijay VKab471f62018-11-26 17:49:43 +0000332 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100333
334
Vijay VKf6659fc2018-11-02 05:07:27 +0100335**New component Notes**
336The following components are introduced in R3
337
338 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000339 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100340 - Description : Bulk data file collector to fetch non-realtime PM data
341 - PNF Registrator handler
342 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200343 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100344 - HV-VES Collector
345 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
346 - Description : High Volume VES Collector for fetching real-time PM measurement data
347 - SNMP Trap Collector
348 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200349 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100350
Vijay VK2648c6d2018-09-19 04:30:37 +0100351
352**Upgrade Notes**
353
354The following components are upgraded from R2:
355 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100356 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100357 - 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 +0200358 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100359 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100360 - 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 +0200361 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100362 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
363 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
364 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100365 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100366 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100367 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100368 - Description: Policy Handler now supports the new configuration policy format and support for TLS
369 - Service Change Handler
370 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
371 - Description: Refactoring.
372 - Inventory API
373 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
374 - Description: Refactoring.
375 - VES Collector
376 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500377 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100378 - Threshold Crossing Analytics
379 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
380 - 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.
381
382
383
384
Lusheng Jib2a561b2018-03-27 23:24:33 -0400385Version: 2.0.0
386--------------
387
Gildas Lanilis82799c72018-05-30 13:22:48 -0700388:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400389
390**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400391
Lusheng Jib2a561b2018-03-27 23:24:33 -0400392DCAE R2 improves upon previous release with the following new features:
393
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200394- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400395 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400396 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400397 - Bootstrap container
398 - Configuration Binding Service
399 - Deployment Handler
400 - Policy Handler
401 - Service Change Handler
402 - Inventory API
403 - Service components
404 - VES Collector
405 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400406 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400407 - Holmes Rule Management *
408 - Holmes Engine Management *
409 - Additional resources that DCAE utilizes:
410 - Postgres Database
411 - Redis Cluster Database
412 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400413
Lusheng Ji768421b2018-06-01 16:36:54 -0400414 Notes:
415 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400416
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200417- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400418
Lusheng Ji768421b2018-06-01 16:36:54 -0400419 - 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 -0400420 - 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 -0400421
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200422- 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 -0400423
424- All DCAE components are designed to support platform maturity requirements.
425
426
427**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400428
429Source code of DCAE components are released under the following repositories on gerrit.onap.org:
430 - dcaegen2
431 - dcaegen2.analytics
432 - dcaegen2.analytics.tca
433 - dcaegen2.collectors
434 - dcaegen2.collectors.snmptrap
435 - dcaegen2.collectors.ves
436 - dcaegen2.deployments
437 - dcaegen2.platform
438 - dcaegen2.platform.blueprints
439 - dcaegen2.platform.cli
440 - dcaegen2.platform.configbinding
441 - dcaegen2.platform.deployment-handler
442 - dcaegen2.platform.inventory-api
443 - dcaegen2.platform.plugins
444 - dcaegen2.platform.policy-handler
445 - dcaegen2.platform.servicechange-handler
446 - dcaegen2.services.heartbeat
447 - dcaegen2.services.mapper
448 - dcaegen2.services.prh
449 - dcaegen2.utils
450
451**Bug Fixes**
452
453**Known Issues**
454
Lusheng Ji768421b2018-06-01 16:36:54 -0400455- 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.
456
Gildas Lanilis82799c72018-05-30 13:22:48 -0700457**Security Notes**
458
459DCAE 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>`_.
460
461Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400462 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
463
464 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
465
466 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
467
468
Lusheng Jib2a561b2018-03-27 23:24:33 -0400469
470**Upgrade Notes**
471
Lusheng Ji768421b2018-06-01 16:36:54 -0400472The following components are upgraded from R1:
473 - Cloudify Manager:
474 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
475 - 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 +0200476 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400477 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400478 - 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 +0200479 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400480 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
481 - Description: Configuration Binding Sevice now supports the new configuration policy format.
482 - Deployment Handler
483 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
484 - Policy Handler
485 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
486 - Description: Policy Handler now supports the new configuration policy format.
487 - Service Change Handler
488 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
489 - Description: Refactoring.
490 - Inventory API
491 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
492 - Description: Refactoring.
493 - VES Collector
494 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
495 - Threshold Crossing Analytics
496 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
497 - 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.
498
Lusheng Jib2a561b2018-03-27 23:24:33 -0400499
500
Lusheng Ji8fafa432017-11-06 21:52:26 -0500501Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000502--------------
503
Lusheng Ji8fafa432017-11-06 21:52:26 -0500504:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000505
506
507**New Features**
508
Lusheng Ji8fafa432017-11-06 21:52:26 -0500509DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
510sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
511DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
512vDNS, vCPU, and vVoLTE.
513
514Specifically, DCAE R1 includes the following components:
515
516- Core platform
517 - Cloudify manager
518 - Consul cluster
519- Extended platform
520 - Platform component docker host
521 - Service component docker host
522 - CDAP cluster
523 - PostgreSQL database (*)
524- Platform docker container components
525 - Configuration binding service
526 - Deployment handler
527 - Service change handler
528 - Inventory
529 - Policy handler
530 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200531- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500532 - Docker container components
533 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000534 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500535 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000536 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500537
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200538(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
539VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500540other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200541(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500542in R1.
543
544Source codes of DCAE are released under the following repositories on gerrit.onap.org:
545
546- dcaegen2
547- dcaegen2/analytics
548- dcaegen2/analytics/tca
549- dcaegen2/collectors
550- dcaegen2/collectors/snmptrap
551- dcaegen2/collectors/ves
552- dcaegen2/deployments
553- dcaegen2/platform
554- dcaegen2/platform/blueprints
555- dcaegen2/platform/cdapbroker
556- dcaegen2/platform/cli
557- dcaegen2/platform/configbinding
558- dcaegen2/platform/deployment-handler
559- dcaegen2/platform/inventory-api
560- dcaegen2/platform/plugins
561- dcaegen2/platform/policy-handler
562- dcaegen2/platform/servicechange-handler
563- dcaegen2/utils
564
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000565
566**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500567
568This is the initial release.
569
570
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000571**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500572
573- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
574- Need to provide a dev configuration DCAE.
575
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000576
577**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000578
ankatare30c4cb42018-09-28 14:26:59 +0530579- 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 -0400580- 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.
581
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000582
583**Upgrade Notes**
584
Lusheng Ji8fafa432017-11-06 21:52:26 -0500585This is the initial release.
586
587
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000588**Deprecation Notes**
589
Lusheng Ji8fafa432017-11-06 21:52:26 -0500590There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
591DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
592following Gerrit repos are voided and already locked as read-only.
593
594- dcae
595- dcae/apod
596- dcae/apod/analytics
597- dcae/apod/buildtools
598- dcae/apod/cdap
599- dcae/collectors
600- dcae/collectors/ves
601- dcae/controller
602- dcae/controller/analytics
603- dcae/dcae-inventory
604- dcae/demo
605- dcae/demo/startup
606- dcae/demo/startup/aaf
607- dcae/demo/startup/controller
608- dcae/demo/startup/message-router
609- dcae/dmaapbc
610- dcae/operation
611- dcae/operation/utils
612- dcae/orch-dispatcher
613- dcae/pgaas
614- dcae/utils
615- dcae/utils/buildtools
616- ncomp
617- ncomp/cdap
618- ncomp/core
619- ncomp/docker
620- ncomp/maven
621- ncomp/openstack
622- ncomp/sirius
623- ncomp/sirius/manager
624- ncomp/utils
625
626
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000627**Other**
628
Vijay0fbc6732017-11-08 13:55:01 +0000629SNMP trap collector is seed code delivery only.