The content of this template is expected to be fill out for M1 Release Planning Milestone.
| 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
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Enter the name of the release you are targeting to deliverIstanbul |
| Project Lifecycle State | Either Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
| Participating Company | List the company participating in this release. At least 3-4 organizations, including an operator are recommended. |
Scope
What is this release trying to address?
Describe the problem being solved by this release
Requirements
Describe the use case this release is targeted for (better if reference to customer requirements).
Minimum Viable Product
Describe the MVP for this release.
| Mature | |
| Participating Company | AT&T, Ericsson, Bell Canada |
Scope
Planned Updates
- Make policy-clamp official
- Make TOSCA Control Loop official
- Multi-cluster support
- Only send policy deltas to PDPs
- Allow rules to specify EventManagerService
- DB Enhancements
- Unify the representation of control loops in CLAMP
- Update control loop TOSCA to support design-time and runtime roles
- APEX-PDP enhancements
- SSL support in Kafka IO plugin
- Send notifications to DMaaP/Kafka
- Context album improvements
- Mount truststore via helm charts
- Add more flexible time and dayOfWeek capabilities in xacml-pdp
- Store audit details of policy deploy/undeploy in PAP
- Enhance consolidated health check to include dependencies (e.g., DMaaP connectivity)
- Usual sonar/code coverage improvements
- Archive policy-engine repo and change its status to “unmaintained”
Requirements
Please see the release requirements planned as identified in Policy Istanbul-R9 Architecture Review
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
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
Jira server ONAP JIRAJira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project =sanbox = POLICY AND fixVersion = "Istanbul Release" and resolution != "Won't Do" and issuetype in (epic) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Jira server ONAP JIRAJira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project =sanbox = POLICY AND fixVersion = "Istanbul Release" and resolution != "Won't Do" and issuetype in (story) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
| 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.
| Policy Drools PDP | Executable - supports Tosca Policies execution in the Drools PDP |
| MariaDB | SQL database
|
| Policy SDC Distribution Integration | Executable - receives SDC Service Distribution notifications and translates VNF/Service policies into runtime policies. |
| Policy Apex PDP | Executable - supports Tosca Policies execution in the Apex PDP |
| Policy Lifecycle API | Executable - supports the provisioning of Tosca Policies |
| Policy PAP | Executable - supports the administration of policies to PDPs at runtime |
| Policy XACML PDP | Executable - supports Tosca Policies execution in the XACML PDP |
| Policy CLAMP | Executable(s) - supports Policy creation via a GUI and TOSCA Control Loops |
Sub-Components
See the table above for the Policy subcomponents. Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
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.
Platform Maturity
ARC Policy Framework Component Description - Istanbul-R9
https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html
Platform Maturity
Please see Istanbul Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
API Incoming Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |||||
|---|---|---|---|---|---|---|---|---|---|
| AAF | Authentication | We are not expecting any upgrades for any of our requirements. | M3 | ||||||
| Dmaap | Message Router | We are not expecting any upgrades for any of our requirements. | M3 | ||||||
| SDC | Service Distribution | We are not expecting any upgrades for any of our requirements. DMaaP | M3 | ||||||
| AAI | Schema for custom query calls | We are not expecting any upgrades for any of our requirements. REST | M3 | ||||||
| SO | VF Module Create | We are not expecting any upgrades for any of our requirements. REST | M3 | ||||||
| SDNR | SDN-R component interface | We are not expecting any upgrades for any of our requirements. Dmaap - No direct link to any libraries | M3 | ||||||
| SDNC | SDN-C component interface | We are not expecting any upgrades for any of our requirements. Dmaap - No direct link to any libraries | M3 | ||||||
| VFC | VFC component interface | We are not expecting any upgrades for any of our requirements. REST | M3 | ||||||
| CDS | CDS component Interface | Upgrading to new CDS jars | M3 | 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 |
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, ...).
...
| 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 Health Check Policy Deployment Status PDP-Policy Deployment Status | 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 enforce 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
| Description | Version | |
|---|---|---|
| MariaDB | The MariaDB is the repository that holds all the policies, templates, PDP group, and deployment information. | 10.5.8 |
| OpenJDK | OpenJDK for Alpine from integration images (integration/docker/onap-java11 repository) | openjdk11:jre-11.0.11_9-alpine |
Testing and Integration Plans
The testing and integration activities are described in the following page: Policy R9 Istanbul CSIT/External Lab Functional Test Cases
Gaps
No gaps identified.
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.
...
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
Please refer to Frankfurt Defect StatusThere are no major known defects or issues.
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 - Frankfurt Risks
Resources
There are no known risks.
Resources
Please refer to the INFO.yaml for each policy repo:
https://git.onap.org/policy/apex-pdp/tree/INFO.yaml
https://git.onap.org/policy/api/tree/INFO.yaml
https://git.onap.org/policy/clamp/tree/INFO.yaml
https://git.onap.org/policy/common/tree/INFO.yaml
https://git.onap.org/policy/distribution/tree/INFO.yaml
https://git.onap.org/policy/docker/tree/INFO.yaml
https://git.onap.org/policy/drools-applications/tree/INFO.yaml
https://git.onap.org/policy/drools-pdp/tree/INFO.yaml
https://git.onap.org/policy/gui/tree/INFO.yaml
https://git.onap.org/policy/models/tree/INFO.yaml
https://git.onap.org/policy/parent/tree/INFO.yaml
https://git.onap.org/policy/pap/tree/INFO.yaml
https://git.onap.org/policy/xacml-pdp/tree/INFO.yamlFill out the Resources Committed to the Release centralized page.
Release Milestone
The milestones are defined at the Release Level and all the supporting project projects agreed to comply with these dates.
Team Internal Milestone
...
It is not expected to have a detailed project plan.
...
Documentation, Training
Please update the following centralized wiki: Frankfurt 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
- ...
...
| title | Note |
|---|
...
Documentation, Training
Minor updates are expected as documented in the Istanbul Documentation
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.N/A
Free and Open Source Software
...