...
Describe the use case this release is targeted for (better if reference to customer use case).
Minimum Viable Product
An analytic engine - to provide the run-time environment for drools rules.
A rule management module - to interact with external projects for the CRUD operations of rules.
A common library (- to support interactions with other projects, such DMaaP, CLAMP and A&AI, etc.)
A data source adapter module - to collect and convert (if needed) the data to the format in which could be interpreted by Holmes.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
...
Generally, the block diagram of Holmes is like this:
...
The diagram below depicts the inner structure/inner modules of Holmes.
High Level Sequence Diagram of Holmes
API Incoming Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description
|---|---|---|---|---|---|---|---|---|
| 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. | <<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 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 |
| Rule Deploying | This API is intended for deploying the rule(s) into the rule engine. |
| August, 24th, 2017 | Engine Management - Beijing |
| Rule Deleting from the Rule Engine | This API is intended for removing the rule(s) from the rule engine. |
| August, 24th, 2017 | Engine Management - Beijing |
| Rule Verifying | This API is intended for verifying a rule. |
| August, 24th, 2017 | Engine 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
...
| 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. | To be clarified |
| MySQL | MySQL is the world's most popular open source database. With its proven performance, reliability and ease-of-use, MySQL has become the leading database choice for web-based applications. | To be clarified |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
Each project must edit its project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.
...