DRAFT PROPOSAL FOR COMMENTS

The content of this template is expected to be fill out for M1 Release Planning Milestone.

...

Overview

Scope

What is this release trying to address?

...

The Beijing release is the first release of

...

the OOF project and has the following key objectives in this release:

1. Support ONAP use cases for Homing/Placement of VNFs and Services

...

Use Cases

• Targeted goal in R2:
  • Use Case: Residential Broadband vCPE (Approved)
  • Hardware Platform Enablement In ONAP
• Stretch goal in R2:
  • Use Case: VoLTE(approved)
  • Use Case Proposal: Scale Out

While homing is critical to almost all use cases, we primarily focus on the Residential vCPE use case for the Beijing release. For these use cases, homing would be required during the Generic Service Instantiation Flow (Generic Service.png), where the SO would call HAS for homing right after the service decomposition block. More details on the homing requirements for the vCPE use case, including the API interactions can be found here: vCPE Homing Use Case.

...

1. via the Homing and Allocation Service (HAS).
2. Demonstrate the declarative, model-driven functionality of OSDF via representative applications aligned with ONAP use cases

3. Provide a library of OSDF components/adapters for building new optimization applications

4. Ensure compliance of OOF with platform maturity requirements. 

Additionally, the following stretch goals are also being pursued:

1. Provide foundations of components required to support broader use cases that are targeted for R2+
2. Exploratory efforts that are in the scope of near-term and longer-term OOF objectives

Detailed Scope Description 

ONAP Optimization Framework (OOF) provides the ability to create and run a policy-driven optimization application in a declarative, model-driven matter via the Optimization Service Design Framework (OSDF). The OSDF builds upon seed code from AT&T by bringing in new optimization technologies identified via collaborative efforts to provide a declarative, model-driven optimization framework. The OSDF also supports integration with custom coded optimization applications. This release includes the Homing and Allocation Service (HAS), which again builds upon seed code from AT&T, and addresses a core ONAP requirement, Homing/Placement of VNFs and Services (VNF Homing Capability).

Additional details for the initial objectives are as follows:

1. Support minimum viable ONAP use cases for Homing/Placement of VNFs and Services via the Homing and Allocation Service
   Specific homing/placement use cases identified for this release are:
   1. Residential Broadband vCPE use case
   2. Hardware Platform Enablement (HPA) in ONAP
   3. VNF scale out use case
2. Demonstrate the declarative, model-driven functionality of OSDF via representative applications aligned with ONAP use cases
   This will be done through a simple example mimicking Change Management Scheduling Optimization use case (this effort is aligned with the requirements of the broader CMSO use case). Additional examples are also being pursued, but are slated as stretch goals. The example will also demonstrate the ability to inject new types of constraints at run-time via policy (thus, in many cases, be able to inject advanced functionality into the optimization application without changing the model or configuration).
3. Provide a library of OSDF components/adapters for building new optimization applications
   Beyond the adapters for Policy, AAI, MultiCloud, and SDC, additional focus will be on the incorporation of runtime metrics from MultiCloud for adaptive workload optimization
4. Ensure compliance with platform maturity requirements
   This will be done by meeting or exceeding minimum requirements for projects in Beijing release.

The following items constitute “stretch goals” and “foundations towards real goals”

1. Provide foundational components required to support broader use cases targeted for R2+
   The objective is build “foundations" of components that will be developed and be ready for integration with applications supporting broader use cases such as:
   1. VoLTE use case
   2. 5G family of use cases
   3. Broader CMSO use case
2. Pursue exploratory efforts that are in the scope of near-term and longer-term OOF objectives
   We have identified some general features that we believe will be required in the near-term to longer term (timeframe or two or three releases in the future). However, the core OOF group will be focusing on the ONAP release deliverables and will not be able to spend substantial development effort on these items. Fortunately, these appear to align well with recent advances pursued by the broader optimization community. So, initially, we will pursue these via engaging the broader optimization community to contribute ideas and models. Specific features of interest currently are: 
   1. General algorithms for addressing uncertain data
   2. Robust scheduling under uncertainty
   3. Optimization of resource allocation when only approximate/averaged metrics are available

Use Cases

• Targeted goal in R2:
  • Use Case: Residential Broadband vCPE (approved)
  • Hardware Platform Enablement In ONAP
  • Use Case: VNF scale out (and potentially service scale out)
• Stretch goal in R2:
  • Use Case: VoLTE (approved)
  • 5G family of use cases
  • Broader CMSO use case

Minimum Viable Product

• OOF-HAS - Homing Service (runtime) that can be provides optimized placement based on policy constraints, across multiple clouds and multiple sites. 
• OOF-OSDF - Optimization Design framework (runtime) that supports HAS, the Homing Optimizer. 

• Application demonstrating a declarative, model-driven, and policy-driven basic CMSO functionality (this effort is aligned with broader CMSO use case)

• HPA functionality integration into OOF
• Integration with Multi Cloud (incorporation of runtime metrics)

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.

...

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

...

Tasks and Sub-Tasks 

Longer term roadmap

As the ONAP platform matures and new capabilities are introduced over time, the need for platform optimization services will grow along with it. The ONAP Optimization Framework is envisioned to handle this need as effectively as possible, by enabling creation of new optimization services with minimal or little new code development. The goal of OOF is to provide

...

OOF-HAS, or the Homing Service is a distributed resource broker that enables automated policy-driven optimized placement of services on a global heterogeneous platform using ONAP. HAS is architected as an extensible homing service that can accommodate a growing set of homing objectives, policy constraints, data sources and placement algorithms. It is service-agnostic by design and can easily onboard new services with minimal effort. HAS is designed to be used as a building block for both initial deployment, as well as runtime redeployment due to failures or runtime-capacity increase (scale-out). While the immediate deliverable of HAS in Beijing Release is to provide optimized homing/placement of services during the service instantiation workflows in ONAP,  HAS naturally extends to a general policy-driven optimizing placement platform for all platform placement functions, including placements of VMs, containers (e.g., for DCAE micro-services), ONAP Control Loops or VNF specific resources. HAS will also eventually allow placements of additional resource types such as licenses, VNF resources, etc.

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

Sub-Components

• OOF-HAS - Homing Service that can be provides optimized placement based on policy constraints, across multiple clouds and multiple sites. OOF-OSDF - Optimization Design framework that across multiple clouds and multiple sites. 
• OOF-OSDF - Optimization Design framework that helps create new types of policy- and model-driven applications. It also supports optimization modules that use custom code for solving the optimization problem. The OOF-OSDF also supports HAS, the Homing Optimizer

ONAP Dependencies

The following are the dependencies for the project based on the scope for the Beijing Release. The required dependencies have been identified based on the current homing requirements for the vCPE use case, and the potential dependencies are tentative dependencies that may exist based on how the information required for homing (e.g., Hardware Platform Enablement, VIM attributes) is available. 

Image Removed

The dependency graph in a wiki-editable format

Architecture

...

Architecture

OOF Alignment with ONAP Target Architecture (Projects view):

Source: original image from 2018-01-09 version of the ONAP Beijing Architecture slides from the Architecture Tiger Team Contributions section in the Architecture Tiger Team wiki page. 

OOF-HAS High level architecture diagram:

...

Image Added

Source: Slide from the presentation: FCAPS Telemetry - "Standardized Infrastructure Class statistics Model" (at the developer workshop: ONAP Project Developer Event: September 25 - 28, 2017, Saclay, France).

Sequence Diagram showing OOF interaction with other ONAP components during the Service Instantiation workflow of SO:

Platform Maturity

OOF is currently a non-MVP project, and is an incubation project in the Beijing release cycle (seed-code is upstreamed in this release). Therefore, some of the "Actual levels" for the platform maturity indicate a level 0, which is commensurate with the project's current incubation status. Our goal is to align with the Architecture committee's recommendation on using common tools/libraries for platform maturity, and therefore we will be dependent on the tools/libraries provided by these projects to achieve some of these targets. The Architecture Subcommittee's recommendations for the projects on achieving the platform maturity can be found here (ONAP Beijing Architecture Jan 9b.pptx). 

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 Outgoing Dependencies

API this project is delivering to other projects.

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

The following type of tests will be ensured for OOF in this release:

• Unit tests: Unit tests will be added incrementally as part of code delivery ensuring static code analysis as recommended by common SW delivery practices. OOF is written in Python, so coverage target percentage will be evaluated along project. Unit Tests will be automated, so that execution will happen before every OOF delivery. This includes writing test cases for the new components and those for the existing ones not yet covered under unit testing. A python based Unit Testing framework will be integrated into the project, binding all developers to start with Unit Tests when developing each module.
• CSIT Test cases: OOF will be integrated following Continuous System Integration Testing test cases practice. This will ensure both Sanity test cases execution and Functional Test execution (details are provided in further chapters here below). CSIT test cases will be executed integrating OOF with Robot Framework and Jenkins.
• Functional Test cases: OOF will be tested according to specific “concrete” optimization scenarios committed as “functional” part of OOF delivery. In particular vCPE optimization has been identified as concrete scenario, so a dedicated test suite will be set up to verify expectations are met. This will imply a proper set of simulators will be available to fulfill the whole vCPE optimization flow: Policy simulator, AAI simulator, SDNC Simulator, Music Simulator. for vCPE management. Functional test cases (or a meaningful subset) will be part of CSIT Test cases.  
• End to End Test cases: OOF will be integrated within the whole ONAP components architecture and dedicated set of E2E test cases will be setup. Purpose, scope and details on E2E testing will be planned/defined subsequently by working with the Integration team, and for the test cases in the scope of this release.  

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

...

The following link shows the dependencies and their license information: Project FOSS dependencies for OOF.

Testing and Integration Plans

The following testing will be ensured for OOF in this release:

• Unit Tests and Code Coverage: We will use Python testing frameworks (combination of unittest, nose and coverage.py modules). We will work with our collaborators from MultiCloud who have used a similar ecosystem for their project.
• Continuous System Integration Testing (CSIT): We will develop Robot Framework scripts for in Robot Framework.
• Functional Test cases: OOF will be tested according to a small but representative test cases covering specific “concrete” optimization scenarios. These test cases will be documented in detail. 
• End to End Test cases: We will adapt the Robot Framework scripts in consulation with the integration team.  

Gaps

This section is used to document a limitation on a functionality or platform support (i.e. limitations that we are currently aware, and required functionality will be delivered in a future Release). Since the project is in an incubation stage, we are focusing on bringing up the base functionality and then present information on limitations in a proper context. 

Known Defects and Issues

(Note: this is an incubation project with seed code being stabilized in ONAP; bug reports are on the way)

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

Since the project is in an incubation stage, we are focusing on bringing up the base functionality and then present information on risks in a proper context.

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.

...

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.

...