Holmes Release Planning for Beijing

Owned by Guangrong Fu
Last updated: Jan 15, 2018
7 min read


Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

Beijing

Project Lifecycle State

Incubation

Participating Company 

ZTE, HUAWEI, China Mobile

Scope

What is this release trying to address?

In this release, Holmes will mainly focus on the non-functional requirements regarding platform maturity. The main targets are (ref: Platform Maturity Requirements (aka Carrier Grade)):

  • Performance - Level 1

  • Stability - Level 1

  • Resiliency - Level 1 (Level 2 as a stretch goal)

  • Security - Level 1

  • Scalability - Level 1

  • Manageablity - Level 1

  • Usability - Level 1

Besides, Holmes plans to provide a basic GUI to support simple CRUD operations.

Use Cases

Use Case: VoLTE(approved)

Minimum Viable Product

Holmes engine management component - the actual running place for Holmes rules.

Holmes rule management component - responsible for the CRUD operations on Holmes rules.

Holmes data source adapter module - to collect and convert (if needed) the data to the format in which could be interpreted by Holmes. 

A GUI for rule management - to provide a GUI for users to conveniently edit the rules. (NEW)

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

key summary type created updated due assignee reporter priority status resolution
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
Refresh



Longer term roadmap

  • Unify the user experience among Policy/CLAMP/SDC during the design phase.

  • Interface with OSAM.

  • AI supportive.

Release Deliverables

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

Deliverable Name

Deliverable Description

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.

Documentation

Installation manual, user guide, etc.

Release Note

Release note of the 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

Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Performance

0

1

  • To carry out performance tests to get the baseline. This baseline will be used as the start line of our improvement of the component performance.

  • 0 -- none

  • 1 – baseline performance criteria identified and measured

  • 2 & 3 – performance improvement plans created & implemented

Stability

0

1

  • Perform long-time soaking tests within our team and fix the findings.

  • Give the data set to the integration team and ask them to help to carry out a 72 soak test in the integration lab.

  • 0 – none

  • 1 – 72 hours component level soak w/random transactions

  • 2 – 72 hours platform level soak w/random transactions

  • 3 – 6 months track record of reduced defect rate

Resiliency

1

1

  • Holmes is a light-weighted component so the init time is less than 30 mins by nature.

  • What we are going to do is to enhance our data persistency a little bit so that after our system is down, we could recover the data along with the recovery of the component itself.

  • 0 – none

  • 1 – manual failure and recovery (< 30 minutes)

  • 2 – automated detection and recovery (single site)

  • 3 – automated detection and recovery (geo redundancy)

Security

0

1

  • Only 2 modules' UT coverage is under 50%, but it's already above 45%. So what we gonna do is to raise the UT coverage of these 2 modules first.

  • Change all http interfaces into an https approach.

  • 0 – none

  • 1 – CII Passing badge + 50% Test Coverage

  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls

  • 3 – CII Gold

Scalability

0

1

  • This part of work actually could be partly designed and implementated together with the "Resiliency" requirements because they both have something to do with the data persistency and recovery.

  • Beside the data persistency and recovery, we have to design how to solve the load balancing issues.

  • 0 – no ability to scale

  • 1 – single site horizontal scaling

  • 2 – geographic scaling

  • 3 – scaling across multiple ONAP instances

Manageability

0

1

  • Holmes has been using Log4j as its logging tool from the very beginning. What we have to do is to regularize the logging infomation a little bit in order to comply to the requirements from the Logging Enhancements Project.

  • 1 – single logging system across components; instantiation in < 1 hour

  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management

Usability

0

1

  • All documents are already. What we are going to do is to keep them updated according to the latest dev status of Holmes.

  • 1 – user guide; deployment documentation; API documentation

  • 2 – UI consistency; usability testing; tutorial documentation



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 Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

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.





Data Movement as a Platform Message Router 

DMaaP Message Router API

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

API this project is delivering to other projects.

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

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.

Jun 28, 2017 

August, 24th, 2017

Rule Management - Beijing

Rule Modifying

This API is intended for modifying a rule in the database.

Jun 28, 2017 

August, 24th, 2017

Rule Management - Beijing

Rule Deleting

This API is intended for deleting a rule from the database.

Jun 28, 2017 

August, 24th, 2017

Rule Management - Beijing

Rule Query

This API is intended for querying rules from the database.

Jun 28, 2017 

August, 24th, 2017

Rule Management - Beijing

Health Check

This API is used by other components to check whether Holmes is working.

Aug 17, 2017 

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

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.

7.5.0

PostgreSQL

PostgreSQL is used for the sake of data (holmes rules) persistance.

9.5.0


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.

Gaps identified

Impact

Gaps identified

Impact

-

-

Known Defects and Issues

Provide a link toward the list of all known project bugs.

key summary type created updated due assignee reporter priority status resolution
Refresh

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

Risk identified

Mitigation Plan

Contingency Plan

-

-

-

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.

Date

Project

Deliverable

Date

Project

Deliverable

-

-

-

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.