The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info | ||
---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
Table of Contents | ||
---|---|---|
|
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Guilin |
Project Lifecycle State | Incubation |
Participating Company (in alphabetical order) | AT&T, Fujitsu, Huawei, Orange, Wipro |
Scope
What is this release trying to address?
Committed:
Functional Requirements
- MDONS use case
- Extend the exisiting route optimization in OOF to support the MDONS use case.
- 5G Network Slicing
- Support 5G slice instantiation workflows, by providing selection decisions (5G - Network Slicing)
- SON Optimization Resources from WIPRO
- Evolve the PCI optimizer to use ML/AI techniques
- CCVPN Transport Slicing (yet to finalize)
Non - Functional Requirements:
- Containers must have no more than one main process (REQ-365)
- ONAP projects must use only approved and verified base images for their containers (REQ-379)
Stretch goals
- Non Functional requirements
- Python 3.6 to 3.8 migration
- Improve documentation. Document as you code. New features must have mandatory documentation along with code.
CII Silver badge; internal communication encrypted
- Move Helm Chart (OOM) at project level
- Unit test coverage beyond 55%
- Improve OOM deployment time for OOF helm charts.
Use Cases
- Approved New use cases:
- MDONS - Route optimization
- CCVPN - Transport Slicing
- Hardening/Test Only
- HPA - Hardening, Testing and Automation of vFW, vDNS, vCPE, VoLTE
- Traffic Distribution
- Extensions of existing use cases
- 5G Network Slicing
- 5G OOF-SON (low priority)
- Change Management Frankfurt Extensions (low priority)
- Fine-Grained Placement Service (low priority)
Minimum Viable Product
- OOF-HAS - Homing/Placement Service
OOF-OSDF - Optimization Design framework
- OOF-CMSO - Change Management Schedule Optimizer
- OOF-FGPS - Fine grained placement service
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
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = OPTFRA AND fixVersion = "Frankfurt Release" AND issuetype in (epic) ORDER BY priority DESC, updated DESC serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = OPTFRA AND fixVersion = "Frankfurt Release" AND issuetype in (Story) ORDER BY priority DESC, updated DESC serverId 425b2b0a-557c-3c0c-b515-579789cceedb
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. OOF also supports many critical 5G Services' needs including SON optimizations and Network Slicing Optimizations.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) 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 |
OOF-CMSO | Executable, and source code for the Change Management Schedule Optimizer |
OOF-FGPS | Executable, and source code for the Fine Grained Placement Service |
Sub-Components
- Homing and Allocation Service (HAS)
- Optimization Service Design Framework
- Change Management Scheduling Optimizer (CMSO)
- Fine-Grained Placement Service
Architecture
High level architecture diagram
Platform Maturity
Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
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. | El Alto | TBD | 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. | El Alto Release | Completed | ||
MultiCloud | API to retrieve VIM capacities (infrastructure metrics model) | El Alto Release | https://onap.readthedocs.io/en/latest/submodules/multicloud/framework.git/docs/specs/multicloud_resource_capacity_check.html | Completed | |
Music | Music client REST API | El Alto Release | https://docs.onap.org/en/latest/submodules/music/distributed-kv-store.git/docs/offeredapis.html | Completed | |
SDNC (R) | Config DB interface | El Alto Release | https://github.com/onap-oof-pci-poc/sdnc/blob/master/ConfigDB/swagger-json/swagger.json | Completed | |
DCAE | For 5G Network slicing use case | Frankfurt Release | TBD | In progress |
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 (SO,VFC) | El Alto Release | oof-has-api.json | Completed | |
Extensions to HAS API to support slicing workflows | Frankfurt Release | Frankfurt Release | In progress | In progress | |
SON API | API to perform SON optimization | El Alto Release | PCI Optimization API | Completed | |
Route API | API to perform Route optimization (used by CCVPN use case) | El Alto Release | oof-osdf-has-api.json | Completed | |
CMSO API | API invoked by CM use case for schedule optimization | El Alto Release | oof-cmso-api.json | Completed |
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 |
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: Maintain 55% 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 |
---|---|
To fill out | To fill out |
Known Defects and Issues
Please refer to Frankfurt Defect Status
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).
Please update any risk on the centralized wiki page - Frankfurt Risks
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
Please update the following centralized wiki: Frankfurt Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- 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.