The content of this template is expected to be filled out for M1 Release Planning Milestone.
...
What is this release trying to address?
...
- bugfix
...
| server | System Jira |
|---|---|
| serverId | 4733707d-2057-3a0f-ae5e-4fd8aff50176 |
| key | HOLMES-488 |
- platform maturity improvements
Requirements
None.
Minimum Viable Product
...
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=holmes and issuetype in (epic) and fixVersion='Jakarta Kohn Release' serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=holmes and issuetype in (story) and fixVersion='Jakarta Kohn Release' serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
...
| 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 Jakarta Kohn Documentation. |
| Release Notes | Release notes of the release |
| Source Code | The source code of the sub-components is listed below. |
...
Holmes is architecturally an analytics application residing that resides 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.
...
Please fill out the centralized wiki page: Jakarta Kohn 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 agree 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 | ||
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
...
| 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 7. 562.0.Final |
| PostgreSQL | PostgreSQL is used for the sake of data (holmes rules) persistancepersistence. | 9.5.0 |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...
- For unit tests, we are going to keep the line coverage of each module to be above 55% or even higher.
- For the functional tests, because there will be few functional requirements for Holmes, we will main reuse the current auto-testing scripts to promise that the basic functions of Holmes work well. As for the GUI part, we will add some new test cases onto to the wiki page and attach the corresponding testing report to it.
- For the non-functional requirements, we will set up a set of testing env and get them tested by ourselves. Meanwhile, we'll be collaborating with the integration team to get some advice on how to get all those platform maturity requirements tested.
...
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 Releaserelease.
List identified release gaps (if any), and their impact.
...
Please update any risk on the centralized wiki page - Jakarta Kohn 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 the Release Planning: Jakarta and Kohn and all the supporting project projects agreed to comply with these dates.
...
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 teams 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.
...
Please update the following centralized wiki: Jakarta Kohn Documentation
That includes
- Team contributions to the specific document related to he the 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
- ...
...