The content of this template is expected to be fill out for M1 Release Planning Milestone.
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Enter the name of the release you are targeting to deliver |
| Project Lifecycle State | Either 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?
Describe the problem being solved by this release
Requirements
Describe the use case this release is targeted for (better if reference to customer requirements).
Minimum Viable Product
...
The scope of the Dublin Release of AAI will address CII Badging Security Program and Platform Maturity Requirements, as well the approved use cases.
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.
Requirements
Minimum Viable Product
- 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
- 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 (provided community can deliver support, update vulnerable dependencies, and maintain the project)
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 |
|---|---|
| To fill out | To fill out |
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.See Resources and Repositories
Architecture
High level architecture diagram
...
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 this project is delivering to other projects.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |||||
|---|---|---|---|---|---|---|---|---|---|
| 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 | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | 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.3 |
| Cassandra | Open-source distributed storage system | 3.11 |
| Docker | VM container | |
| SpringBoot | Open-source Microservice application sever | 1.5.22 or 2.x |
| ElasticSearch | Search framework | 6.8 |
| HAPROXY | microservice front end | 1.8 |
| Centos/Alpine | OS | See docker config files |
Testing and Integration Plans
...