blob: 8e375ffded1474b60b07654abba829303dc89be2 [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**
Vijay VKa46f7fe2019-06-10 15:57:41 +0100101 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
102
Vijay VK6b0fa462019-05-20 16:06:11 +0100103
104**Security Notes**
105
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200106*Fixed Security Issues*
107
108*Known Security Issues*
109
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200110 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200111 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200112 * 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 +0200113 * 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 +0200114 * 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 +0200115 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
Krzysztof Opasiakf0b14642019-05-27 18:13:16 +0200116 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
Krzysztof Opasiak1f224ee2019-05-30 17:43:06 +0200117 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
Krzysztof Opasiak61cf8dc2019-05-30 17:43:51 +0200118 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
Krzysztof Opasiakbb8dea82019-05-30 17:44:35 +0200119 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200120
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200121*Known Vulnerabilities in Used Modules*
122
Vijay VK6b0fa462019-05-20 16:06:11 +0100123DCAE 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>`_.
124
125Quick Links:
126 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
127
128 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
129
130 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
131
132
133**New component Notes**
134The following components are introduced in R4
135
136 - Dashboard
137 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
138 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
139 - Blueprint generator
140 - 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 +0200141 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100142 - RESTConf collector 
143 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
144 - Description: Provides RESTConf interfaces to events from external domain controllers
145 - VES/Universal Mapper
146 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200147 - 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 +0100148 - 3gpp PM-Mapper
149 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200150 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100151 - BBS Event processor
152 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200153 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100154 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100155 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200156 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100157 - Heartbeat MS
158 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
159 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200160
Vijay VK6b0fa462019-05-20 16:06:11 +0100161
162**Upgrade Notes**
163
164The following components are upgraded from R3
165 - Cloudify Manager:
166 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
167 - 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 +0200168 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100169 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200170 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
171 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100172 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
173 - Description: Code optimization and bug fixes
174 - Deployment Handler
175 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
176 - Include updates for health and service endpoint check and bug fixes
177 - Policy Handler
178 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
179 - Description: Policy Handler supports the new lifecycle API's from Policy framework
180 - Service Change Handler
181 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
182 - Description: No update from R3
183 - Inventory API
184 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
185 - Description: Refactoring and updates for health and service endpoint check
186 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +0100187 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200188 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100189 - Threshold Crossing Analytics
190 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
191 - 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.
192 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100193 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100194 - Description : Code optimization, bug fixes, logging and performance improvement
195 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100196 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200197 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100198 - HV-VES Collector
199 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
200 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
201 - SNMP Trap Collector
202 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200203 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100204
205
206
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500207
208Version: 3.0.1
209--------------
210
211:Release Date: 2019-01-31
212
213DCAE R3 Maintenance release includes following fixes
214
215**Bug Fixes**
216
217- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200218 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500219 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200220 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500221 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200222 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500223 Multiple Fileready notification not handled
224
225- HighVolume VES Collector (protobuf/tcp)
226 - DCAEGEN2-976
227 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
228
229- VESCollector (http)
230 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200231 Issue with VES batch event publish
232
233- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500234 - DCAEGEN2-1007
235 Removing obsolete services configuration
236
237
238The following containers are updated in R3.0.1
239
240 - DataFile Collector
241 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
242 - HV-VES Collector
243 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
244 - VES Collector
245 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
246
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500247**Known Issues**
248
249- 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
250
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200251- 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 +0100252 kubectl get deployments -n onap | grep deployment-handler
253 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
254 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
255
256
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500257
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500258
Vijay VK2648c6d2018-09-19 04:30:37 +0100259Version: 3.0.0
260--------------
261
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800262:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100263
264**New Features**
265
266DCAE R3 improves upon previous release with the following new features:
267
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200268- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100269 - Platform components
270 - Cloudify Manager
271 - Bootstrap container
272 - Configuration Binding Service
273 - Deployment Handler
274 - Policy Handler
275 - Service Change Handler
276 - Inventory API
277 - Service components
278 - VES Collector
279 - SNMP Collector
280 - Threshold Crossing Analytics
281 - Holmes Rule Management *
282 - Holmes Engine Management *
283 - Additional resources that DCAE utilizes:
284 - Postgres Database
285 - Redis Cluster Database
286 - Consul Cluster
287
288 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000289 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100290
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200291- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100292
293 - 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".
294 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
295
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200296- 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 +0100297
298- All DCAE components are designed to support platform maturity requirements.
299
300
301**Source Code**
302
303Source code of DCAE components are released under the following repositories on gerrit.onap.org:
304 - dcaegen2
305 - dcaegen2.analytics
306 - dcaegen2.analytics.tca
307 - dcaegen2.collectors
308 - dcaegen2.collectors.snmptrap
309 - dcaegen2.collectors.ves
310 - dcaegen2.collectors.hv-ves
311 - dcaegen2.collectors.datafile
312 - dcaegen2.deployments
313 - dcaegen2.platform
314 - dcaegen2.platform.blueprints
315 - dcaegen2.platform.cli
316 - dcaegen2.platform.configbinding
317 - dcaegen2.platform.deployment-handler
318 - dcaegen2.platform.inventory-api
319 - dcaegen2.platform.plugins
320 - dcaegen2.platform.policy-handler
321 - dcaegen2.platform.servicechange-handler
322 - dcaegen2.services.heartbeat
323 - dcaegen2.services.mapper
324 - dcaegen2.services.prh
325 - dcaegen2.utils
326
327**Bug Fixes**
328
329**Known Issues**
330
331- 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.
332
333**Security Notes**
334
335DCAE 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>`_.
336
337Quick Links:
338 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
339
340 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
341
Vijay VKab471f62018-11-26 17:49:43 +0000342 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100343
344
Vijay VKf6659fc2018-11-02 05:07:27 +0100345**New component Notes**
346The following components are introduced in R3
347
348 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000349 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100350 - Description : Bulk data file collector to fetch non-realtime PM data
351 - PNF Registrator handler
352 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200353 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100354 - HV-VES Collector
355 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
356 - Description : High Volume VES Collector for fetching real-time PM measurement data
357 - SNMP Trap Collector
358 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200359 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100360
Vijay VK2648c6d2018-09-19 04:30:37 +0100361
362**Upgrade Notes**
363
364The following components are upgraded from R2:
365 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100366 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100367 - 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 +0200368 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100369 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100370 - 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 +0200371 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100372 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
373 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
374 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100375 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100376 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100377 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100378 - Description: Policy Handler now supports the new configuration policy format and support for TLS
379 - Service Change Handler
380 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
381 - Description: Refactoring.
382 - Inventory API
383 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
384 - Description: Refactoring.
385 - VES Collector
386 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500387 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100388 - Threshold Crossing Analytics
389 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
390 - 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.
391
392
393
394
Lusheng Jib2a561b2018-03-27 23:24:33 -0400395Version: 2.0.0
396--------------
397
Gildas Lanilis82799c72018-05-30 13:22:48 -0700398:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400399
400**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400401
Lusheng Jib2a561b2018-03-27 23:24:33 -0400402DCAE R2 improves upon previous release with the following new features:
403
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200404- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400405 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400406 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400407 - Bootstrap container
408 - Configuration Binding Service
409 - Deployment Handler
410 - Policy Handler
411 - Service Change Handler
412 - Inventory API
413 - Service components
414 - VES Collector
415 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400416 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400417 - Holmes Rule Management *
418 - Holmes Engine Management *
419 - Additional resources that DCAE utilizes:
420 - Postgres Database
421 - Redis Cluster Database
422 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400423
Lusheng Ji768421b2018-06-01 16:36:54 -0400424 Notes:
425 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400426
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200427- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400428
Lusheng Ji768421b2018-06-01 16:36:54 -0400429 - 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 -0400430 - 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 -0400431
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200432- 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 -0400433
434- All DCAE components are designed to support platform maturity requirements.
435
436
437**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400438
439Source code of DCAE components are released under the following repositories on gerrit.onap.org:
440 - dcaegen2
441 - dcaegen2.analytics
442 - dcaegen2.analytics.tca
443 - dcaegen2.collectors
444 - dcaegen2.collectors.snmptrap
445 - dcaegen2.collectors.ves
446 - dcaegen2.deployments
447 - dcaegen2.platform
448 - dcaegen2.platform.blueprints
449 - dcaegen2.platform.cli
450 - dcaegen2.platform.configbinding
451 - dcaegen2.platform.deployment-handler
452 - dcaegen2.platform.inventory-api
453 - dcaegen2.platform.plugins
454 - dcaegen2.platform.policy-handler
455 - dcaegen2.platform.servicechange-handler
456 - dcaegen2.services.heartbeat
457 - dcaegen2.services.mapper
458 - dcaegen2.services.prh
459 - dcaegen2.utils
460
461**Bug Fixes**
462
463**Known Issues**
464
Lusheng Ji768421b2018-06-01 16:36:54 -0400465- 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.
466
Gildas Lanilis82799c72018-05-30 13:22:48 -0700467**Security Notes**
468
469DCAE 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>`_.
470
471Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400472 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
473
474 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
475
476 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
477
478
Lusheng Jib2a561b2018-03-27 23:24:33 -0400479
480**Upgrade Notes**
481
Lusheng Ji768421b2018-06-01 16:36:54 -0400482The following components are upgraded from R1:
483 - Cloudify Manager:
484 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
485 - 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 +0200486 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400487 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400488 - 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 +0200489 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400490 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
491 - Description: Configuration Binding Sevice now supports the new configuration policy format.
492 - Deployment Handler
493 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
494 - Policy Handler
495 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
496 - Description: Policy Handler now supports the new configuration policy format.
497 - Service Change Handler
498 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
499 - Description: Refactoring.
500 - Inventory API
501 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
502 - Description: Refactoring.
503 - VES Collector
504 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
505 - Threshold Crossing Analytics
506 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
507 - 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.
508
Lusheng Jib2a561b2018-03-27 23:24:33 -0400509
510
Lusheng Ji8fafa432017-11-06 21:52:26 -0500511Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000512--------------
513
Lusheng Ji8fafa432017-11-06 21:52:26 -0500514:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000515
516
517**New Features**
518
Lusheng Ji8fafa432017-11-06 21:52:26 -0500519DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
520sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
521DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
522vDNS, vCPU, and vVoLTE.
523
524Specifically, DCAE R1 includes the following components:
525
526- Core platform
527 - Cloudify manager
528 - Consul cluster
529- Extended platform
530 - Platform component docker host
531 - Service component docker host
532 - CDAP cluster
533 - PostgreSQL database (*)
534- Platform docker container components
535 - Configuration binding service
536 - Deployment handler
537 - Service change handler
538 - Inventory
539 - Policy handler
540 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200541- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500542 - Docker container components
543 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000544 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500545 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000546 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500547
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200548(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
549VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500550other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200551(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500552in R1.
553
554Source codes of DCAE are released under the following repositories on gerrit.onap.org:
555
556- dcaegen2
557- dcaegen2/analytics
558- dcaegen2/analytics/tca
559- dcaegen2/collectors
560- dcaegen2/collectors/snmptrap
561- dcaegen2/collectors/ves
562- dcaegen2/deployments
563- dcaegen2/platform
564- dcaegen2/platform/blueprints
565- dcaegen2/platform/cdapbroker
566- dcaegen2/platform/cli
567- dcaegen2/platform/configbinding
568- dcaegen2/platform/deployment-handler
569- dcaegen2/platform/inventory-api
570- dcaegen2/platform/plugins
571- dcaegen2/platform/policy-handler
572- dcaegen2/platform/servicechange-handler
573- dcaegen2/utils
574
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000575
576**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500577
578This is the initial release.
579
580
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000581**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500582
583- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
584- Need to provide a dev configuration DCAE.
585
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000586
587**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000588
ankatare30c4cb42018-09-28 14:26:59 +0530589- 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 -0400590- 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.
591
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000592
593**Upgrade Notes**
594
Lusheng Ji8fafa432017-11-06 21:52:26 -0500595This is the initial release.
596
597
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000598**Deprecation Notes**
599
Lusheng Ji8fafa432017-11-06 21:52:26 -0500600There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
601DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
602following Gerrit repos are voided and already locked as read-only.
603
604- dcae
605- dcae/apod
606- dcae/apod/analytics
607- dcae/apod/buildtools
608- dcae/apod/cdap
609- dcae/collectors
610- dcae/collectors/ves
611- dcae/controller
612- dcae/controller/analytics
613- dcae/dcae-inventory
614- dcae/demo
615- dcae/demo/startup
616- dcae/demo/startup/aaf
617- dcae/demo/startup/controller
618- dcae/demo/startup/message-router
619- dcae/dmaapbc
620- dcae/operation
621- dcae/operation/utils
622- dcae/orch-dispatcher
623- dcae/pgaas
624- dcae/utils
625- dcae/utils/buildtools
626- ncomp
627- ncomp/cdap
628- ncomp/core
629- ncomp/docker
630- ncomp/maven
631- ncomp/openstack
632- ncomp/sirius
633- ncomp/sirius/manager
634- ncomp/utils
635
636
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000637**Other**
638
Vijay0fbc6732017-11-08 13:55:01 +0000639SNMP trap collector is seed code delivery only.