Add release notes
[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: 1.0.0
7 --------------
8
9 :Release Date: 2017-11-16
10
11
12 **New Features**
13
14 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
15 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
16 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
17 vDNS, vCPU, and vVoLTE.
18
19 Specifically, DCAE R1 includes the following components:
20
21 - Core platform
22     - Cloudify manager
23     - Consul cluster
24 - Extended platform
25     - Platform component docker host
26     - Service component docker host
27     - CDAP cluster
28     - PostgreSQL database (*)
29 - Platform docker container components
30     - Configuration binding service
31     - Deployment handler
32     - Service change handler
33     - Inventory
34     - Policy handler
35     - CDAP broker
36 - Service components                            
37     - Docker container components
38         - VNF Event Streaming (VES) collector
39         - Holmes engine (**)
40         - Holmes rule management (**)
41     - CDAP analytics component
42
43 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single 
44 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports 
45 other deployment configurations not used in the R1 demos.)
46 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component 
47 in R1.
48
49 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
50
51 - dcaegen2
52 - dcaegen2/analytics
53 - dcaegen2/analytics/tca
54 - dcaegen2/collectors
55 - dcaegen2/collectors/snmptrap
56 - dcaegen2/collectors/ves
57 - dcaegen2/deployments
58 - dcaegen2/platform
59 - dcaegen2/platform/blueprints
60 - dcaegen2/platform/cdapbroker
61 - dcaegen2/platform/cli
62 - dcaegen2/platform/configbinding
63 - dcaegen2/platform/deployment-handler
64 - dcaegen2/platform/inventory-api
65 - dcaegen2/platform/plugins
66 - dcaegen2/platform/policy-handler
67 - dcaegen2/platform/servicechange-handler
68 - dcaegen2/utils
69
70
71 **Bug Fixes**
72
73 This is the initial release.
74
75
76 **Known Issues**
77
78 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
79 - Need to provide a dev configuration DCAE.
80
81
82 **Security Issues**
83
84 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.
85 This key is currently passed in as a Heat template parameter.  Tracked by JIRA DCAEGEN2-178.
86 - The RESTful API calls are generally not secure.  That is, they are either over http, or https
87 without certificate verification.  Once there is an ONAP wide solution for handling certificates,
88 DCAE will switch to https.
89
90 **Upgrade Notes**
91
92 This is the initial release.
93
94
95 **Deprecation Notes**
96
97 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
98 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
99 following Gerrit repos are voided and already locked as read-only.
100
101 - dcae
102 - dcae/apod
103 - dcae/apod/analytics
104 - dcae/apod/buildtools
105 - dcae/apod/cdap
106 - dcae/collectors
107 - dcae/collectors/ves
108 - dcae/controller
109 - dcae/controller/analytics
110 - dcae/dcae-inventory
111 - dcae/demo
112 - dcae/demo/startup
113 - dcae/demo/startup/aaf
114 - dcae/demo/startup/controller
115 - dcae/demo/startup/message-router
116 - dcae/dmaapbc
117 - dcae/operation
118 - dcae/operation/utils
119 - dcae/orch-dispatcher
120 - dcae/pgaas
121 - dcae/utils
122 - dcae/utils/buildtools
123 - ncomp
124 - ncomp/cdap
125 - ncomp/core
126 - ncomp/docker
127 - ncomp/maven
128 - ncomp/openstack
129 - ncomp/sirius
130 - ncomp/sirius/manager
131 - ncomp/utils
132
133
134 **Other**
135