...

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

follow

Platform Maturity Requirements (aka Carrier Grade)

Info

title	Info

Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.

Table of Contents
outline true

Overview

Project Name	Enter the name of the project
Target Release Name

Enter the name of the release you are targeting to deliver

Beijing

Project Lifecycle State

Either

Incubation

, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information

Participating Company

List the company participating in this release. At least 3-4 organizations, including an operator are recommended.

Amdocs, AT&T, Bell

Scope

What is this release trying to address?

...

Describe the problem being solved by this release

Use Cases

...

Provide an ELK implementation for ONAP as described on https://kubernetes.io/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana/
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key LOG-89
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key LOG-95

Use Cases

Use Case: Residential Broadband vCPE (Approved)

Use Case: vFW/vDNS (Approved)

Use Case: VoLTE(approved)

Minimum Viable Product

Describe the The MVP for this release.

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.

Amsterdam will:

- Logging RI as a demo/reference for teams not currently running filebeat containers in their pods
  Currently the following are using filebeat already (aai, appc, so, policy, portal, sdc, sdnc, vid)
- Logging AOP based library for use by all component teams as a spring shared jar.
- Emit standardized, machine-readable logging output, correlated by transaction ID.
- Allow dynamic reconfiguration of logging providers.
- Provide a reference configuration for Elastic Stack, automatically deployed by Kubernetes and the ONAP Operations Manager.
- Provide reference configurations for shipping and indexing of ONAP logs to the ELK stack via filebeat.
- Provide standard Kibana dashboards for transaction traceability and general lucene spec log searches

Functionalities

Epics

Jira Legacy

server	System Jira
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues	20
jqlQuery	project=sanbox LOG and issuetype in (epic) and fixVersion = "Beijing Release"
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176

Stories

Jira Legacy

server	System Jira
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues	20
jqlQuery	project=sanbox LOG and issuetype in (story) and fixVersion = "Beijing Release"
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176

Longer

...

term roadmap

...

Release Deliverables

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

Deliverable Name	Deliverable Description

To fill outTo fill out

Sub-Components

List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.

...


Revised logging guidelines	Updates to What's New - ONAP Application Logging Guidelines reflecting new conventions and requirements.
Logging provider configuration defaults	Regularized configuration locations, simplifying deployment and customization.
Logging provider output defaults	Regularized output locations, simplifying deployment and customization, and the shipping and indexing of logs.
Logging provider migration	Optional standardization of logger providers, including upgrading from EOL Log4j 1.X.
Updated logging provider configuration(s)	Updated, standardized configurations for all logging providers and ONAP components - specific to OOM in the OOM repo.
Filebeat configuration	Reference configuration for Elastic Stack Filebeat shipping.
Logstash configuration	Reference configuration for Elastic Stack Logstash indexing.
Elasticsearch configuration	Reference configuration for Elastic Stack Elasticsearch.
Kibana configuration	Reference configuration for Elastic Stack's Kibana Discover UI.
Elastic Stack deployment	Automated OOM deployment of an Elastic Stack reference configuration, providing ONAP with an OOTB analytics platform.
Documentation	Other documentation supporting analytics configuration.

Sub-Components

none

Architecture

High level architecture diagram

At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.

Indicate where your project fit within the ONAP Archiecture diagram.

Block and sequence diagrams showing relation within the project as well as relation with external components are expected.

Anyone reading this section should have a good understanding of all the interacting modules.Filebeat agent microservice per component feeds logs via emptyDir persistent volumes from each component docker container to the ELK stack pod via the logstash container. These high level ELK paths are overlayed on a the reference vFirewall L4 use case of ONAP.

Image Added

We fit in the overall architecture of ONAP as an OOM Kubernetes pod of 3 containers (ELK) and a per/microservice logstash container above - and below

Logging Architecture#OOMDeployment

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

Performance

0

0 -- none
1 – baseline performance criteria identified and measured
2 & 3 – performance improvement plans created & implemented

Stability

1

OOM system up on cd.onap.info

for > 72 hours at ~10 tx/sec

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	LOG-144

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

2 (**)

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

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

1

0 – no ability to scale
1 – single site horizontal scaling
2 – geographic scaling
3 – scaling across multiple ONAP instances

Manageability

1

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

1 – user guide; deployment documentation; API documentation
2 – UI consistency; usability testing; tutorial documentation

** Standard OOB OOM Kubernetes resilience/stability

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)
To fill out	High level description of the API	Date for which the API is reviewed and agreed	To fill out	Link toward the detailed API description

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)

To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description

EELF

AT&T EELF

20170201

Beijing Relase

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

To fill outTo fill outTo fill out

JAX-RS

Java API for Restfull Service

2.0

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.

...

Unit testing is via each developer deploying their change locally on their OOM deployment

Integration CD testing hourly via the following framework exercises the ELK stack pods in OOM

http://jenkins.onap.info/job/oom-cd/

reported on http://kibana.onap.info:5601/app/kibana

Work to formalize the CI/CD framework is being done via

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	OOM-500

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.

Jira Legacy

server	System Jira
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues	20
jqlQuery	project=sanbox LOG and issuetype in (bug)
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176

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
To fill out	To fill out	To fill out

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
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...)
Contributions: Logging Guidelines, the wiki and read-the-docs content.
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

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

...

Versions Compared

Old Version 2

New Version Current

Key

Table of Contents
outline true

Overview

Scope

What is this release trying to address?

Use Cases

Use Cases

Minimum Viable Product

Functionalities

Functionalities

Epics

Stories

Longer

term roadmap

Release Deliverables

Sub-Components

Architecture

High level architecture diagram

Platform Maturity

API Incoming Dependencies

API Outgoing Dependencies

Third Party Products Dependencies

Testing and Integration Plans

Gaps

Known Defects and Issues

Risks

Resources

Release Milestone

Team Internal Milestone

Documentation, Training

Other Information

Vendor Neutral

Free and Open Source Software

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Table of ContentsoutlinetrueOverview

Scope

What is this release trying to address?

Use Cases

Use Cases

Minimum Viable Product

Functionalities

Functionalities

Epics

Stories

Longer

term roadmap

Release Deliverables

Sub-Components

Architecture

High level architecture diagram

Platform Maturity

API Incoming Dependencies

API Outgoing Dependencies

Third Party Products Dependencies

Testing and Integration Plans

Gaps

Known Defects and Issues

Risks

Resources

Release Milestone

Team Internal Milestone

Documentation, Training

Other Information

Vendor Neutral

Free and Open Source Software

Table of Contents
outline true

Overview