...
What is this release trying to address?
Basic Goals:
- to update Java from Version 8 to Version 11
- to integrate with AAF
- to upgrade AAI APIs used by Holmes
Stretched Goals:
- to make Holmes model-driven
- to implement the S3P requirements
Requirements
| Jira | ||||||
|---|---|---|---|---|---|---|
|
- to deliver the MDONS
- to develop assistant tool kits for MDONS
Minimum Viable Product
- rules for CCVNP/VoLTE/MDONS
- the rule management component
- the engine management component
.
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.
...
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| API description | A brief introduction of the APIs of Holmes. Both external and internal users (systems) could implement alarm analyses using these APIs |
| Documentation | Installation manual, user guide, etc. |
| Release Notes | Release notes of the release |
| Source Code | The 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 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
There's no API intended for other projects. The internal APIs are like following (there have been no modifications on APIs since Dublin, so we'll reuse the docs from Dublin.):
| 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 - Dublin |
| Rule Modifying | This API is intended for modifying a rule in the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Rule Deleting | This API is intended for deleting a rule from the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Rule Query | This API is intended for querying rules from the database. |
| August, 24th, 2017 | Rule Management - Dublin |
| Health Check | This API is used by other components to check whether Holmes is working. |
| August, 24th, 2017 | Health Check - Dublin |
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. | 6.5.0.Final |
| PostgreSQL | PostgreSQL is used for the sake of data (holmes rules) persistance. | 9.5.0 |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...