OOF Kohn Release Planning
- 1 Overview
- 2 Scope
- 2.1 What is this release trying to address?
- 2.1.1 Committed:
- 2.1.1.1 Functional Requirements
- 2.1.1.2 Non - Functional Requirements:
- 2.1.1 Committed:
- 2.2 Use Cases
- 2.3 Minimum Viable Product
- 2.4 Functionalities
- 2.5 Longer term roadmap
- 2.1 What is this release trying to address?
- 3 Release Deliverables
- 4 Sub-Components
- 5 Architecture
- 6 Testing and Integration Plans
- 7 Gaps
- 8 Known Defects and Issues
- 9 Risks
- 10 Resources
- 11 Release Milestone
- 12 Team Internal Milestone
- 13 Documentation, Training
- 13.1 Note
- 14 Other Information
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Kohn |
Project Lifecycle State | Mature |
Participating Company (in alphabetical order) | Wipro, STL |
Scope
What is this release trying to address?
Committed:
Functional Requirements
OOF - SABRES POC REQ-1166: integrate SABRES concept into ONAPDone
Enhancements in NSI, NSSI Selection
Non - Functional Requirements:
Resources from Wipro, STL
CII Silver badge
Improve documentation. Document as you code. New features must have mandatory documentation along with code(OPTFRA-944: Documentation improvements for OOFOpen).
Use Cases
Extensions of existing use cases
5G E2E Network Slicing
5G OOF-SON
Minimum Viable Product
OOF-HAS - Homing/Placement Service
OOF-OSDF - Optimization Design framework
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. 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 |
Sub-Components
Architecture
High level architecture diagram
Platform Maturity
Please fill out the centralized wiki page: Jakarta 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.
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 | Completed | ||
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 | 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 | DCAE api for KPI retrieval | Jakarta Release | NSI/NSSI Selection based on resource occupancy levels - DCAE changes | 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 | Completed | ||
Extensions to APIs to support network slicing workflows (NST, NSI and NSSI selection) | Guilin Release | Completed | Completed | ||
SON API | API to perform SON optimization | Frankfurt Release | Completed | ||
Route API | API to perform Route optimization (used by CCVPN use case) | Frankfurt Release | Completed | ||
API enhancements for Route Selection for MDONS use case | Guilin Release | 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 |
---|---|---|
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 the latest release notes for the defects and issues.
Risks
Please update any risk on the centralized wiki page - Kohn Risks.
Resources
Please see the INFO.yaml files associated with each repo as the authoritative sources of information. https://gerrit.onap.org/r/admin/repos/q/filter:optf
Release Milestone
The milestones are defined at the Release Planning: Kohn and all the supporting projects 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 recommended 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: .
That includes
Team contributions to the specific document related to the project (Config guide, installation guide...).
Team contributions to the overall Release Documentation and training asset
A 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.