...
Project Name | Enter the name of the project |
---|---|
Target Release Name | Beijing |
Project Lifecycle State | MatureIncubation |
Participating Company | Amdocs, AT&T, Bell |
Scope
What is this release trying to address?
...
The MVP for Amsterdam will:
- Logging RI as a demo/reference for teams not currently running filebeat containers in their pods
Logging Library- 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
by Elastic Stack.- Support other Elastic Stack configurations and/or (unspecified) analytics platforms.
Functionalities
...
- to the ELK stack via filebeat.
- Provide standard Kibana dashboards for transaction traceability and general lucene spec log searches
Functionalities
Epics
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Longer term roadmap
...
term roadmap
...
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|---|
Revised logging guidelines | Updates to ONAP application logging guidelines.pdf, 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
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.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.
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.
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.
...