Versions Compared

Key

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

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox holmes and issuetype in (epic) and status != Done and fixVersion = "Casablanca Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox holmes and issuetype in (story, task) and fixVersion = "Casablanca Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

  • A user friendly GUI for the sake of rule management
  • AI supportive

Release Deliverables

Deliverable Name

Deliverable Description

API descriptionA brief introduction of the APIs of Holmes. Both external and internal users (systems) could implement alarm analyses using these APIs.
DocumentationInstallation manual, user guide, etc.
Release NoteRelease note of the release
Source CodeThe source code of the sub-components listed below.

Sub-Components

Please refer to the Resources and Repositories page.

...

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 this project is delivering to other projects.



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

...

Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).

Name

Description

Version

Drools (JBoss Rules)Drools is a Business Rules Management System (BRMS) solution. It provides a core Business Rules Engine (BRE), a web authoring and rules management application (Drools Workbench) and an Eclipse IDE plugin for core development.7.5.0
PostgreSQLPostgreSQL is used for the sake of data (holmes rules) persistance.9.5.0


Testing and Integration Plans

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox holmes and issuetype in (bug) epic) and status != Done and fixVersion = "Casablanca Release" and affectedVersion = "Beijing Release"
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...