Overview

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.

Use Cases

Describe the use case this release is targeted for (better if reference to customer use case).

Use Case: VoLTE(approved)

Use Case: vFW/vDNS (Approved)

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.

Epics

Stories

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.

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

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 Architecture

API Incoming Dependencies

List the API this release is expecting from other releases.
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 Outgoing Dependencies

API this release is delivering to other releases.

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, ...).

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.

Known Defects and Issues

Provide a link toward the list of all known project bugs.

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).

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.

Team Internal Milestone

This section may be used to document internal milestones that the team agreed on.

Also, 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, provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

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
  • ...

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 table 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.