summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2017-10-10 18:12:22 +0000
committerLusheng Ji <lji@research.att.com>2017-10-10 18:12:34 +0000
commit72c4fbaceb680b3b34e177ccca11efe18de599f5 (patch)
treefefdb90f97f0e8d43772d77ea48f6f98a7c4945b /docs/index.rst
parentc8d7ad73740989d2aa5d5cab41dcc7e0c960f0fa (diff)
Draft docs
Issue-Id: DCAEGEN2-109 Change-Id: I85513ed5b34c0f60b8b0924b2016bbb3224beb9c Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst25
1 files changed, 19 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 36dd11f2..128a7ee5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,10 +1,13 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
-Data Collection Analytics and Events
-------------------------------------------------
+Data Collection, Analytics, and Events (DCAE)
+=======================
+
+.. Add or remove sections below as appropriate for the platform component.
Data Collection Analytics and Events (DCAE) is the data collection and analysis subsystem of ONAP.
-Its functions include collection of FCAPs data from the network entotiess (VNFs, PNFs, etc), normalization and transportation of
+Its functions include collection of FCAPs data from the network entotiess (VNFs, PNFs, etc), normalization and transportation of
data, analysis of data, and generations of ONAP events which can be received by other ONAP components such as Policy for
subsequent operations.
@@ -13,7 +16,7 @@ DCAE consists of DCAE Platform components and DCAE Services components.
- DCAE Platform
- Core Platform
- Cloudify Manager
- - Consul
+ - Consul
- Extended Platform
- Docker Host for containerized platform components
- CDAP Analytics Platform for CDAP analytics applications
@@ -28,9 +31,19 @@ DCAE consists of DCAE Platform components and DCAE Services components.
- Holmes correlation analytics, dockerized
- Threshold Crosssing Analytics (TCA), CDAP analytics application
-
-
.. toctree::
:maxdepth: 1
+ ./sections/architecture.rst
+ ./sections/offeredapis.rst
+ ./sections/consumedapis.rst
+ ./sections/delivery.rst
+ ./sections/logging.rst
+ ./sections/installation.rst
+ ./sections/configuration.rst
+ ./sections/administration.rst
+ ./sections/humaninterfaces.rst
+ ./sections/release-notes.rst
+
offeredapis.rst
+