...

Table of Contents
outline true

Overview

Scope

What is this release trying to address?

Provide an ELK implementation for ONAP as described on https://kubernetes.io/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana/

...

Use Cases

Use Case: Residential Broadband vCPE (Approved)

Use Case: vFW/vDNS (Approved)

Use Case: VoLTE(approved)

Minimum Viable Product

The MVP for 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

Stories

Longer term roadmap

Release Deliverables

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

Sub-Components

none

Architecture

High level architecture diagram

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.

...

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.

...

** 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 Outgoing Dependencies

API this project is delivering to other projects.

• 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

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

...

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

• 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

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

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

...

• Documentation, Training

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

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.

...