Overview
Project Name | VID |
---|---|
Target Release Name | Dublin |
Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company | AT&T, Nokia |
Scope
What is this release trying to address?
- Adopt the ONAP format of ID when referring to a cloud region
- Initiate workflows designed in SDC
- S3P improvements (stretch goal)
Use Cases
Will take part in following use-cases:
Consistent ID of a Cloud Region (Dublin)
- Display cloud-owner of each cloud region
- Provide cloud-owner in requests to SO
Change Management Dublin Extensions
- Utilize SO as a repository of workflows, instead of VID's workflows' configuration
Minimum Viable Product
- Instantiation of services, vnfs and vf modules
- Change management and workflows support
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
- "One-click" service design and instantiation
- Dashboarding scheduled and ongoing change management
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|---|
VID application | Executable, Docker |
MariaDB | SQL database scheme |
Release documentation and API description | ReadTheDocs, ONAP WIKI pages |
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.
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.
VID fit within the ONAP Archiecture diagram in the runtime block, highlighted below:
Block diagram showing relation with external components.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
TBD
Platform Maturity
Referring to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
---|---|---|---|---|
Performance | 0 | 0 |
| |
Stability | 2 | 2 |
| |
Resiliency | 2 | 2 |
| |
Security | 1 | 1 |
| |
Scalability | 1 | 1 |
| |
Manageability | 1 | 1 |
| |
Usability | 1 | 1 |
|
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) |
---|---|---|---|---|
SO | ||||
Workflows | Obtain the list of all available and certified Workflows (SO Native and User Designed) for the user selected vNF Type and the Meta Data for the Selected for Workflow | TBD | TBD | TBD |
Instantiation | Enhancement: Instantiation API to be more flexible to consume workflow parameters | |||
Manual Task | Get available manual tasks by request | Ready | ||
A&AI | ||||
cloud-regions | Get cloud-owner by cloud-region ID /cloud-infrastructure/cloud-regions?cloud-region-id={id} | Ready |
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) |
---|---|---|---|---|
NA | NA | NA | NA | NA |
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 |
---|---|---|
MariaDB | SQL DB | 10.1.11 |
Docker | Docker container host | Latest |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
- Unit tests are run automatically as part of every code merge.
- Once the final container is built, it will be deployed and checked to ensure no errors occur during start-up.
- It is planned to add black-box testing of container functionality. (stretch goal)
- Functional testing will occur to ensure that the use cases are functioning correctly.
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 |
---|---|---|
To fill out | To fill out | To fill out |
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 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
- 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.