Draft docs
[dcaegen2.git] / docs / index.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
5 Data Collection, Analytics, and Events (DCAE)
6 =======================
7
8 .. Add or remove sections below as appropriate for the platform component.
9 Data Collection Analytics and Events (DCAE) is the data collection and analysis subsystem of ONAP.
10 Its functions include collection of FCAPs data from the network entotiess (VNFs, PNFs, etc), normalization and transportation of
11 data, analysis of data, and generations of ONAP events which can be received by other ONAP components such as Policy for
12 subsequent operations.
13
14 DCAE consists of DCAE Platform components and DCAE Services components.
15
16 - DCAE Platform
17     - Core Platform
18         - Cloudify Manager
19         - Consul
20     - Extended Platform
21         - Docker Host for containerized platform components
22         - CDAP Analytics Platform for CDAP analytics applications
23         - Docker Host for containerized service components
24
25
26 - DCAE Services
27     - Collectors
28         - Virtual Event Streaming (VES) collector, dockerized
29         - SNMP Trap collector, dockerized
30     - Analytics
31         - Holmes correlation analytics, dockerized
32         - Threshold Crosssing Analytics (TCA), CDAP analytics application
33
34 .. toctree::
35    :maxdepth: 1
36
37    ./sections/architecture.rst
38    ./sections/offeredapis.rst
39    ./sections/consumedapis.rst
40    ./sections/delivery.rst
41    ./sections/logging.rst
42    ./sections/installation.rst
43    ./sections/configuration.rst
44    ./sections/administration.rst
45    ./sections/humaninterfaces.rst
46    ./sections/release-notes.rst
47
48    offeredapis.rst
49