Document OJSI-159 vulnerability
[dcaegen2.git] / docs / sections / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Release Notes
4 =============
5
6 Version: 4.0.0
7 --------------
8
9 :Release Date: 2019-06-06
10
11 **New Features**
12
13 DCAE 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
23     - Cloudify Manager resiliency
24
25 - Following new services are delivered with Dublin
26     - Collectors
27         - RESTConf collector 
28     - Event Processors
29         - VES Mapper
30         - 3gpp PM-Mapper
31         - BBS Event processor
32     - Analytics/RCA
33         - SON-Handler
34         - Heartbeat MS
35
36 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
37     - 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
63 Under 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.
64
65 - All DCAE components are designed to support platform maturity requirements.
66
67
68 **Source Code**
69
70 Source 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
92     - dcaegen2.services
93     - 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
104 *Fixed Security Issues*
105
106 *Known Security Issues*
107
108     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
109     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
110     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
111     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
112
113 *Known Vulnerabilities in Used Modules*
114
115 DCAE 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
117 Quick 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**
126 The 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
133        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
134     - 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
139        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
140     - 3gpp PM-Mapper
141        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
142        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
143     - BBS Event processor
144        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
145        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
146     - SON-Handler
147        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
148        - Description: Supports PC-ANR optimization analysis and generating CL events output
149     - 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.
152
153
154 **Upgrade Notes**
155
156 The 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.
160     - K8S Bootstrap container:
161        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
162        - 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:
164        - 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
180        - Description : Authentication enhancement, refactoring and bug-fixes
181     - 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
185        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
186        - 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
189        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
190     - 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
195        - Description : Code coverage improvements
196
197
198
199
200 Version: 3.0.1
201 --------------
202
203 :Release Date: 2019-01-31
204
205 DCAE R3 Maintenance release includes following fixes
206
207 **Bug Fixes**
208
209 - DataFileCollector
210      - DCAEGEN2-940
211        Larger files of size 100Kb publish to DR
212      - DCAEGEN2-941
213        DFC error after running over 12 hours
214      - DCAEGEN2-1001
215        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
223        Issue with VES batch event publish
224
225 - Heat deployment
226      - DCAEGEN2-1007
227        Removing obsolete services configuration
228
229
230 The 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
239 **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
243 - 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
244     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
249
250
251 Version: 3.0.0
252 --------------
253
254 :Release Date: 2018-11-30
255
256 **New Features**
257
258 DCAE R3 improves upon previous release with the following new features:
259
260 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
261     - 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:
281         \*  These components are delivered by the Holmes project.
282
283 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
284
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
288 - 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.
289
290 - All DCAE components are designed to support platform maturity requirements.
291
292
293 **Source Code**
294
295 Source 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
327 DCAE 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
329 Quick 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
334         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
335
336
337 **New component Notes**
338 The following components are introduced in R3
339
340     - DataFile Collector
341        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
342        - 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
345        - Description : Recieves VES registration event and updates AAI and SO
346     - 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
351        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
352
353
354 **Upgrade Notes**
355
356 The following components are upgraded from R2:
357     - Cloudify Manager:
358        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
359        - 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.
360     - Bootstrap container:
361        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
362        - 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.
363     - Configuration Binding Service:
364        - 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
367        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
368     - Policy Handler
369        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
370        - 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
379        - Description : Refactoring
380     - 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
387 Version: 2.0.0
388 --------------
389
390 :Release Date: 2018-06-07
391
392 **New Features**
393
394 DCAE R2 improves upon previous release with the following new features:
395
396 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
397     - Platform components
398         - Cloudify Manager
399         - 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
408         - Threshold Crossing Analytics
409         - Holmes Rule Management *
410         - Holmes Engine Management *
411     - Additional resources that DCAE utilizes:
412         - Postgres Database
413         - Redis Cluster Database
414         - Consul Cluster
415
416     Notes:
417         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
418
419 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
420
421     - 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".
422     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
423
424 - 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.
425
426 - All DCAE components are designed to support platform maturity requirements.
427
428
429 **Source Code**
430
431 Source 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
457 - 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
459 **Security Notes**
460
461 DCAE 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
463 Quick Links:
464         - `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
471
472 **Upgrade Notes**
473
474 The 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.
478     - Bootstrap container:
479        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
480        - 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.
481     - Configuration Binding Service:
482        - 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
501
502
503 Version: 1.0.0
504 --------------
505
506 :Release Date: 2017-11-16
507
508
509 **New Features**
510
511 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
512 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
513 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
514 vDNS, vCPU, and vVoLTE.
515
516 Specifically, 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
533 - Service components
534     - Docker container components
535         - VNF Event Streaming (VES) collector
536         - Holmes (engine and rule management) **
537     - CDAP analytics component
538         - Threshold Crossing Analytics (TCA)
539
540 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
541 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
542 other deployment configurations not used in the R1 demos.)
543 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
544 in R1.
545
546 Source 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
567
568 **Bug Fixes**
569
570 This is the initial release.
571
572
573 **Known Issues**
574
575 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
576 - Need to provide a dev configuration DCAE.
577
578
579 **Security Issues**
580
581 - 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>`_.>`_.
582 - 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
584
585 **Upgrade Notes**
586
587 This is the initial release.
588
589
590 **Deprecation Notes**
591
592 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
593 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
594 following 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
629 **Other**
630
631 SNMP trap collector is seed code delivery only.