summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGuangrong Fu <fu.guangrong@zte.com.cn>2017-09-22 08:31:41 +0800
committerGuangrong Fu <fu.guangrong@zte.com.cn>2017-09-22 08:31:41 +0800
commit8ce2c73d532b80d91f670f88161187fab5904a3e (patch)
tree664f004852a6c4c026b5babcc0e03ff5a533157e /docs/index.rst
parentfe3bae00cfa7eac9618856b1dd10a8c03daa8810 (diff)
Init the Holmes Engine Management API Doc
Change-Id: Iafbb85971bdd490303749fa4be663c2810f92297 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
+
+