HOLMES Component Documentations Kohn-R11

Page Status: DRAFTING

Component Status: INCUBATION

Last Reviewed on:

Certified by:

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



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

swagger.json

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.

-

Closed Loop Event Data Structure

DMaaP-2

To retrieve VES events from DMaaP.

4.0.0

swagger.json


DMaaP-3

To send closed control loop events to DMaaP.

AAIE-1

To query resource information from A&AI.

v19

aai_swagger_v19.html

aai_swagger_v19.yaml

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. Component Deployment Architecture

Should reference the deployment section in the component description template

https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/release-notes.html

5. 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

Before

After

6. References

  1.  More documents about API : Holmes API Documentation - Honolulu