Overview
Draft version to be updated further, work in progress...
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Amsterdam |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, Huawei, CMCC, Orange,Nokia, IBM,Gigaspaces, Ericsson, VMWare, ZTE, Amdocs |
Scope
What is this release trying to address?
The SO provides the highest level of service orchestration in the ONAP architecture.
Functionality for Release 1:
- Enhance ONAP SO run-time orchestration framework to support orchestration driven from declarative models (TOSCA encoded).
- Perform lifecycle operations based on a declarative TOSCA model, including:
- Deployment
- Undeployment
- Scale (Out, In) (Stretch goal)
- Heal (Stretch goal)
- Software Upgrade (various forms - Stretch goal)
Use Cases
Use Case: Residential Broadband vCPE (Approved).
Minimum Viable Product
- Enhance ONAP SO run-time orchestration framework to support orchestration driven from declarative models (TOSCA encoded).
- Perform lifecycle operations based on a TOSCA model, including:
- Deployment
- Undeployment
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.
| Functionality Name | In or Out | Priority | Stretch |
|---|---|---|---|
| Orchestration driven from declarative models | In | H | TOSCA encoded |
| Perform life cycle operations based on a TOSCA model | In | H |
|
Epics
Stories
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
- Support more life cycle management operations
- Support distributed component Deployment
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| Source Code | Source Code of Service Orchestration |
| API List | The Specification of the Service Orchestration APIs. |
| Docker Image | Docker Image(executable) of Service Orchestration |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
SDC (true dependency with SDC SDK)
AAI (using API interface)
SDN-C (using API interface)
APP-C (no existing interface yet)
DMaaP (included as part of SDC SDK)
- MSB (no existing interface yet)
VF-C (no existing interface yet)
- Multi-VIM(no existing interface yet - Need to check for direct dependency)
- Logging Enhancements Project (Not a major dependency)
Architecture
High level architecture diagram
Proposal 1
Proposal 2
Current seed code architecture, we will try to keep this intact based on he support from other components
/
SO High level architecture.
API Incoming Dependencies
List the API this release is expecting from other releases.
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) |
|---|---|---|---|---|
| SDC | APIs for distribute service models | |||
| A&AI | APIs for inventory data | |||
| SDN-C | APIs for network controller | |||
| APP-C | APIs for application controller | |||
| VF-C | APIs for Network Service | |||
| Multi-VIM | APIs for Multi-VIM |
API Outgoing Dependencies
API this release is delivering to other releases.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Create service instance | Create a service instance | |||
| Delete service instance | Delete a service instance | |||
| Create vnf instance | Create vnf instance | |||
| Delete vnf instance | Delete vnf instance | |||
| Create vf module instance | Create vf module instance | |||
| Delete vf module instance | Delete vf module instance | |||
| Create volume group instance | Create volume group instance | |||
| Delete volume group instance | Delete volume group instance | |||
| Create network instance | Create network instance | |||
| Delete network instance | Delete network instance | |||
| Get orchestration requests | Get orchestration requests | |||
| Get a specific orchestration request | Get a specific orchestration request | |||
| Create E2E service | Create E2E service | |||
| Delete E2E service | Delete E2E service | |||
| Query progress status | Query progress status |
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 |
|---|---|---|
| Camunda | An open source platform for workflow and business process management | |
ARIA | Tosca parser and TOSCA workflow engine | |
JBOSS | An open source application server program | |
MariaDB | One of the most popular open source database server |
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.
Unit tests are run automatically as part of every code merge.
CSIT will be covered when it is launched by integration team.
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
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 |
|---|---|---|
| conclusion on decision on VFC vs APPC under discussion in arch. committee | Requested for a quicker closure of the issue by extending the discussion time (if required). | Going ahead with the sprint planning with the assumption of supporting both flows |
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.