Versions Compared

Key

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

...

  • S3P requirements approved by TSC
  • Optimizing the integration with Kubernetes based DCAE
  • Supporting the use cases which need correlation analysis

Use Cases

Minimum Viable Product

  • Scalable engine management component - the actual running place for Holmes rules.
  • Scalable rule management component - responsible for the CRUD operations on Holmes rules.
  • Rule templates/entities for specific use cases

...

Sub-Components

Please refer to the Resources and Repositories page.


Architecture

Architecture

...

List the API this project is expecting from other projects.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

...

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

Data Movement as a Platform APIsDMaaP message 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

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.

DCAE API Documentation

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 Documentation

API Outgoing Dependencies

...

API Name

API Description

API Definition Date

API Delivery date

API 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
Health CheckThis API is used by other components to check whether Holmes is working.

 

August, 24th, 2017Health Check - Beijing

Third Party Products Dependencies

...

Risk identifiedMitigation PlanContingency Plan
To fill outTo fill outTo fill out

Resources

Fill out the Resources Committed to the Release centralized page.

Release Milestone

...