Versions Compared

Key

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

...

The diagram below depicts the inner structure/inner modules of Holmes.

High Level Sequence Diagram of Holmes

Image Added

API Incoming Dependencies

...

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Data Movement as a Platform Message Router APIsDMaaP Message Router is a reliable, high-volume pub/sub messaging service with a RESTful HTTP API that is delivered as a web service using the JSC framework. The service is built over Apache Kafkamessage sub/pub related APIs which will be used by Holmes to collect the data from and publish data to DMaaP topics.

Data Movement as a Platform Message Router 

DMaaP Message Router API

The message router implements an API for various operations.DMaaP Message Router API

Resource QueryQuery different resource information from A&AI. All A&AI operations are implemented in the form of RESTful APIs. I'm using "Resource Query" as a general name for the APIs in case there will be too many APIs listed here.

AAI API
DCAE APIsAPIs used for service registration and discovery.

<<DocRef:DCAE API Documents>>

Service Registration/Un-registration

Service Discovery

The APIs used to register/un-register a micro-service to/from MSB .

The APIs used to discover another micro-service via MSB.



Microservice Bus API DocumentationResource QueryAAI API

API Outgoing Dependencies

...

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Rule CreatingThis API is intended for creating a rule in the database.

 

August, 24th, 2017Rule Management - Beijing
Rule ModifyingThis API is intended for modifying a rule in the database.

 

August, 24th, 2017Rule Management - Beijing
Rule DeletingThis API is intended for deleting a rule from the database.

 

August, 24th, 2017Rule Management - Beijing
Rule QueryThis API is intended for querying rules from the database.

 

August, 24th, 2017Rule Management - Beijing
Rule DeployingThis API is intended for deploying the rule(s) into the rule engine.

 

August, 24th, 2017Engine Management - Beijing
Rule Deleting from the Rule EngineThis API is intended for removing the rule(s) from the rule engine.

 

August, 24th, 2017Engine Management - Beijing
Rule VerifyingThis API is intended for verifying a rule.

 

August, 24th, 2017Engine Management - Beijing
Health CheckThis API is used by other components to check whether Holmes is working.

 

August, 24th, 2017Health Check - Beijing

Third Party Products Dependencies

...

Each project must edit its project table available at Project FOSS.


Charter Compliance

The project team comply with the ONAP Charter.

...