Merge "Onboarding documentation update for CLI"
[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: 2.0.0
7 --------------
8
9 :Release Date: 2018-05-24
10
11 **New Features**
12 DCAE R2 improves upon previous release with the following new features:
13
14 - Kubernetes deployment support for DCAE.  In R2 all DCAE components can be deployed using Kubernetes into a Kubernetes cluster.  The list of a R2 DCAE include the following components.
15     - Platform components
16         - Cloudify Manager (Community Version 18.3.23)
17         - Bootstrap container
18         - Configuration Binding Service
19         - Deployment Handler
20         - Policy Handler
21         - Service Change Handler
22         - Inventory API
23     - Service components
24         - VES Collector
25         - SNMP Collector
26         - Mapper Microservice
27         - PNF Registration Handler Microservice
28         - Missing Heartbeat Microservice
29         - Threshold Crossing Analytics
30         - Holmes Rule Management*
31         - Holmes Engine Management*
32
33 (*) Note: This component is delivered under the Holmes project and used as a DCAE analytics component in R2.
34
35 In addition, DCAE R2 utilizes the following shared resources that are provided by OOM ONAP deployment:
36     - Postgres Database
37     - Redis Cluster Database
38     - Consul Cluster
39
40 All DCAE components are designed to support platform maturity requirements.
41
42 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
43     - dcaegen2
44     - dcaegen2.analytics
45     - dcaegen2.analytics.tca
46     - dcaegen2.collectors
47     - dcaegen2.collectors.snmptrap
48     - dcaegen2.collectors.ves
49     - dcaegen2.deployments
50     - dcaegen2.platform
51     - dcaegen2.platform.blueprints
52     - dcaegen2.platform.cli
53     - dcaegen2.platform.configbinding
54     - dcaegen2.platform.deployment-handler
55     - dcaegen2.platform.inventory-api
56     - dcaegen2.platform.plugins
57     - dcaegen2.platform.policy-handler
58     - dcaegen2.platform.servicechange-handler
59     - dcaegen2.services.heartbeat
60     - dcaegen2.services.mapper
61     - dcaegen2.services.prh
62     - dcaegen2.utils
63
64 **Bug Fixes**
65
66 **Known Issues**
67
68 **Security Issues**
69
70 **Upgrade Notes**
71
72
73
74 Version: 1.0.0
75 --------------
76
77 :Release Date: 2017-11-16
78
79
80 **New Features**
81
82 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
83 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
84 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
85 vDNS, vCPU, and vVoLTE.
86
87 Specifically, DCAE R1 includes the following components:
88
89 - Core platform
90     - Cloudify manager
91     - Consul cluster
92 - Extended platform
93     - Platform component docker host
94     - Service component docker host
95     - CDAP cluster
96     - PostgreSQL database (*)
97 - Platform docker container components
98     - Configuration binding service
99     - Deployment handler
100     - Service change handler
101     - Inventory
102     - Policy handler
103     - CDAP broker
104 - Service components                            
105     - Docker container components
106         - VNF Event Streaming (VES) collector
107         - Holmes (engine and rule management) **
108     - CDAP analytics component
109         - Threshold Crossing Analytics (TCA)
110
111 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single 
112 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports 
113 other deployment configurations not used in the R1 demos.)
114 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component 
115 in R1.
116
117 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
118
119 - dcaegen2
120 - dcaegen2/analytics
121 - dcaegen2/analytics/tca
122 - dcaegen2/collectors
123 - dcaegen2/collectors/snmptrap
124 - dcaegen2/collectors/ves
125 - dcaegen2/deployments
126 - dcaegen2/platform
127 - dcaegen2/platform/blueprints
128 - dcaegen2/platform/cdapbroker
129 - dcaegen2/platform/cli
130 - dcaegen2/platform/configbinding
131 - dcaegen2/platform/deployment-handler
132 - dcaegen2/platform/inventory-api
133 - dcaegen2/platform/plugins
134 - dcaegen2/platform/policy-handler
135 - dcaegen2/platform/servicechange-handler
136 - dcaegen2/utils
137
138
139 **Bug Fixes**
140
141 This is the initial release.
142
143
144 **Known Issues**
145
146 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
147 - Need to provide a dev configuration DCAE.
148
149
150 **Security Issues**
151
152 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.
153 This key is currently passed in as a Heat template parameter.  Tracked by JIRA DCAEGEN2-178.
154 - The RESTful API calls are generally not secure.  That is, they are either over http, or https
155 without certificate verification.  Once there is an ONAP wide solution for handling certificates,
156 DCAE will switch to https.
157
158 **Upgrade Notes**
159
160 This is the initial release.
161
162
163 **Deprecation Notes**
164
165 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
166 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
167 following Gerrit repos are voided and already locked as read-only.
168
169 - dcae
170 - dcae/apod
171 - dcae/apod/analytics
172 - dcae/apod/buildtools
173 - dcae/apod/cdap
174 - dcae/collectors
175 - dcae/collectors/ves
176 - dcae/controller
177 - dcae/controller/analytics
178 - dcae/dcae-inventory
179 - dcae/demo
180 - dcae/demo/startup
181 - dcae/demo/startup/aaf
182 - dcae/demo/startup/controller
183 - dcae/demo/startup/message-router
184 - dcae/dmaapbc
185 - dcae/operation
186 - dcae/operation/utils
187 - dcae/orch-dispatcher
188 - dcae/pgaas
189 - dcae/utils
190 - dcae/utils/buildtools
191 - ncomp
192 - ncomp/cdap
193 - ncomp/core
194 - ncomp/docker
195 - ncomp/maven
196 - ncomp/openstack
197 - ncomp/sirius
198 - ncomp/sirius/manager
199 - ncomp/utils
200
201
202 **Other**
203
204 SNMP trap collector is seed code delivery only.