clean up some sphinx warnings
[dcaegen2.git] / docs / sections / version_1.0.0.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Version: 1.0.0
5 ==============
6
7 :Release Date: 2017-11-16
8
9
10 **New Features**
11
12 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
13 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
14 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
15 vDNS, vCPU, and vVoLTE.
16
17 Specifically, DCAE R1 includes the following components:
18
19 - Core platform
20     - Cloudify manager
21     - Consul cluster
22 - Extended platform
23     - Platform component docker host
24     - Service component docker host
25     - CDAP cluster
26     - PostgreSQL database (*)
27 - Platform docker container components
28     - Configuration binding service
29     - Deployment handler
30     - Service change handler
31     - Inventory
32     - Policy handler
33     - CDAP broker
34 - Service components
35     - Docker container components
36         - VNF Event Streaming (VES) collector
37         - Holmes (engine and rule management) **
38     - CDAP analytics component
39         - Threshold Crossing Analytics (TCA)
40
41 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
42 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
43 other deployment configurations not used in the R1 demos.)
44 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
45 in R1.
46
47 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
48
49 - dcaegen2
50 - dcaegen2/analytics
51 - dcaegen2/analytics/tca
52 - dcaegen2/collectors
53 - dcaegen2/collectors/snmptrap
54 - dcaegen2/collectors/ves
55 - dcaegen2/deployments
56 - dcaegen2/platform
57 - dcaegen2/platform/blueprints
58 - dcaegen2/platform/cdapbroker
59 - dcaegen2/platform/cli
60 - dcaegen2/platform/configbinding
61 - dcaegen2/platform/deployment-handler
62 - dcaegen2/platform/inventory-api
63 - dcaegen2/platform/plugins
64 - dcaegen2/platform/policy-handler
65 - dcaegen2/platform/servicechange-handler
66 - dcaegen2/utils
67
68
69 **Bug Fixes**
70
71 This is the initial release.
72
73
74 **Known Issues**
75
76 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
77 - Need to provide a dev configuration DCAE.
78
79
80 **Security Issues**
81
82 - 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>`_.>`_.
83 - 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.
84
85
86 **Upgrade Notes**
87
88 This is the initial release.
89
90
91 **Deprecation Notes**
92
93 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
94 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
95 following Gerrit repos are voided and already locked as read-only.
96
97 - dcae
98 - dcae/apod
99 - dcae/apod/analytics
100 - dcae/apod/buildtools
101 - dcae/apod/cdap
102 - dcae/collectors
103 - dcae/collectors/ves
104 - dcae/controller
105 - dcae/controller/analytics
106 - dcae/dcae-inventory
107 - dcae/demo
108 - dcae/demo/startup
109 - dcae/demo/startup/aaf
110 - dcae/demo/startup/controller
111 - dcae/demo/startup/message-router
112 - dcae/dmaapbc
113 - dcae/operation
114 - dcae/operation/utils
115 - dcae/orch-dispatcher
116 - dcae/pgaas
117 - dcae/utils
118 - dcae/utils/buildtools
119 - ncomp
120 - ncomp/cdap
121 - ncomp/core
122 - ncomp/docker
123 - ncomp/maven
124 - ncomp/openstack
125 - ncomp/sirius
126 - ncomp/sirius/manager
127 - ncomp/utils
128
129
130 **Other**
131
132 SNMP trap collector is seed code delivery only.