Logging Casablanca M1 Release Planning

Owned by Michael O'Brien
Last updated: Jul 24, 2018
5 min read

DRAFT PROPOSAL FOR COMMENTS

The content of this template is expected to be fill out for M1 Release Planning Milestone - due 27 June via Release Planning


Overview

Logging

Logging

Logging

Logging

Target Release Name

Casablanca

Project Lifecycle State

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

Participating Company 

Amdocs, AT&T, Bell

Scope

What is this release trying to address?

Logging related collection, shipping, indexing, storage, searching, display.  And S3P performance, scaling, resiliency of the ELK stack and filebeat infrastructure.

Additional stretch goals is a pluggable common ELK chart.

Adding the POMBA audit seed code.

Use Cases

Log collection and triage of any ONAP supported use case transaction for vFW, vDNS, vVOLTE or vCPE

(POMBA) audit of any of the above use case transactions for the purposes of out of band model based audit.

Minimum Viable Product

ELK stack functions

POMBA stack functions

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

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

Spec level integration with Acumos to allow cross platform transaction triage.

https://lf-onap.atlassian.net/browse/LOG-264

https://jira.acumos.org/browse/ACUMOS-710

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

To fill out

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

Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.

Release Components Name

Components Name

Components Repository name

Maven Group ID

Maven Artifact ID

Java package name

Components Description

Components Name

Components Repository name

Maven Group ID

Maven Artifact ID

Java package name

Components Description

Components Name

Components Repository name

Maven Group ID

Maven Artifact ID

Java package name

Components Description

logging-analytics

logging-analytics

org.onap.logging-analytics

logging-analytics

org.onap.logging

A reference analytics pipeline configuration

pomba-context-aggregator

logging-analytics/pomba/pomba-context-aggregator

org.onap.pomba



pomba-context-aggregator

org.onap.pomba.context.aggregator

Orchestrates calls to various context builders and aggregates data from various data sources into one single payload

pomba-aai-context-builder 

logging-analytics/pomba/pomba-aai-context-builder 

org.onap.pomba 

pomba-aai-context-builder

org.onap.pomba.contextbuilder.aai

AAI Context builder. Interacts with A&AI and transforms A&AI data into common model structure

pomba-sdc-context-builder

logging-analytics/pomba/pomba-sdc-context-builder

org.onap.pomba

pomba-sdc-context-builder

org.onap.pomba.contextbuilder.sdc

SDC Context builder. Interacts with SDC and transforms SDC TOSCA CSAR into common model structure

pomba-sdnc-context-builder

logging-analytics/pomba/pomba-sdnc-context-builder

org.onap.pomba

pomba-sdnc-context-builder

org.onap.pomba.contextbuilder.sdnc

SDN-C Context Builder. Interacts with SDN-C and transforms SDN-C data into common model structure

pomba-network-discovery-context-builder

logging-analytics/pomba/pomba-network-discovery-context-builder

org.onap.pomba

pomba-network-discovery-context-builder

org.onap.pomba.contextbuilder.networkdiscovery

Network Discovery Context Builder. Interacts with Network discovery component and transforms its data into common model structure

pomba-audit-common

logging-analytics/pomba/pomba-audit-common

org.onap.pomba

pomba-audit-common

org.onap.pomba.common.audit

POJO project. Holds POMBA common  model POJO representation

Resources committed to the Releaseb

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.

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

1

2

address logstash and elasticsearch scaling

LOG-380: Platform Maturity: Performance, Stability, Resiliency, ScalabilityClosed

https://lf-onap.atlassian.net/browse/LOG-376

  • 0 -- none

  • 1 – baseline performance criteria identified and measured

  • 2 & 3 – performance improvement plans created & implemented

Stability

2

3

LOG-380: Platform Maturity: Performance, Stability, Resiliency, ScalabilityClosed

  • 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

2

LOG-380: Platform Maturity: Performance, Stability, Resiliency, ScalabilityClosed

  • 0 – none

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

  • 2 – automated detection and recovery (single site)

  • 3 – automated detection and recovery (geo redundancy)

Security

1

2

LOG-409: ELK securityClosed

  • 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

1

LOG-380: Platform Maturity: Performance, Stability, Resiliency, ScalabilityClosed

  • 0 – no ability to scale

  • 1 – single site horizontal scaling

  • 2 – geographic scaling

  • 3 – scaling across multiple ONAP instances

Manageability

1

2



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

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

Usability

1

2



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

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)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

POMBA Audit Inititiation

API to inititiate POMBA Audit

Date for which the API is reviewed and agreed

To fill out

POMBA Audit Initiation Swagger

POMBA Context Builders

API that must be supported by all Context Builders





POMBA Context Builder Swagger

  • 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

ElasticSearch

ES is part of the ELK stack

5.5.0 - will upgrade to 5.6.0

Logstash

LS is part of the ELK stack

5.5.0 - will upgrade to 5.6.0

Kibana

KB is part of the ELK stack

5.5.0 - will upgrade to 5.6.0


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

Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.

  • 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

To fill out

To fill out

  • 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

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

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

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