OOF Casablanca M1 Release Planning Template
DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Casablanca |
Project Lifecycle State | Incubation |
Participating Company | AT&T, Huawei, Intel, OAM Technologies, VMWare |
Scope
What is this release trying to address?
Committed:
- Harden the OOF development platform (Highest priority)
- Deployment scripts, CSIT, CI for different streams, Nexus image cleanup
- Using Music as a service
- Maintaining current S3P levels of the project as new functional requirements are supported (Highest priority)
- Security enhancements progressing towards Silver badge
- All internal communication encrypted (Frank Sandoval)
- AAF integration - role-based access control and authorization for all calls (depending on Python support from AAF) (Frank Sandoval)
- Code coverage: achieve 60% target code coverage
- Performance: Creating a plan for performance improvements
- Manageability:
- Adherence to log specification v1.2 - ONAP Application Logging Specification v1.2 (Casablanca)
- Externalized config management
- Usability
- Adherence to ONAP API Common Versioning Strategy (CVS) Guidelines
- move all internal and external facing APIs to Swagger 2.0 (Frank Sandoval)
- Documentation (Frank Sandoval)
- Security enhancements progressing towards Silver badge
Functional Requirements:
- HPA enhancements (resources from Intel)
- Service Assurance - streaming telemetry about health of platform (CPU pinning, and NUMA) - primarily from OpenStack
- Homing enhancements improving the deployability of Services Using ONAP platform
- Homing multiple simultaneous instances of the service: queueing homing requests based on discovering dependency on shareable resources (resources from AT&T)
- Considering Latency Reduction (in addition to geographical distances) for homing optimization (resources from AT&T)
- Policy-based enhancements to capacity checks - requirements coming in from Edge Automation (resources from VMWare)
- 5G SON Optimization (resources from Wipro, TechM, AT&T, Reliance Jio)
- PCI optimization POC using OSDF
- Health Checks, CSIT, Dockerization, K8S HELM Chart, S3P with 60% code coverage
- Change Management (resources from AT&T)
- VNF/PNF support - scheduler for Change Management.
- Targeting support for 5G use case.
- CCVPN (resources from Huawei)
Stretch goals:
- Homing 5G RAN VNFs
- Extending the Homing feature developed in R2 for 5G RAN VNFs
- Auto Scale Out Functional requirement
- OOF POC with Service Mesh (ITSIO)
- Aligned with the MultiCloud efforts on the sam item.
- Homing enhancements
- Resource reservation
- Edge Automation through ONAP (resources from VMWare) – Edge Scoping MVP for Casablanca - ONAP Enhancements#ONAPEnhancements-DistributedEdgeCloudInfrastructureObjectHierarchy(StretchGoal)
Use Cases
- vCPE (supporting R2 homing workflows)
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
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 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.
Deliverable Name | Deliverable Description |
---|---|
OOF-HAS | Executable, and source code for the Homing Service for the ONAP platform |
OOF-OSDF | Executable and source code that provides optimization design framework support to optimizers like HAS |
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.
Architecture
High level architecture diagram
Sequence Diagram showing OOF interaction with other ONAP components during the Homing workflow:
ONAP Dependencies
The following are the dependencies for the project based on the scope for the Casablanca Release. The required dependencies have been identified based on the homing workflow requirements of Casablanca release.
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 | 1 | 1
|
| |
Stability | 1 | 1 | NA |
|
Resiliency | 2 | 2 | NA |
|
Security | 1 | 1 with some progress towards 2
|
| |
Scalability | 1 | 1 | NA |
|
Manageability | 1 | 1 with progress on adherence to Logging v1.2 spec |
| |
Usability | 1 | 1 | NA |
|
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) | Status |
---|---|---|---|---|---|
Policy | Policy Client API to create, update and retrieve homing policies. | Beijing Release | TBD | work in progress | |
AAI | REST Web Service provided by AAI, to query available cloud-regions, and existing service instances where a new order can be placed. | Beijing Release | TBD | work in progress | |
MultiCloud | API to retrieve VIM capacities (infrastructure metrics model) | Beijing Release | TBD | work in progress | |
Music | Music client REST API | Beijing Release | TBD |
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) | Status |
---|---|---|---|---|---|
HAS API | API to submit homing requests, and retrieve homing solutions. | Beijing Release | TBD |
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.
The following link shows the dependencies and their license information: Project FOSS dependencies for OOF.
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
The following testing will be planned for OOF in this release:
- Unit Tests and Code Coverage: Target level 60% code coverage
- Continuous System Integration Testing (CSIT): Enhance existing CSIT functional tests to cover new features
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 |
---|---|
Homing - Capacity checks and capability checks are treated independent of each other | Cannot guarantee capacity of a certain resource with a specific capability |
Support for resource reservation not available | Contention of resources can result in a homing recommendation not being realized during the actual spin up. |
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).
Risk identified | Mitigation Plan | Contingency Plan |
---|---|---|
Insufficient resources for delivering the functional features in the scope:
| Limit the functional features to use Beijing features for homing Prioritize the items in the scope into different priority levels and stretch goals |
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.