DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox holmes and issuetype in (epic) and status != Done and fixVersion = "Dublin Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox holmes and issuetype in (story, task) and fixVersion = "Dublin Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
Sub-Components
Please refer to the Resources and Repositories page.
Architecture
High level architecture diagram
...
Holmes itself consists of three main sub-modules: the rule management module, the engine management module and the data source adapter. The rule management module is mainly responsible for the CRUD operations of Holmes rules and persisting the rules into a database. The engine management module uses the Drools engine as its core component to support correlation analysis among alarms. The data source adapter is used as the data format converter between Holmes and other components. The module diagram is like below:
Platform Maturity
...
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 APIs | DMaaP message sub/pub related APIs which will be used by Holmes to collect the data from and publish data to DMaaP topics. | |||
| Resource Query | Query 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 APIs | APIs 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 Creating | This API is intended for creating a rule in the database. |
| August, 24th, 2017 | Rule Management - Beijing |
| Rule Modifying | This API is intended for modifying a rule in the database. |
| August, 24th, 2017 | Rule Management - Beijing |
| Rule Deleting | This API is intended for deleting a rule from the database. |
| August, 24th, 2017 | Rule Management - Beijing |
| Rule Query | This API is intended for querying rules from the database. |
| August, 24th, 2017 | Rule Management - Beijing |
| Health Check | This API is used by other components to check whether Holmes is working. |
| August, 24th, 2017 | Health Check - Beijing |
Third Party Products Dependencies
...
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| To fill out | To fill out | To fill out |
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
...