The content of this template is expected to be fill filled 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. |
...
| 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. Please refer to Istanbul to Jakarta Documentation. |
| Release Notes | Release notes of the release |
| Source Code | The source code of the sub-components is listed below. |
Sub-Components
...
High level architecture diagram
Holmes is architecturally an architecturally an analytics application reside residing within DCAE.
Normally, it is deployed by DCAE. But if users want to use Holmes independently (without DCAE), it could also be deployed in a standalone mode in the form of ordinary docker containers.
The interaction diagram between Holmes and its relative components is depicted below:
Holmes itself consists of two basic sub-modules: the rule management module and the engine management module. 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 module diagram is like below:
Platform Maturity
Please fill out the centralized wiki page: Istanbul Jakarta Release Platform Maturity
API Incoming Dependencies
List the API this project is expecting from other projects.
Prior to the Release Planning review, Team Leads must agreed agree on the date by which the API will be fully defined. The API Delivery date must not be later than the 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 | ||
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 - 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
...
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its their impact.
| Gaps identified | Impact |
|---|---|
| To fill out | To fill out |
...
Please update any risk on the centralized wiki page - Istanbul Jakarta Risks
Resources
Please see the INFO.yaml files associated with each repo as the authoritative sources of information. https://gerrit.onap.org/r/admin/repos/q/filter:holmes
...
The milestones are defined at the Release Planning: IstanbulJakarta and all the supporting project agreed to comply with these dates.
...
Please update the following centralized wiki: Istanbul Jakarta Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- Team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
...