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 | Honolulu |
| Project Lifecycle State | Mature |
| Participating Company | AT&T, Ericsson, Bell Canada, Wipro |
Scope
What is this release trying to address?
Describe the problem being solved by this release
There are 3 main objectives in this release:
- CLAMP and Policy integration POC.
- Tosca defined Control Loop architecture.
- Release requirements (logging, python 3, package upgrades), technical debt, and enhancement items carried forward from Guilin.
Other optional capabilities as the ability to swap databases underneath, validation of Tosca Policies will be implemented as time and resources allow.
Requirements
Please see the release requirements planned as identified in Policy Honolulu-R8 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
Policy Framework Project - Architectural Roadmap for Honolulu
Release Deliverables
Deliverable Name | Deliverable Description |
|---|---|
| Policy Drools PDP | Executable - supports Tosca Policies execution in the Drools PDP |
| MariaDB | SQL database
|
| Nexus Repo | This optional component is a maven repository from which the Policy Drools PDP will load application jars. This component is disabled by default. |
| 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 (PoC) | PoC that integrates CLAMP functionality into Policy. |
Sub-Components
See the table above for the Policy subcomponents.
Architecture
High level architecture diagram
ARC Policy Framework Component Description - Honolulu-R8
https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html
Platform Maturity
Please see Honolulu Release Platform Maturity
API Incoming Dependencies
List the API this project is expecting from 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 |
| 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 | We are not expecting any upgrades for any of our requirements. gRPC | 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 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
Name | Description | Version |
|---|---|---|
| MariaDB | The MariaDB is the repository that holds all the policies, templates, PDP group, and deployment information. | 10.5.8 |
| Nexus | (Optional) The Nexus repository holds all the currently deployed Operational (i.e. Drools policies) and their dependent artifacts. | 2.14.13-01 |
| Alpine | Operating system | 3.12.0 |
| OpenJDK | OpenJDK for Alpine from integration images (integration/docker/onap-java11 repository) | openjdk11:jre-11.0.9.1_1-alpine |
Testing and Integration Plans
The testing and integration activities are described in the following page: Policy R8 Honolulu CSIT/External Lab Functional Test Cases.
Gaps
No gaps identified.
Known Defects and Issues
There is no major known defects and issues.
Risks
There is only one risk associated with package upgrades to interface with the CDS component as documented in the following page: Honolulu Risks.
Resources
Please refer to the Resources Committed to the Release centralized page and the INFO.yaml for each policy repo:
https://git.onap.org/policy/xacml-pdp/tree/INFO.yaml
https://git.onap.org/policy/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/engine/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 project 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: Honolulu 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.