Versions Compared

Key

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

...

Component Status: Pending PTL Updates and ArchCom Review

Last Reviewed on:

Certified by:

1. High Level Component Definition and Architectural Relationships (template)

draw.io Diagram
bordertrue
diagramNameONAP_Component_Template
simpleViewerfalse
width
linksauto
tbstyletop
diagramDisplayNameholmes_r7
lboxtrue
diagramWidth861862
revision310


2. Template Component API definitions

...

Interface NameInterface Definition Interface CapabilitiesVersionStatusConsumed ModelsxxxE-1External Interface Definition. 

capabilities

x.y.z (according to strategy)

model-a

model-b

xxxI-2Internal interfaces if we want to raise them

 Display and update:

xxxxx

...

API Spec (Swagger)
HOLMESE-1This 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.0production

Defined by Holmes


HOLMESE-2Health check.Allows other applications to perform healthcheck on Holmes.1.0.0production-


Template Component consumes the following Interfaces:

Interface NamePurpose Reason For UseVersion(s)API Spec (Swagger)
POE-4SDCE-6To Recieve the Control Loop Blueprint from SDCTo recievePolicyE-2To create and configure the closed Loop Operational Policiessend the closed control loop events to policy to trigger downstream actions.-
DCAEEXT-7To retrieve default configurations (e.g. default rules and DMaaP configurations, etc.)-
DMaaP-2To retrieve VES events from DMaaP.-
DMaaP-3To send closed control loop events to DMaaP.-
AAIE-1To query resource information from A&AI.v19DCAEE-x Retrieve DCAE appplication statusDCAEE-y Deploy/remove DCAE application. 


3. Component Description:

A more detailed figure and description of the component.<< link to project-specific description elsewhere >>

https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/architecture.html

4. known system limitations

Architectural Technical Debt

Runtime: None

Clamp data redundancy is dependant on kubernetes and the persisten volume.

Clamp appliation redundancy HA reliease on kubernetes

  • Performance limitation: if it comes to high-performance scenarios, and A&AI happened to be needed for alarm analysis and correlation, there could be a performance bottleneck as all A&AI API calls are based on HTTP requests, which is considerably time-consuming.

5. System Deployment Architecture

FFS

...

<< list the new capabilities that were introduced in this release, or a hot-link to the key features. New sub-chapter per release, as per a release notes document >> 

7. References

...

https://docs.onap.

...

org/projects/onap-holmes-rule-management/en/latest/

...

release-notes.html

6. New Release Capabilities

  • MDONS support
  • AAF integration (stretch goal, because I'm not sure if I could get the necessary help from the AAF team)

7. References

  1.  More documents about API : Holmes API Documentation - Guilin CLAMP internal interfaces:  https://onap.readthedocs.io/en/latest/_downloads/d3c9f924c6586fe411d40a05ad9b1bb7/swagger.pdf