| Table of Contents | ||
|---|---|---|
|
Overview
...
What is this release trying to address?
Support Honolulu use cases, Features and Non Functional requirementsIstanbul Features, Specs and Global Requirements.
Requirements
Use Cases:
N/A
...
N/A
Minimum Viable Product
SDC:
deliver all the docker images needed to support sdc functionality and the needed scripts for setting up the DB and deploying it in OOM.
WORKFLOW:
deliver all the docker images 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.
...
| Deliverable Name | Deliverable Description |
|---|---|
| SDC Docker Images | Docker images for running SDC |
| SDC Tosca | Tosca library |
| SDC Distribution Client | Library for other apps to use for SDC distribution handling |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
...
- Jtosca
- SDC Tosca
- SDC Distribution Client
- SDC base docker
- SDC workflow designer
Architecture
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Indicate where your project fit within the ONAP Architecture diagram.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.
Platform Maturity
Please fill out the centralized wiki page: Frankfurt See Istanbul 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 Outgoing Dependencies
API this project is delivering to other projects.
...
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, ...).
...
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.
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.
...
No new incoming API dependencies.
API Outgoing Dependencies
No new outgoing API dependencies.
Third Party Products Dependencies
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 | |
Testing and Integration Plans
Unit tests to be added for all new functionality
CSIT tests to be added for new functionality
Gaps
| Gaps identified | Impact | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Cannot handle csars larger than ~ 8MB |
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 SDC JIRA
Risks
See Istanbul 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.
...
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
- ...
...
| title | Note |
|---|
...
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
See ONAP Istanbul Release Milestones which SDC complies with.
Team Internal Milestone
N/A
Documentation, Training
See the following centralized wiki: Istanbul Documentation
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary 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 See SDC Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.