DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Policy Framework |
|---|---|
| Target Release Name | Beijing |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, Intel, Ericsson |
Scope
What is this release trying to address?
The Policy Framework will be addressing the following for the Beijing Release:
- Platform Maturity Guidelines (Highest Priority)
- 50% JUnit Test Coverage (Highest Priority)
- Integration with OOF to support Hardware Enabled Placement Policies (Medium Priority)
- Control Loop Enhancements for Scale Out (Lowest Priority)
- SDC Distribution Integration (Lowest Priority)
- Policy Lifecycle API (Lowest Priority)
Use Cases
VNF Scale Out (TBD - Not enough resources as of 1/8/2018)
Hardware Platform Enablement In ONAP
Minimum Viable Product
- Policy Portal Dashboard - Console GUI where Models, Templates can be imported, updated, deleted, as well as, policies can be created, updated and deleted. The console GUI also has a dashboard where PDP's can be grouped and where Operators can control where policies are distributed to.
- Policy PAP web application - Policy backend that manages communication with PDP engines for policy distribution.
- Policy Drools PDP - run-time execution of Control Loop operational policies. Supports queries from other ONAP components to retrieve
- Policy XACML PDP - run-time execution of Control Loop configuration policies of DCAE collectors, analytics and micro services.
- Policy BRMS Gateway - intermediary backend for distributing policies to the Drools PDP and configuration details to the Drools PDP controller.
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 Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = POLICY and Type = EPIC and fixVersion = 'Beijing Release' ORDER BY priority DESC, updated DESC serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = POLICY and Type = Story and fixVersion = 'Beijing Release' ORDER BY priority DESC, updated DESC serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
- Integration with SDC to support future Policy Design GUI integration into SDC
- We are waiting or SDC to produce their SDK for integration at the end of Beijing
- Policy Lifecycle API
- Distribution of PDPs across the network - in lieu of support future performance requirements
- PDP distribution needs to be enhanced to support multiple PDP's being located in edge, core, global datacenters.
- This should also support high availability and resiliency
- PDP's designed as Microservices and deployed via OOM
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| Policy Portal Dashboard | Executable |
| Policy PAP web application | Executable |
| API - internal to the Policy Platform. The Policy PDP engines use this API to synchronize policies being distributed. | |
| Policy Drools PDP | Executable |
| Policy XACML PDP | Executable |
| API - external to ONAP components. The API is used to CRUD Policies, Deploy Policies, and query for Policy Decisions. | |
| Policy BRMS Gateway | Executable |
| MariaDB | SQL database
|
| Nexus Repo | This repository is used by the Policy Drools PDP to retrieve distributed policies and their dependent jars. |
| Policy Lifecycle API | Description/Documentation |
Sub-Components
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.
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 Archiecture 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
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
| Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Performance | Level 1 | Level 1 |
|
| ||||||||||
| Stability | Level 1 | Level 1 |
|
| ||||||||||
| Resiliency | Level 1 | Level 2 |
|
| ||||||||||
| Security | Level 1 | Level 1 |
|
| ||||||||||
| Scalability | Level 1 | Level 1 |
|
| ||||||||||
| Manageability | Level 1 | Level 1 |
|
| ||||||||||
| Usability | Level 1 | Level 1 |
|
|
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) |
|---|---|---|---|---|
| AAI | REST Web Service for AAI | We are dependent on that team to provide us this. | ||
| Control Loop Event Messages | Dmaap messages published by DCAE when a Control Loop Event occurs. | Amsterdam | n/a | n/a |
| APP-C | Dmaap message LCM API for auto healing/auto scaling/Restart/Reboot/ModifyConfig | We are dependent on that team to provide us this. | ||
| SO | API for auto scaling | We are dependent on that team to provide us this. | ||
| DMAAP | API for publish/subscribe to DCAE Control Loop Events and APP-C API | We are dependent on that team to provide us this. |
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 Client API | This API is used by other ONAP components to create, update and delete policy(s). | Amsterdam version - no changes | Policy API | |
| Policy Query API | This API is used by other ONAP components responsible for enforcing policy during runtime. | Amsterdam version - no changes | Policy API |
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.0.31 ?? |
| Nexus | The Nexus repository holds all the currently deployed Operational (i.e. Drools policies) and their dependent artifacts. | 2.14.2-01 ?? |
| ElasticSearch | Used to search text within policy. | 5.4.0 ?? |
| Ubuntu | Operating system | 14.04 |
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
Provide a link toward the list of all known project bugs.
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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).
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| Resources | Actively seeking community support. | Current resources are only enough to satisfy the Highest Priority Epics (Platform Maturity, JUnit 50% test coverage) |
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
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the 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.