diff options
Diffstat (limited to 'docs/platform')
| -rw-r--r-- | docs/platform/administration.rst | 15 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 32 | ||||
| -rw-r--r-- | docs/platform/configuration.rst | 8 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 7 | ||||
| -rw-r--r-- | docs/platform/delivery.rst | 9 | ||||
| -rw-r--r-- | docs/platform/human-interfaces.rst | 15 | ||||
| -rw-r--r-- | docs/platform/images/holmes-architecture.png | bin | 0 -> 17965 bytes | |||
| -rw-r--r-- | docs/platform/images/overall-architecture-in-onap.png | bin | 0 -> 43459 bytes | |||
| -rw-r--r-- | docs/platform/index.rst | 18 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 5 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 14 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst | 10 |
12 files changed, 133 insertions, 0 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst new file mode 100644 index 0000000..a32790f --- /dev/null +++ b/docs/platform/administration.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Administration +-------------- + +Processes +^^^^^^^^^ +* Process 1 +* Process 2 + +Actions +^^^^^^^ +* Action X +* Action Y
\ No newline at end of file diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst new file mode 100644 index 0000000..2fca78b --- /dev/null +++ b/docs/platform/architecture.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Architecture +------------ + +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 + +ONAP-level Architecture +^^^^^^^^^^^^^^^^^^^^^^^ + +Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Amsterdam release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy. + +.. image:: images/overall-architecture-in-onap.png + +Holmes Architecture +^^^^^^^^^^^^^^^^^^^ + +Take a deep dive into Holmes, we could see it mainly consists of three modules, which are the rule management module, the engine management module and the data source adapter module respectively. + +The rule management module provides interfaces for the operations (e.g. creating, updating and deleting) on the rules. + +The data source adapter consists of subscribers and publishers, which are used to convert the data format into the one that could be digested by Holmes and vice versa. + +The engine management module is the core of Holmes. All the rules are deployed here. When alarms gets into Holmes, they will be pushed into the Drools engine and analyzed by the enabled rules one after another. When processing the alarms, a couple of attributes, such as the alarm name, the occurrence time of the alarm and so on, are utilized. Also, the topological information from A&AI is used in combination of the alarm attributes. After the root cause is identified, it will be converted into a control loop event and published to a specific DMaaP topic which is subscribed to by the Policy component. + +.. image:: images/holmes-architecture.png diff --git a/docs/platform/configuration.rst b/docs/platform/configuration.rst new file mode 100644 index 0000000..cedb443 --- /dev/null +++ b/docs/platform/configuration.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Configuration +------------- + +No machanism for customized configurtions is provided in the Amsterdam release. Such functionalities will be provided in the future if necessary. + diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst new file mode 100644 index 0000000..f6eebb0 --- /dev/null +++ b/docs/platform/consumedapis.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +------------- + +References to APIs offered by other components
\ No newline at end of file diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst new file mode 100644 index 0000000..27b3770 --- /dev/null +++ b/docs/platform/delivery.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Delivery +-------- + +Describe how functions are packaged into run-time components. For some components a block diagram may be useful. + +**TO BE DONE**
\ No newline at end of file diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst new file mode 100644 index 0000000..e8501d0 --- /dev/null +++ b/docs/platform/human-interfaces.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +---------------- +Provide info on the targeted user, interface types, ports/protocols to access, etc. + +Target Users +^^^^^^^^^^^^ + +Interface Type +^^^^^^^^^^^^^^ + +Access +^^^^^^
\ No newline at end of file diff --git a/docs/platform/images/holmes-architecture.png b/docs/platform/images/holmes-architecture.png Binary files differnew file mode 100644 index 0000000..b2bd2a9 --- /dev/null +++ b/docs/platform/images/holmes-architecture.png diff --git a/docs/platform/images/overall-architecture-in-onap.png b/docs/platform/images/overall-architecture-in-onap.png Binary files differnew file mode 100644 index 0000000..22c8227 --- /dev/null +++ b/docs/platform/images/overall-architecture-in-onap.png diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 0000000..19742bb --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,18 @@ +.. 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. + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + delivery.rst + log-and-diagnostic-info.rst + installation.rst + configuration.rst + administration.rst + human-interfaces.rst
\ No newline at end of file diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst new file mode 100644 index 0000000..7926680 --- /dev/null +++ b/docs/platform/installation.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Installation +------------ diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst new file mode 100644 index 0000000..4561eab --- /dev/null +++ b/docs/platform/log-and-diagnostic-info.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging & Diagnostic Information + + +Description of how to interact with and diagnose problems with the components as delivered. + +Where to Access Information +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Error / Warning Messages +^^^^^^^^^^^^^^^^^^^^^^^^
\ No newline at end of file diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst new file mode 100644 index 0000000..41142ed --- /dev/null +++ b/docs/platform/offeredapis.rst @@ -0,0 +1,10 @@ +Holmes Rule Management Component Offered APIs +================================== +The rule management module provides the following APIs. + +* Rule Creation +* Rule Update +* Rule Query +* Rule Deletion + +.. swaggerv2doc:: ../rulemgt/src/main/resources/swagger.json |
