Modeling Istanbul Release Planning
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Istanbul |
Project Lifecycle State | Mature |
Participating Company | China Mobile, ZTE, Huawei |
Scope
What is this release trying to address?
etsicatalog project:
Support upload Container Images to CIR( stretched goal, depending on the requirement )
Support Global Requirements MODELING-523: support Global RequirementsClosed
Modelspec for modleing subcommittee:
Create UML models for new model proposals or enhancements in Istanbul release
Document approved models as model specs
Requirements
Describe the use case this release is targeted for (better if reference to customer requirements).
Modeling/etsicatalog will contribute to the following functional requirements:
Functional requirements:
R9 ETSI-Alignment Use Case (this Use case has been moved to Jakarta)
modelspec will address the following modeling requirements:
Minimum Viable Product
Describe the MVP for this release.
1) ETSI Interface alignment(SOL005 and SOL003) API implement
2) Modelspec from modeling subcommittee
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
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
Deliverable Name | Deliverable Description |
---|---|
Source Code | Source code for etsicatalog |
Maven Artifacts | Maven Artifacts for etsicatalog |
Docker Containers | Docker container associated with etsicatalog |
Documentation | Modeling detailed documentation |
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.
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: 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 Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|---|---|---|---|
SDCE-6 | SDC Interface for ONAP components subscribe to service notification from DMaaP | |||
SDCE-7 | SDC Interface for ONAP components retrieve service models from the Design Catalog | |||
DMaaP-3 | DMaaP Message Router Consuming Interface to provide a message receiving service to the DMaaP user | |||
MSBE-1 | Micro Service Bus Interface for registration and discovery with the ONAP Micro Service Bus |
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) |
---|---|---|---|---|
etsicatalogAPIE-1 | Catalog API | |||
etsicatalogAPIE-2 | NSD Package Management API | |||
etsicatalogAPIE-3 | VNF Package Management API | |||
etsicatalogAPIE-4 | Parser API |
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 |
---|---|---|
Django | 2.1.10 | |
djangorestframework | 3.10.3 |
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.
For Unit Test, Modeling/esticatalog is required to maintain 55% codecoverage at the minumum.
https://sonarcloud.io/organizations/onap/projects?search=modeling-etsicatalog
Functional test plan:
Modeling/etsicatalog Istanbul Functional Test Cases
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
N/A
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 - Istanbul 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:modeling
RELEASE MILESTONE
The milestones are defined at the Release Planning: Istanbul 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: Istanbul 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
...
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.