The content of this template is expected to be fill out for M2 Milestone.
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Honolulu |
| Project Lifecycle State | Mature |
| Participating Company | Amdocs, AT&T, ZTE, Huawei, Intel, Nokia, Ericsson, Vodafone, IBM, TechM, Samsung, CMCC |
Scope
What is this release trying to address?
Support Honolulu use cases, Features and Non Functional requirements.
Requirements
see tables below for content related to this release
Minimum Viable Product
SDC:
deliver all the need dockers and DB needed to support sdc functionality and the needed scripts for deploying it in OOM.
WORKFLOW:
deliver all the need dockers needed to support workflow designer functionality and the needed scripts for deploying in OOM.
SDC SDK's:
sdc-destribution-client
sdc-tosca
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.
Requirements Epics for Honolulu, impacting SDC
No Use Case :
No use case impacting SDC planned for this Release
5 Functional Requirements :
| Requirement Epic | Status | SDC Epic(s) and/or SDC Story(ies) | Committed Contributors |
|---|---|---|---|
REQ-463 - Getting issue details... STATUS | Waiting presentation from involved parties and/or stories creation |
| SDC : Bell, Amdocs (S) Arch Review OK No story avail yet |
REQ-400 - Getting issue details... STATUS | ETSI Modeling update |
| SDC (S) - Ericsson Arch review To Do Stories Created and assigned |
REQ-458 - Getting issue details... STATUS | Continuation of CNF support, presented by Luckasz at SDC weekly |
| SDC (P): Nokia, Huawei Arch Review OK Stories Created and assigned |
REQ-446 - Getting issue details... STATUS | PNF SW update continuation |
| SDC (S): Ericsson stories created and assigned |
REQ-433 - Getting issue details... STATUS | Distribution improvements |
| (S) SDC - Nokia stories created and assigned |
Global Requirements/Best Practices :
10 - TSC MUST HAVE (please indicate where you plan to contribute)
| Requirement Epic | TSC Status | SDC Epic(s) and/or SDC Story(ies) | Committed Contributors |
|---|---|---|---|
REQ-443 - Getting issue details... STATUS | Best Practice for New code - approved by TSC |
|
|
REQ-439 - Getting issue details... STATUS | Best Practice for New code - approved by TSC |
|
|
REQ-438 - Getting issue details... STATUS | Global Requirement - all code must comply |
|
|
REQ-437 - Getting issue details... STATUS | Global Requirement - all code must comply |
|
|
REQ-442 - Getting issue details... STATUS | Best Practice for New code - approved by TSC |
| No impact on SDC but OOM charts must be compliant Will follow OOM team guidelines and rules |
POC - Proof of Concept
REQ-478 - Getting issue details... STATUS | POC - waiting stories/info to be provided |
|
|
SDC Backlog Overview - Not committed for the release (except for stories that have been captured in the above table), best effort
Longer term roadmap
SDC aims to position itself as the main design IDE in ONAP. SDC works towards creating a fully model-driven design experience.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| SDC Docker Images | Containers running SDC |
| SDC TOSCA | Tosca library |
| SDC distribution client | Distribution client runtime for other apps to use |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
- Jtosca
- SDC Tosca
- SDC Distribution Client
- SDC base docker
- SDC workflow designer
Architecture
High level architecture diagram
Platform Maturity
Please fill out the centralized wiki page: Honolulu 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) |
|---|---|---|---|---|
| Portal | user management APIs | api for user management | delivered | exposed by portal sdk |
| Distribution client | apis for retriving artifacts from catalog | download artifacts | delivered | exposed by sdc part of external apis. |
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) |
|---|---|---|---|---|
| dmaap | using Cambria client | api for pushing and retrieving notifications | delivered | sdk |
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 |
|---|---|---|
| Cassandra | Open-source distributed storage system | 3.1 |
| Docker | VM container | 18 and above |
| JanusGraph | Open-source, distributed graph database | 0.3.1 |
| Jetty | Open-source application server | |
| Ubuntu | Open-source software operating system | 20.0.4-LTS |
| vnc | vnc server used for ui testing | |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Base docker images with approved set of License to be used to construct SDC base images.
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.
- validate uses cases and pairwise testing of SDC with other components
- enhance CSIT to include more tests (now integrated in SDC main build)
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 SDC Release notes when available
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 - Honolulu Risks – To be updated when avail
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:sdc
Release Milestone
The milestones are defined at the Release Planning: Honolulu 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: Honolulu Documentation – To be updated when avail
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.