...
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Dublin |
| Project Lifecycle State | Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
| Participating Company List the company participating in this release. At least 3-4 organizations, including an operator are recommended. | AT&T, Amdocs, Orange, Huawei, ZTE, Nokia, IBM, TechMahindra |
Scope
What is this release trying to address?
...
Highest priority will be assigned to support security and platform maturity requirements. As next highest priority, AAI will support the approved use cases. Best-effort additional development will continue to support additional features not included in the approved use cases.
Key Scope Items:
| ItemSummary | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
| ||||||||||
|
Use Cases
AAI R4 Use Case and Functional Requirements Impacts
Minimum Viable Product
Describe the MVP for this release.
- A&AI Core: Resources - CRUD REST API endpoints for A&AI inventory resources
- A&AI Core: Traversal - REST APIs for graph traversals. Some APIs use the Gremlin Server
- UI - An ONAP portal application used by operations for visualizing and searching
- Data Router: Makes decisions about workloads to be dispatched to search and tabular microservces. Includes logic to recognize and direct requests based on request archetypes.
- Search - Enable complex searches for sub graphs and functions that need to perform well across deeply nested structures using Elasticsearch. Used by the UI
- Champ - Abstraction from underlying graph storage systems that A&AI would interface with.
- Gizmo - CRUD Rest API endpoint for resources and relationships, delivering atomic interactions with the graph for improved scalability.
- Enricher - Enables complementing AT&T data with federated data from additional sources
- Cacher - The Response Caching Microservice (Cacher) is built to deliver multiple mechanisms of making API calls and populating the responses into a JSON datastore. The datastore is an embedded mongodb datastore, that stores cached API responses, which are updated via DMAAP events or can be synced by timed tasks or calls to the force sync endpoint.
- ESR - External System Registry component
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.
...
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
|---|
Sub-Components
...
| Gizmo | Executable. Atomic REST CRUD interface to graph database |
| A&AI resources | Executable. REST CRUD interface to graph database |
| A&AI traversal | Executable. REST Interface for complex queries |
| Data router | Executable |
| ESR | Exectuable |
| OOM Config | Source code - configuration recommendations for using AAI dockers in the OOM environments |
| Enricher | Executable - data federation service |
| Cacher | Executable - caching interface |
Sub-Components
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.
...
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 Archiecture 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
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 | 1 | 1 |
| |
| Stability | 1 | 1 |
| |
| Resiliency | 2 | 2 |
| |
| Security | 1 | 2 (Stretch goal) |
| |
| Scalability | 1 | 1 |
| |
| Manageability | 1 | 1 |
| |
| Usability | 1 | 1 |
|
...
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) |
|---|
| DMaaP | Eventing bus | |||
| MSB | Service registry | |||
| SDC | AAI Model loader consumes model objects | |||
| AAF | Authentication / Authorization |
API Outgoing Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out |
|---|---|---|---|---|---|---|---|---|
| SO | REST API | M3 | TBD | |||||
| APPC | REST API | M3 | TBD | |||||
| POLICY | REST API | M3 | TBD | |||||
| VID | REST API | M3 | TBD | |||||
| SDNC | REST API | M3 | TBD | |||||
| HOLMES | REST API | M3 | TBD | |||||
| VF-C | REST API | M3 | TBD | |||||
| CLI | REST API | M3 | TBD | |||||
| MultiVim | REST API | M3 | TBD | |||||
| SDC | REST API(upload/query images) | M3 | TBD | |||||
| ExtAPI | REST API | M3 | TBD | |||||
| UUI | REST API | M3 | TBD | |||||
| OOF | REST API | M3 | TBD | Link toward the detailed API description
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 | |||
|---|---|---|---|---|---|
| JanusGraph | Open-source, distributed graph database | 0.2.2 | |||
| Ubuntu | Open-source software operating system | 16.0.4-LTS | |||
| Cassandra | Open-source distributed storage system | 3.11 | |||
| Docker | VM container | ||||
| SpringBoot | Open-source Microservice application sever | 1.5.18 or 2.x | |||
| ElasticSearch | Search framework | 2.4.1 | |||
| HAPROXY | microservice front end | 1.8 | To fill out | To fill out | To fill out |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...
| 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
...