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?

Committed: 

Functional Requirements

• F-GPS - Main purpose of F-GPS (a.k.a. ONAP-Valet) is, with considering new placement policies,  to precisely check capacity & capability of target Cloud Region and then, to determine VNF placements (i.e., target zone for each workload (VDU) of VNF). Resources from IBM
  Goals
  • Capacity & Capability checking for an OpenStack cloud: 
  • Checking the number of zones of the target Cloud Region to solve the Anti-affinity rules.
    • Checking available capacity of each zone to solve Affinity rule.
    • Checking available host profiles of each zone to solve flavor matching (i.e., Host-Aggregates) (Stretch Goal).
  • Placement decisions for Affinity and Anti-Affinity among zones of target Cloud Region. Optionally, decisions go into compute hosts (for private cloud case).
  Stretch Goals
  • Defining Affinity and Anti-affinity rules in Policy. Until this is ready, evaluate with a manual/hard-coded policy.
  • Specifying Affinity and Anti-affinity rules in homing/placement request. Until this is ready, evaluate with a manual/hard-coded specification.
  • Distributed cloud modelling immediately relevant to F-GPS - a single cloud control plane (Cloud Region) to be able manage several distributed DC locations/zones. 

  • Leverage capacity alerts (significant change in capacity) from Model-driven Distributed Analytics work.

• Policy Tosca model API and ONAP CLI integration Resources from Intel
  Goal 
  
  • Develop APIs in Policy for uploading policy tosca models for OOF.
  • Develop CLI for creating the policies including templates using ONAP CLI project. This will be extremely valuable in automating policy creation, one of the major pain points in Casablanca integration tests.
• CMSO 
  
  • Traffic Migration Workflow Resources from Orange
  • Schedule Optimization with Automated Conflict Avoidance (Stretch goal based one resource availability)
    
• OOF PCI Optimization Resources from WIPRO, AT&T
  • OOF PCI Solver and interface shall support at least two optimization objectives (e.g. minimize changes, minimize PCI confusion)
  • OOF PCI Solver policy shall use a PCI range specified in the configuration policy
  • OOF shall provide a joint PCI/ANR solver which will optimize PCI and also recommend a removal of a neighbor relation if there PCI allocation is difficult for a cell which also has a neighbor link for which the successful_handover KPI is below a pre-specified threshold

Stretch goals

• Slice creation and orchestration
• Consistent ID of a Cloud Region
  
• Non Functional requirements
  
  • Improve documentation. Document as you code. New features must have mandatory documentation along with code.
  • S3P: Footprint optimization

  • CII Silver badge; internal communication encrypted; role based access control and authorization for all calls

  • Move Helm Chart (OOM) at project level
  • CI/CD enhancement - Continuous Deployment (Comply with the requirements from Task force). Enhance existing CI jobs for Dublin.
  • Unit test coverage to 60% or 70%?
  • Improve OOM deployment time for OOF helm charts. 

Use Cases

• Fine-Grained Placement Service (F-GPS)

• HPA - Hardening, Testing and Automation of vFW, vDNS, vCPE, VoLTE
• CCVPN ? 
• Change Management Dublin Extensions
• Consistent ID of a Cloud Region (Dublin)

Minimum Viable Product

• 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 supports HAS, the Homing Optimizer

• OOF-CMSO - Change Management Schedule Optimizer

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

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 a growing set of core platform optimization services such as VNF placement and resource allocation (OOF-HAS), change management scheduling (OOF-CMSO), etc. 

Vision for OSDF:

OOF-OSDF is envisioned to be a collection of design time optimization libraries along with reusable runtime tools and microservices to facilitate and simplify the creation of new specific runtime optimization functionalities. The goal of OSDF is to avoid siloed optimization tools and associated duplicated efforts and overheads. For instance, the Homing Service, HAS (which was provided in the Beijing release) will not only contribute its reusable components to the framework, but also leverages the framework in its own feature development. Other potential optimization services that can be built using this framework include energy optimization in networks, optimal route selection for various network services, and radio access network (RAN) performance optimization. 

Vision for HAS:

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 initial  deliverable of HAS 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 helps create new types of policy- and model-driven optimizers.
• OOF-CMSO - Change Management Schedule Optimizer

Architecture

High level architecture diagram

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.

• 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

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

• 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 project table available at Project FOSS.

Charter Compliance

The project team comply with the ONAP Charter.