The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Guilin |
Project Lifecycle State | Incubation |
Participating Company | AT&T, Ericsson, Bell Canada, Ciena, Wipro |
Scope
What is this release trying to address?
Scope | Priority | Committer Lead | Resources Committed | Epics | Dependencies |
---|---|---|---|---|---|
TSC Must Haves | Highest | ||||
Policy Lifecycle & Administration API enhancements | High | ||||
Control Loop Sub Committee Functional Requirements | High | ||||
Cleanup of Policy repos to remove legacy policy/engine and all related code base. | High | All resources are supporting these tasks. | |||
Actor model enhancements | Medium | ||||
Add DMN (Decision Modeling Notation) evaluation support to drools-pdp | Medium | Chris Ramstad & Ciena team | |||
Contributions from AT&T | Medium | Bobby Mander & Internal AT&T Policy Team | |||
Technical Debt - addressing bugs, leftover work from Frankfurt, code coverage, sonar fixes, etc. | Medium | All resources are supporting these tasks. | |||
5G OOF Use Cases - Control Loop Coordination usage | Medium | Wipro team | |||
E2E Network Slicing use case | Medium | Wipro team |
Requirements
Requirement | Impact | Epic/Story | Notes |
---|---|---|---|
Small | |||
Small | |||
Medium | |||
Small | |||
Small | |||
Medium | |||
Small | |||
Medium |
Minimum Viable Product
The following application components are the MVP from this release.
- Policy Lifecycle API component
- Policy Administration Point component
- PDP-A - Apex PDP Engine
- PDP-D - Drools PDP Engine
- PDP-X - XACML PDP Engine
- Policy Distribution Component
The following legacy applications components will be part of this release:
- Policy Portal Dashboard - GUI
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.
Policy R7 Guilin Architecture Review
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
Deliverable Name | Deliverable Description |
---|---|
Policy Drools PDP | Executable (supports both legacy and latest components) |
MariaDB | SQL database
|
Nexus Repo | This repository is used by the Policy Drools PDP to retrieve distributed policies and their dependent jars. |
Policy SDC Distribution Integration | Executable - receives SDC Service Distribution notifications and translates VNF/Service policies into runtime policies. |
Policy Apex PDP | Executable |
Policy Lifecycle API | Executable |
Policy PAP | Executable |
Policy XACML PDP | Executable |
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.
Policy Framework does not have any sub-components.
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 Architecture 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.
ARC Policy Framework Component Description - Guilin (R7) Release
https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html
Platform Maturity
Please fill out the centralized wiki page: Guilin Release Platform Maturity
This has been filled out.
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) |
---|---|---|---|---|
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 |
Portal | Portal SDK | Current version 2.6.0 - any upgrades required must be defined before M3 | M3 | |
AAF | Authentication | We are not expecting any upgrades for any of our requirements. Current version v2.1.21 - any upgrades required by AAF must be defined before M3 | M3 | |
Dmaap | Message Router | We are not expecting any upgrades for any of our requirements. Current version v1.1.11 - any upgrades required must be defined before M3 | M3 | |
SDC | Service Distribution | We are not expecting any upgrades for any of our requirements. Current version v1.6.5 - any upgrades required must be defined before M3 | M3 | |
AAI | Schema for custom query calls | We are not expecting any upgrades for any of our requirements. Current schema v16 aai-schema 1.7.2 - any upgrades required must be defined before M3 | M3 | |
SO | VF Module Create | We are not expecting any upgrades for any of our requirements. REST | M3 | |
SDNR | We are not expecting any upgrades for any of our requirements. Dmaap - No direct link to any libraries | M3 | ||
SDNC | We are not expecting any upgrades for any of our requirements. Dmaap - No direct link to any libraries | M3 | ||
VFC | We are not expecting any upgrades for any of our requirements. REST | M3 | ||
CDS | We are not expecting any upgrades for any of our requirements. Current version v0.4.4 - any upgrades required must be defined before M3 | M3 |
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) |
---|---|---|---|---|
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 |
Policy Lifecycle API | CRUD for Policy Types and Policies | M3 | M3 | https://docs.onap.org/projects/onap-policy-parent/en/latest/api/api.html |
PAP API | PDP Group API and Deploy/Undeploy of Policies | M3 | M3 | https://docs.onap.org/projects/onap-policy-parent/en/latest/pap/pap.html |
Decision API | Client API for ONAP components to ask for Decision as to which policy they should be enforcement for a set of given attributes. | M3 | M3 | https://docs.onap.org/projects/onap-policy-parent/en/latest/xacml/decision-api.html |
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 |
---|---|---|
MariaDB | The MariaDB is the repository that holds all the policies, templates, PDP group, and deployment information. | 10.2.25 |
Nexus | The Nexus repository holds all the currently deployed Operational (i.e. Drools policies) and their dependent artifacts. | 2.14.13-01 |
Ubuntu | Operating system | 18.04 |
Alpine | Operating system | 3.11.3 |
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.
Policy R7 Guilin CSIT/External Lab Functional Test Cases
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 |
---|---|
Known Defects and Issues
N/A
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).
Please update any risk on the centralized wiki page - Guilin Risks
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
Please update the following centralized wiki: Guilin Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- 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.