Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The content of this template is expected to be fill filled out for M1 Release Planning Milestone.

Info
titleInfo

Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much many diagrams and flow charts as you need, directly in the wiki, to convey your message.

...

Deliverable NameDeliverable Description
API descriptionA brief introduction of the APIs of Holmes. Both external and internal users (systems) could implement alarm analyses using these APIs
DocumentationInstallation manual, user guide, etc. Please refer to Istanbul to Jakarta Documentation.
Release NotesRelease notes of the release
Source CodeThe source code of the sub-components is listed below.

Sub-Components

...

High level architecture diagram

Holmes is architecturally an architecturally an analytics application reside residing within DCAE.

Image RemovedImage Added

Normally, it is deployed by DCAE. But if users want to use Holmes independently (without DCAE), it could also be deployed in a standalone mode in the form of ordinary docker containers.

The interaction diagram between Holmes and its relative components is depicted below:

Image RemovedImage Added

Holmes itself consists of two basic sub-modules: the rule management module and the engine management module. The rule management module is mainly responsible for the CRUD operations of Holmes rules and persisting the rules into a database. The engine management module uses the Drools engine as its core component to support correlation analysis among alarms. The module diagram is like below:

...