DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
| Table of Contents | ||
|---|---|---|
|
...
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | R1 Amsterdam |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, Intel, Huawei, ZTE, Ericsson, IBM, BOCO, China Mobile, Orange,Reliance JIO |
Scope
What is this release trying to address?
The scope of this release will be for the Policy Framework to support the approved use cases for R1 Amsterdam.
Additionally, this release will also support continued development of the Policy Framework Platform to support future functionality not required for R1 Amsterdam. This body of work will be of a lower priority to the work required to support the Use Cases for the Release.Describe the problem being solved by this release
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
Use Case: Residential Broadband vCPE (Approved)
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.
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery status != Closed AND status != Done AND project ! = "Sandbox Project" AND project = POLICY and Type = EPIC and fixVersion = 'Amsterdam Release' ORDER BY priority DESC, updated DESC serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=Policy and issuetype in (story) and fixVersion = 'Amsterdam Release' serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Longer term roadmap
...
- Fuller integration SDC during the design-time - this is not complete right now.
- Capturing policy during VNF on-boarding
- Extending policy during Service Design
- Integration with SO, SDNC, APP-C and VF-C during runtime instantiation, scaling, etc.
- These components should integrate with policy to enforce policy during runtime
- There are platform and overarching policies being created by operators of the platform that should be enforced.
- These components should not rely solely on the service specific policies declared during design time.
- ONAP Platform integration - the policy platform can be used for fine-grained authorization by the rest of the components such as AAF, MSB, OOM
- Fine-grained user management and platform component authorization (i.e. time of day, location, etc.)
- 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
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description | To fill out | To fill out|
|---|---|---|---|
| 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. | ||
| VNF orchestration | *TBD the deliverables that are viable this release. |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
List the other ONAP projects your depends on.
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.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Portal - Our dashboard is compiled with the Portal SDK and is accessed as a "tab" in the Portal web application. Any changes to this sdk may require re-compilation on our end.
DCAE - We require that DCAE on-board their collectors, analytics, and micro services via the DCAE Design Tool that is currently supported by SDC.
CLAMP - CLAMP calls the Policy API to do create 2 types of policies for Control Loops:
- Create/update DCAE collector, analytic and micro service configuration Policies.
- Create/update the Operational Policy using the Policy YAML SDK
In addition, we would like to deprecate a CLAMP requirement of calling the API to deploy policy when SDC distributes a service. In lieu of our platform fully support SDC distribution. (See SDC dependency). (Stretch)
APPC - We are dependent on APPC to extend their Lifecycle API to expose API that implement auto healing/auto scaling for the use cases. The current API is Dmaap-based.
VF-C - We are dependent on VF-C for control loop auto healing/auto scaling. This may require help to develop code supported by a Use Case Policy Template to interact with their API for auto healing.
A&AI - We are dependent on A&AI to work with us on the ability of the Drools Application code/templates to be able to look up Service/VNF/VM topology during execution of a Control Loop Policy.
DMAAP - We are dependent on Dmaap for pub/sub infrastructure for Control Loop messages between the other ONAP components involved in Control Loop.
AAF - We are dependent on AAF for client libraries to support authentication of Dmaap Topics and ability to establish who can pub/sub topics for Control Loop.
SDC - We are dependent on being able to integrate with the SDC Distribution API in order to receive notification of service distribution. (Stretch)
Architecture
High level architecture diagram
Seed Code Architecture
Policy Seed Code Software ArchitectureAnyone reading this section should have a good understanding of all the interacting modules.
API Incoming 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|
|---|---|---|---|---|---|---|---|---|---|
| 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. | We are dependent on that team to provide us this. | |||||||
| APP-C | Dmaap message LCM API for auto healing/auto scaling/Restart/Reboot/ModifyConfig | We are dependent on that team to provide us this. | |||||||
| VF-C | API for auto scaling/auto healing | 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 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 Client API | This API is used by other ONAP components to create, update and delete policy(s). | TBD | N/A | |||||
| Policy Query API | This API is used by other ONAP components responsible for enforcing policy during runtime. | TBD | N/A |
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|
|---|---|---|---|---|---|
| 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.
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Risk identified | Mitigation Plan | Contingency Plan | |||
|---|---|---|---|---|---|
| Use Case clarity for control loop | At a minimum, we can deliver auto-healing control loop with dependencies on the API's to A&AI, APP-C, SO and VF-C. | auto-scaling can be pushed to the next release | To fill out | To fill out | To fill out |
Resources
Fill out and provide a link toward 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.
...
Each project must edit its table within the [[Free_and_Open_Source_Software#Project_Licenses| Master Project License Table]].
Board policy (including IPR)
Indicate if the release meets the Board policy.
...
available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.