blob: cfe484cb8a7df7a9c44bf0ead0227a03102867bf [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 Opasiak7c269dc2019-05-30 23:57:24 +0200111 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200112
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200113*Known Vulnerabilities in Used Modules*
114
Vijay VK6b0fa462019-05-20 16:06:11 +0100115DCAE 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>`_.
116
117Quick Links:
118 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
119
120 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
121
122 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
123
124
125**New component Notes**
126The following components are introduced in R4
127
128 - Dashboard
129 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
130 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
131 - Blueprint generator
132 - 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 +0200133 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100134 - RESTConf collector 
135 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
136 - Description: Provides RESTConf interfaces to events from external domain controllers
137 - VES/Universal Mapper
138 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200139 - 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 +0100140 - 3gpp PM-Mapper
141 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200142 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100143 - BBS Event processor
144 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200145 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100146 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100147 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200148 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100149 - Heartbeat MS
150 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
151 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200152
Vijay VK6b0fa462019-05-20 16:06:11 +0100153
154**Upgrade Notes**
155
156The following components are upgraded from R3
157 - Cloudify Manager:
158 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
159 - 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 +0200160 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100161 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200162 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
163 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100164 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
165 - Description: Code optimization and bug fixes
166 - Deployment Handler
167 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
168 - Include updates for health and service endpoint check and bug fixes
169 - Policy Handler
170 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
171 - Description: Policy Handler supports the new lifecycle API's from Policy framework
172 - Service Change Handler
173 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
174 - Description: No update from R3
175 - Inventory API
176 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
177 - Description: Refactoring and updates for health and service endpoint check
178 - VES Collector
179 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200180 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100181 - Threshold Crossing Analytics
182 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
183 - 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.
184 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100185 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100186 - Description : Code optimization, bug fixes, logging and performance improvement
187 - PNF Registrator handler
188 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200189 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100190 - HV-VES Collector
191 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
192 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
193 - SNMP Trap Collector
194 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200195 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100196
197
198
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500199
200Version: 3.0.1
201--------------
202
203:Release Date: 2019-01-31
204
205DCAE R3 Maintenance release includes following fixes
206
207**Bug Fixes**
208
209- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200210 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500211 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200212 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500213 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200214 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500215 Multiple Fileready notification not handled
216
217- HighVolume VES Collector (protobuf/tcp)
218 - DCAEGEN2-976
219 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
220
221- VESCollector (http)
222 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200223 Issue with VES batch event publish
224
225- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500226 - DCAEGEN2-1007
227 Removing obsolete services configuration
228
229
230The following containers are updated in R3.0.1
231
232 - DataFile Collector
233 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
234 - HV-VES Collector
235 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
236 - VES Collector
237 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
238
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500239**Known Issues**
240
241- 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
242
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200243- 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 +0100244 kubectl get deployments -n onap | grep deployment-handler
245 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
246 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
247
248
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500249
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500250
Vijay VK2648c6d2018-09-19 04:30:37 +0100251Version: 3.0.0
252--------------
253
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800254:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100255
256**New Features**
257
258DCAE R3 improves upon previous release with the following new features:
259
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200260- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100261 - Platform components
262 - Cloudify Manager
263 - Bootstrap container
264 - Configuration Binding Service
265 - Deployment Handler
266 - Policy Handler
267 - Service Change Handler
268 - Inventory API
269 - Service components
270 - VES Collector
271 - SNMP Collector
272 - Threshold Crossing Analytics
273 - Holmes Rule Management *
274 - Holmes Engine Management *
275 - Additional resources that DCAE utilizes:
276 - Postgres Database
277 - Redis Cluster Database
278 - Consul Cluster
279
280 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000281 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100282
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200283- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100284
285 - 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".
286 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
287
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200288- 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 +0100289
290- All DCAE components are designed to support platform maturity requirements.
291
292
293**Source Code**
294
295Source code of DCAE components are released under the following repositories on gerrit.onap.org:
296 - dcaegen2
297 - dcaegen2.analytics
298 - dcaegen2.analytics.tca
299 - dcaegen2.collectors
300 - dcaegen2.collectors.snmptrap
301 - dcaegen2.collectors.ves
302 - dcaegen2.collectors.hv-ves
303 - dcaegen2.collectors.datafile
304 - dcaegen2.deployments
305 - dcaegen2.platform
306 - dcaegen2.platform.blueprints
307 - dcaegen2.platform.cli
308 - dcaegen2.platform.configbinding
309 - dcaegen2.platform.deployment-handler
310 - dcaegen2.platform.inventory-api
311 - dcaegen2.platform.plugins
312 - dcaegen2.platform.policy-handler
313 - dcaegen2.platform.servicechange-handler
314 - dcaegen2.services.heartbeat
315 - dcaegen2.services.mapper
316 - dcaegen2.services.prh
317 - dcaegen2.utils
318
319**Bug Fixes**
320
321**Known Issues**
322
323- 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.
324
325**Security Notes**
326
327DCAE 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>`_.
328
329Quick Links:
330 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
331
332 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
333
Vijay VKab471f62018-11-26 17:49:43 +0000334 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100335
336
Vijay VKf6659fc2018-11-02 05:07:27 +0100337**New component Notes**
338The following components are introduced in R3
339
340 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000341 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100342 - Description : Bulk data file collector to fetch non-realtime PM data
343 - PNF Registrator handler
344 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200345 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100346 - HV-VES Collector
347 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
348 - Description : High Volume VES Collector for fetching real-time PM measurement data
349 - SNMP Trap Collector
350 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200351 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100352
Vijay VK2648c6d2018-09-19 04:30:37 +0100353
354**Upgrade Notes**
355
356The following components are upgraded from R2:
357 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100358 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100359 - 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 +0200360 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100361 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100362 - 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 +0200363 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100364 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
365 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
366 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100367 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100368 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100369 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100370 - Description: Policy Handler now supports the new configuration policy format and support for TLS
371 - Service Change Handler
372 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
373 - Description: Refactoring.
374 - Inventory API
375 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
376 - Description: Refactoring.
377 - VES Collector
378 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500379 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100380 - Threshold Crossing Analytics
381 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
382 - 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.
383
384
385
386
Lusheng Jib2a561b2018-03-27 23:24:33 -0400387Version: 2.0.0
388--------------
389
Gildas Lanilis82799c72018-05-30 13:22:48 -0700390:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400391
392**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400393
Lusheng Jib2a561b2018-03-27 23:24:33 -0400394DCAE R2 improves upon previous release with the following new features:
395
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200396- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400397 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400398 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400399 - Bootstrap container
400 - Configuration Binding Service
401 - Deployment Handler
402 - Policy Handler
403 - Service Change Handler
404 - Inventory API
405 - Service components
406 - VES Collector
407 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400408 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400409 - Holmes Rule Management *
410 - Holmes Engine Management *
411 - Additional resources that DCAE utilizes:
412 - Postgres Database
413 - Redis Cluster Database
414 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400415
Lusheng Ji768421b2018-06-01 16:36:54 -0400416 Notes:
417 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400418
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200419- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400420
Lusheng Ji768421b2018-06-01 16:36:54 -0400421 - 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 -0400422 - 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 -0400423
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200424- 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 -0400425
426- All DCAE components are designed to support platform maturity requirements.
427
428
429**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400430
431Source code of DCAE components are released under the following repositories on gerrit.onap.org:
432 - dcaegen2
433 - dcaegen2.analytics
434 - dcaegen2.analytics.tca
435 - dcaegen2.collectors
436 - dcaegen2.collectors.snmptrap
437 - dcaegen2.collectors.ves
438 - dcaegen2.deployments
439 - dcaegen2.platform
440 - dcaegen2.platform.blueprints
441 - dcaegen2.platform.cli
442 - dcaegen2.platform.configbinding
443 - dcaegen2.platform.deployment-handler
444 - dcaegen2.platform.inventory-api
445 - dcaegen2.platform.plugins
446 - dcaegen2.platform.policy-handler
447 - dcaegen2.platform.servicechange-handler
448 - dcaegen2.services.heartbeat
449 - dcaegen2.services.mapper
450 - dcaegen2.services.prh
451 - dcaegen2.utils
452
453**Bug Fixes**
454
455**Known Issues**
456
Lusheng Ji768421b2018-06-01 16:36:54 -0400457- 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.
458
Gildas Lanilis82799c72018-05-30 13:22:48 -0700459**Security Notes**
460
461DCAE 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>`_.
462
463Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400464 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
465
466 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
467
468 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
469
470
Lusheng Jib2a561b2018-03-27 23:24:33 -0400471
472**Upgrade Notes**
473
Lusheng Ji768421b2018-06-01 16:36:54 -0400474The following components are upgraded from R1:
475 - Cloudify Manager:
476 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
477 - 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 +0200478 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400479 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400480 - 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 +0200481 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400482 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
483 - Description: Configuration Binding Sevice now supports the new configuration policy format.
484 - Deployment Handler
485 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
486 - Policy Handler
487 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
488 - Description: Policy Handler now supports the new configuration policy format.
489 - Service Change Handler
490 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
491 - Description: Refactoring.
492 - Inventory API
493 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
494 - Description: Refactoring.
495 - VES Collector
496 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
497 - Threshold Crossing Analytics
498 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
499 - 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.
500
Lusheng Jib2a561b2018-03-27 23:24:33 -0400501
502
Lusheng Ji8fafa432017-11-06 21:52:26 -0500503Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000504--------------
505
Lusheng Ji8fafa432017-11-06 21:52:26 -0500506:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000507
508
509**New Features**
510
Lusheng Ji8fafa432017-11-06 21:52:26 -0500511DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
512sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
513DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
514vDNS, vCPU, and vVoLTE.
515
516Specifically, DCAE R1 includes the following components:
517
518- Core platform
519 - Cloudify manager
520 - Consul cluster
521- Extended platform
522 - Platform component docker host
523 - Service component docker host
524 - CDAP cluster
525 - PostgreSQL database (*)
526- Platform docker container components
527 - Configuration binding service
528 - Deployment handler
529 - Service change handler
530 - Inventory
531 - Policy handler
532 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200533- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500534 - Docker container components
535 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000536 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500537 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000538 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500539
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200540(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
541VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500542other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200543(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500544in R1.
545
546Source codes of DCAE are released under the following repositories on gerrit.onap.org:
547
548- dcaegen2
549- dcaegen2/analytics
550- dcaegen2/analytics/tca
551- dcaegen2/collectors
552- dcaegen2/collectors/snmptrap
553- dcaegen2/collectors/ves
554- dcaegen2/deployments
555- dcaegen2/platform
556- dcaegen2/platform/blueprints
557- dcaegen2/platform/cdapbroker
558- dcaegen2/platform/cli
559- dcaegen2/platform/configbinding
560- dcaegen2/platform/deployment-handler
561- dcaegen2/platform/inventory-api
562- dcaegen2/platform/plugins
563- dcaegen2/platform/policy-handler
564- dcaegen2/platform/servicechange-handler
565- dcaegen2/utils
566
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000567
568**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500569
570This is the initial release.
571
572
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000573**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500574
575- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
576- Need to provide a dev configuration DCAE.
577
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000578
579**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000580
ankatare30c4cb42018-09-28 14:26:59 +0530581- 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 -0400582- 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.
583
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000584
585**Upgrade Notes**
586
Lusheng Ji8fafa432017-11-06 21:52:26 -0500587This is the initial release.
588
589
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000590**Deprecation Notes**
591
Lusheng Ji8fafa432017-11-06 21:52:26 -0500592There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
593DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
594following Gerrit repos are voided and already locked as read-only.
595
596- dcae
597- dcae/apod
598- dcae/apod/analytics
599- dcae/apod/buildtools
600- dcae/apod/cdap
601- dcae/collectors
602- dcae/collectors/ves
603- dcae/controller
604- dcae/controller/analytics
605- dcae/dcae-inventory
606- dcae/demo
607- dcae/demo/startup
608- dcae/demo/startup/aaf
609- dcae/demo/startup/controller
610- dcae/demo/startup/message-router
611- dcae/dmaapbc
612- dcae/operation
613- dcae/operation/utils
614- dcae/orch-dispatcher
615- dcae/pgaas
616- dcae/utils
617- dcae/utils/buildtools
618- ncomp
619- ncomp/cdap
620- ncomp/core
621- ncomp/docker
622- ncomp/maven
623- ncomp/openstack
624- ncomp/sirius
625- ncomp/sirius/manager
626- ncomp/utils
627
628
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000629**Other**
630
Vijay0fbc6732017-11-08 13:55:01 +0000631SNMP trap collector is seed code delivery only.