summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGuangrong Fu <fu.guangrong@zte.com.cn>2017-09-21 19:57:19 +0800
committerGuangrong Fu <fu.guangrong@zte.com.cn>2017-09-21 19:57:19 +0800
commite3860e0fd7b0167e1afa2ac9252ce9f1e8f3c82c (patch)
treeba06405918294c69827ad99729fb0c2a1c9baaf3 /docs/index.rst
parentbb5de24c15f98ea156590eb8f34c17e3c90865df (diff)
Init the Holmes Rule Management API Doc
Change-Id: I18c542edb3bd45a1e7803d2d97bf2671d231e075 Issue-ID: HOLMES-54 Signed-off-by: Guangrong Fu <fu.guangrong@zte.com.cn>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..c7887dd
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Holmes
+------------------------------------------------
+
+Holmes provides alarm correlation and analysis for Telecom cloud infrastructure and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure or degradation of services by digging into the ocean of events collected from different levels of the Telecom cloud.
+
+Holmes comprises three modules: the rule management module, the engine management module and the data source adapter.
+
+- Holmes
+ - Rule Management Module
+ - Engine Management Module
+ - Data Source Adapter
+
+.. toctree::
+ :maxdepth: 1
+
+ offeredapis.rst
+
+