Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Istanbul |
| Project Lifecycle State | 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
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, etc) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| 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.
Architecture
High level architecture diagram
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 Release Platform Maturity
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 |
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 |
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 |
|---|---|---|
| To fill out | To fill out | To fill out |
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
Please refer to Frankfurt Defect Status
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
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: 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
- ...
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.