DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
20181207: updating - offsite until Wed
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Logging | Logging |
|---|---|
| Target Release Name | Dublin |
| 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.
Implementation of the marker/MDC related specification finalized in Casablanca
Additional stretch goals is a pluggable common ELK chart., prometheus integration
Adjusting the POMBA audit API.
...
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
Logging-analytics
Jira server ONAP 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 = "Dublin release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
POMBA
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery filter=11330 serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Logging-analytics
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox and issuetype in (story) key in (LOG-945,LOG-944,LOG-943,LOG-941,LOG-940,LOG-938,LOG-937,LOG-912,LOG-902,LOG-899,LOG-898,LOG-895,LOG-889,LOG-877,LOG-876) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
POMBA
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery filter=11359 serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
| Deliverable Name | Deliverable Description | ||
|---|---|---|---|
pomba jar/war/dockers logging jar/war | see sub-components | 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.
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 |
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
See logging streaming filebeat sidecars all feeding into the Logging ELK stack - the containers we will be adding/re-adding are in red.
Log Streaming Compliance and API
POMBA
Refer to POMBA Architecture
Platform Maturity
Dublin Release Platform Maturity
Referring 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 log/pomba | Targeted Level for current Release | How, Evidences | Comments |
|---|---|---|---|---|
| Performance | 2/2 | 2/2 | via k8s |
|
| Stability | 2/2 | 3/3 | via k8s |
|
| Resiliency | 2/2 | 2/2 | via k8s |
|
| Security | 0/1 | 1/1 | with AAF |
|
| Scalability | 1/1 | 1/1 | via k8s |
|
| Manageability | 1/1 | 1/1 | via k8s |
|
| Usability | 1/1 | 1/1 |
|
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |||||
|---|---|---|---|---|---|---|---|---|---|
| ELK stack | Kibana, Logstash, elasticsearch REST endpoints | Since Amsterdam | 1.2.2 already out in Casablanca | Active Logging Specifications | 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 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
|---|---|---|---|---|---|---|---|---|
| POMBA Audit Initiation | API to initiate POMBA Audit | Casablanca | Casablanca |
Third Party Products Dependencies
...
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.
Logging-analytics
Reference Implementation is at https://git.onap.org/logging-analytics/tree/reference - defined by Logging Developer Guide
POMBA
POMBA - Functional Test Cases (Dublin)
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.
...
Provide a link toward the list of all known project bugs.
Logging-analytics
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
POMBA
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| To fill outnone yet | To fill out | To fill out |
Resources
Fill out the Resources Committed to the Release centralized page.
Release 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 recommended to provide these agreements and dates in this section.
...