Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Amsterdam |
| Project Lifecycle State | Incubation |
| Participating Company | ZTE, HUAWEI, China Mobile |
Scope
What is this release trying to address?
In the Amsterdam Release, Holmes mainly aims to support the VoLTE use case which is (partially) targeted at auto-healing of the virtual networks.
Generally, Holmes is intended for correlation analysis between different alarms originated from different VNFs or different layers of a certain VNF. To achieve the goal, Holmes will provide functionalities for event collecting & converting, rule management and result publishing, etc. Besides, as a stretch goal, Holmes will also try to integrate with CLAMP.
Use Cases
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.
Epics
Stories
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| Source Code | The source code of the sub-components listed below. |
| API description | A brief introduction of the APIs of Holmes. Both external and internal users (systems) could implement alarm analyses using these APIs. |
Sub-Components
Please refer to the Resources and Repositories page.
ONAP Dependencies
DMaaP - Subscribe to DMaaP topics and publish the analytic results to DMaaP.
CLAMP Project - Rule templates will be deployed into Holmes via CLAMP.
Policy Framework Project - The policy framework is a potential data consumer of Holmes.
Architecture
High level architecture diagram
Generally, the block diagram of Holmes is like this:
More specifically, taking DCAE, A&AI and other projects into account, the interactions between the projects are like this:
The diagram below depicts the inner structure/inner modules of Holmes.
High Level Sequence Diagram of Holmes
API Incoming Dependencies
List the API this release is expecting from other releases.
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. | <<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 this release is delivering to other releases.
| 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
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. | 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.
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
Gaps
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 impact.
| Gaps identified | Impact |
|---|---|
| To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| None | None | None |
Resources
Please refer to the Resources and Repositories page.
Release Milestone
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
Team Internal Milestone
This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable |
|---|---|---|
| To fill out | To fill out | To fill out |
Documentation, Training
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the 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
- ...
Note
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.
Free and Open Source Software
FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.
Each project must edit its project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.