LOG M1 Release Planning
DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
- 1 Overview
- 2 Scope
- 3 Release Deliverables
- 4 Sub-Components
- 5 ONAP Dependencies
- 6 Architecture
- 7 Testing and Integration Plans
- 8 Gaps
- 9 Known Defects and Issues
- 10 Risks
- 11 Resources
- 12 Release Milestone
- 13 Team Internal Milestone
- 14 Documentation, Training
- 14.1 Note
- 15 Other Information
- 16 Charter Compliance
- 17 Release Key Facts
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Amsterdam Release |
Project Lifecycle State | Incubation (Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
Participating Company | AT&T, Bell, Amdocs |
Scope
What is this release trying to address?
The scope of the Amsterdam Release of A&AI will address the approved R1 Amsterdam use cases.
Highest priority will be assigned to support the approved use cases; however, additional development will continue to support additional features not included in the approved use cases.
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
Use Case: Residential Broadband vCPE (Approved)
Minimum Viable Product
The MVP for Amsterdam will:
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
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
Stories
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
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, 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. |
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-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
List the other ONAP projects your depends on.
There is a dependency on all run-time components used within the use cases to
Conform to the standardization of logger provider configuration
Ensure Transaction ID propagation
There is a dependency on OOM in order to deploy this new component
Documentation project - we are depending on the documentation project for documentation
Usecase Project - we are dependent on the Usecase project to provide the basis for Amsterdam requirements
Architecture
High level architecture diagram
In the reference configuration, the Elastic Search pipeline is configured to read files from persistent volumes. The impact on ONAP components is limited to logging provider configuration.
API Incoming Dependencies
None.
API Outgoing Dependencies
None.
Third Party Products Dependencies
Name | Description | Version |
---|---|---|
Elastic Stack | Analytics platform comprising Filebeat, Logstash, Elasticsearch and Kibana. | 5.5+ |
Kubernetes | Container orchestration system | Aligned with OOM. |
Logback | Logging provider | Unchanged. |
Log4j | Logging provider | Unchanged. |
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.
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 |
---|---|
To fill out | To fill out |
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).
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...).
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.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.