| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Honolulu Release |
| Project Lifecycle State | Incubation.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
| Participating Company | AT&T, CenturyLink, China Mobile, Huawei, Orange, Verizon, Amdocs, Ciena, Wipro, HCL, Tech Mahindra, Netcracker, MEF, TMF |
Scope
What is this release trying to address
- Support TSC must have ONAP requirements Honolulu Release Requirements
- implements as much TSC must feature as possible
Scope Priority Committer Lead Resources Committed Epic Dependencies TSC Must have high Adrian O'Sullivan, Priyadharshini B Rakesh Girija Ramesan Nair
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key EXTAPI-533 - Stretch Goal in association with E2E Network Slicing -
- EXT-API impacts for support of TMF 628 APIs for KPI monitoring andJira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key EXTAPI-450 Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-440 - Slides presented covering the NBI requirement for E2E External API Framework: 5GNetworkSlicing_ExtAPI_20200610_v1.0.pptx
- Specification & modelling work on (modernized) TMF 628 for "On Demand" PM collection and future mapping to DES API's
- Slides presented covering the NBI requirement for E2E External API Framework: 5GNetworkSlicing_ExtAPI_20200610_v1.0.pptx
Use Cases
The existing use cases should still be supported ( BBS, CCVPN ) in the Honolulu Release as the APIs are built to be non use case specific.
...
- Slides presented covering the NBI requirement for E2E External API Framework: 5GNetworkSlicing_ExtAPI_20200610_v1.0.pptx
- Specification aspects only of the mapping to be covered during Honolulu Release within Honolulu Release
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key EXTAPI-450
Platform Maturity
Platform Maturity (i.e., S3P items) Honolulu Release Platform Maturity
Minimum Viable Product
- Documentation of User Stories; Use Cases and Interactions (e.g., swagger ); Data Models (e.g., JSON); Interface Profiles and Functional Definition;
- ONAP Component Mapping and Functional Analysis;
- Code contribution for External API Framework functionality.
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.
...
7- TSC PRIORITY 3 PTL GO/NO GO (please indicate where you plan to contribute)
Epics
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = EXTAPI AND fixVersion = "Honolulu Release" AND type = Story serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term Roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
...
- Service Provider controls aspects of the Service within the Partner domain (on behalf of the Customer) by requesting changes to dynamic parameters as permitted by service policies.
- Service Provider queries state of the Service.
- Service Provider requests change to administrative state or permitted attributes of a Service.
- Service Provider request creation of connectivity between two Service Interfaces as permitted by established business arrangement.
- Service Provider request instantiation of functional service components as permitted by established business arrangement.
- Service Provider queries the Partner for detailed information related to Services provided by the Partner to the Service Provider.
- Service Provider receives Service specific event notifications (e.g., Service Problem Alerts) from the Partner.
- Service Provider receives Service specific performance information from the Partner.
- Service Provider request Service related test initiation and receive test results from the Partner.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| Documentation | Documentation of User Stories; Use Cases and Interactions (e.g., UML); Information Models (e.g., UML); Data Models (e.g., JSON); Interface Profiles and Functional Definition;ONAP Component Mapping and Functional Analysis |
| External API | JSON Swagger / OpenAPI for the External Interface |
| External API Agent Software | Code contribution for External API Agent functionality |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
...
- External API Agent:
- Core Agent Functionality
- Service Catalog API
- Service Ordering API
- Service Inventory API
- Performance Mgmt API
ONAP Dependencies
List the other ONAP projects your depends on.
Dependent on APIs from SDC, SO, DMaaP, AAI and DES
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.
...
Anyone reading this section should have a good understanding of all the interacting modules.
Platform Maturity
Refering 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 | 0 | 0 |
| |
| Resiliency | 0 | 0 |
| |
| Security | 0 | 1 |
| |
| Scalability | 0 | 0 |
| |
| Manageability | 0 | 0 |
| |
| Usability | 0 | 0 |
|
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.
...
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| SDC: Catalog API | Exposes Service Catalog | TBD | TBD | https://wiki.onap.org/display/DW/SDC+API |
| SO: Service Instantiation API | Requests for Service Instantiation | TBD | TBD | |
| AAI: Service Inventory API | Query for Service Inventory | TBD | TBD | |
| DMaaP: Events API | Query for AAI_EVENTS and SDC Distribution Events | TBD | TBD |
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) |
|---|---|---|---|---|
| ExtAPI: Service Catalog | External Service Catalog API | TBD | TBD | TBD |
| ExtAPI: Service Ordering | External Service Ordering API | TBD | TBD | TBD |
| ExtAPI: Service Inventory | External Service Inventory API | TBD | TBD | TBD |
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.
...
- BSS/OSS retrieves Service Models
- BSS/OSS orders a new Service.
- BSS/OSS subscribes to Service order tracking status notifications.
- BSS/OSS retrieves Service Inventory
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 |
|---|---|
| TBD | TBD |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
...
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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 |
|---|---|---|
| TBD | TBD | TBD |
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.
...
Date | Project | Deliverable |
|---|---|---|
| TBD | TBD | TBD |
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
- ...
...
https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
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.
...