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) |
|---|---|---|---|---|
| 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 |
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) |
|---|---|---|---|---|
| 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.
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
There are no major known defects or issues.
Risks
There are no known risks.
Resources
Please refer to the INFO.yaml for each policy repo:
https://git.onap.org/policy/xacml-pdp/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/models/tree/INFO.yaml
https://git.onap.org/policy/gui/tree/INFO.yaml
https://git.onap.org/policy/drools-pdp/tree/INFO.yaml
https://git.onap.org/policy/drools-applications/tree/INFO.yaml
https://git.onap.org/policy/docker/tree/INFO.yaml
https://git.onap.org/policy/distribution/tree/INFO.yaml
https://git.onap.org/policy/common/tree/INFO.yaml
https://git.onap.org/policy/clamp/tree/INFO.yaml
https://git.onap.org/policy/api/tree/INFO.yaml
https://git.onap.org/policy/apex-pdp/tree/INFO.yaml
Release Milestone
The milestones are defined at the Release Level and all the supporting projects agreed to comply with these dates.
Team Internal Milestone
It is not expected to have a detailed project plan.
Documentation, Training
Minor updates are expected as documented in the Istanbul Documentation
Other Information
Vendor Neutral
N/A
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.