The content of this template is expected to be fill out for M1 Release Planning Milestone.

Overview

Scope

What is this release trying to address?

• to integrate with AAF
• to make Holmes model driven
• to implement the S3P requirements
• to upgrade AAI APIs used by Holmes

Requirements

None.

Minimum Viable Product

• rules for CCVNP/VoLTE
• 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.

Epics

Stories

Longer term roadmap

• better integration with CLAMP
• integration with Acumos
• integration with ORAN

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.

Sub-Components

Please refer to the Resources and Repositories page.

Architecture

High level architecture diagram

Holmes is architecturally an analytics application reside 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 three main sub-modules: the rule management module, the engine management module and the data source adapter. 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 data source adapter is used as the data format converter between Holmes and other components. The module diagram is like below:

Platform Maturity

Please fill out the centralized wiki page: Frankfurt Release Platform Maturity

• Document current upgrade component strategy
  • For the application itself, since it's based on microservices, it's easy to replace the docker containers with the required version. The main focus for upgrade is to adapt the application to the database related changes. To achieve, we intend to add new DDLs as script files with a specific version number into the new docker image, assuring that each new image has all DDLs (which reflect the changes on the database) contained in older images. We use the version number of the script files as a trace to upgrade our application by running the script files contained in the image version by version.
• SECCOM Perform Software Composition Analysis - Vulnerability tables
  • We'll check and update the vulnerability table of Holmes before each milestone comes. The corresponding ticket could be found in JIRA backlog.
• SECCOM Password removal from OOM HELM charts
  • There's no password in OOM HELM chart for HOLMES.
• SECCOM HTTPS communication vs. HTTP
  • There's a switch for users within Holmes to decide whether they want to enable HTTP or not. By default, HTTP is disabled for Holmes containers. But users could enable it by changing the parameter when running the docker container. 

• API Incoming Dependencies

List the API this project is expecting from other projects.
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 Outgoing Dependencies

There's no API intended for other projects. The internal APIs are like following:

• 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, ...).

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

• Testing and Integration Plans

• For unit tests, we are going to keep the line coverage of each module to be above 50% 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 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 requirement tested.

• 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.

• Known Defects and Issues

Please refer to Frankfurt Defect Status

• 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).

Please update any risk on the centralized wiki page - Frankfurt Risks

• Resources

Fill out the Resources Committed to the Release centralized 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.

• Documentation, Training

Please update the following centralized wiki: Frankfurt 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
  • ...

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.