ARC Holmes Component Description - Montreal-R13
- Chaker Al-Hakim
- Byung-Woo Jun
Page Status: Updated for Montreal Nov 1, 2023
Component Status: Approved
Last Reviewed on: Dec 14, 2021
Certified by:
1. High Level Component Definition and Architectural Relationships
2. Component API definitions
Template Component provides the following interfaces:
Offered Interface Name | Offered Interface Description | Capabilities | Version(s) | Status | Model | API Specs (Swagger) |
HOLMESE-1 | This is a set of rule management interfaces, which is mainly intended for the CRUD actions of the rules of Holmes. | Allows applications to create, update, delete, and query the rule entities. | 1.0.0 | production | Defined by Holmes | |
HOLMESE-2 | Health check. | Allows other applications to perform healthcheck on Holmes. | 1.0.0 | production | - |
Note: xxxI interface is a internal interface. xxxxE interface is a external interface
Template Component consumes the following Interfaces:
Consumed Interface Name | Consumed Interface Description | Version(s) | API Spec (Swagger) |
POE-4 | To send the closed control loop events to policy to trigger downstream actions. | - | |
DMaaP-2 | To retrieve VES events from DMaaP. | 4.0.0 | |
DMaaP-3 | To send closed control loop events to DMaaP. | ||
AAIE-1 | To query resource information from A&AI. | v19 |
3. Component Description:
A more detailed figure and description of the component.
https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/architecture.html
4. Dependencies on other ONAP Components
AAF - the HTTPS certificates are provided by AAF.
AAI - Holmes needs the resource information to perform alarm analysis. Without AAI, the capability of Holmes will be partially unavailable (rules depending on resource information will lose the ability to analyze alarms).
DMaaP - The main input of Holmes. For now, if DMaaP stops work, Holmes could get VES data from nowhere.
OOM - OOM is responsible for the deployment of Holmes. Without OOM, Holmes could also run in a standalone mode, but all OOM/Helm-related functionalities will be lost.
5. Component Deployment Architecture
https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/release-notes.html
6. New Release Capabilities
In the Jakarta release, Holmes will complete the DCAE transformation to remove dependencies on Consul and CBS.
REQ-1038: DCAE Transformation to support Helm (Phase3/final)In Progress
Changes on the workflow:
Before | After |
|---|---|
 |  |
7. References
More documents about API : Holmes API Documentation - Honolulu (As the APIs are the same as in Honolulu, so we pasted the link of the Honolulu doc here to avoid having another identical page.)