The content of this template is expected to be fill out for M1 Release Planning Milestone.
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | FrankfurtGuilin |
| Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
| Participating Company | AT&T, Amdocs, Orange, Huawei, ZTE, Nokia, IBM, TechMahindra, Fujitsu |
Scope
What is this release trying to address?
The scope of the Frankfurt Release Guilin 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.
AAI R7 Frankfurt Guilin Release: TSC must have requirements
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)
...
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
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=AAI and issuetype in (epic) and status != "Closed" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=AAI and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
- In future release, AAI looks toward additional simplification of visualization of the data model
- Increased S3P, focusing on security and reducing turn around on 3rd party dependency vulnerabilities
- Historical Data Tracking down to the attribute-level
- Enhanced UI with animated state topology
- AAI looks toward geo-redundant clusters of the Cassandra database
- Tabular data views / aggregate views
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
Deliverable Name | Deliverable Description |
|---|---|
| A&AI resources | Executable. REST CRUD interface to graph database |
| A&AI traversal | Executable. REST Interface for complex queries |
| Data router | Executable |
| Search-data-service | Executable |
| Router-core | Library |
| Sparky-fe | Library |
| Sparky-be | Executable (AAI UI) |
| Schema-service | Executable (delivers schema to other AAI mS) |
| Graphadmin | Executable (graph administration functions) |
| ESR | Exectuable |
| OOM Config | Source code - configuration using AAI dockers in the k8 OOM environments |
| Cacher | Executable - caching interface |
Sub-Components
See Resources and Repositories
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
Please fill out the centralized wiki page: Frankfurt Guilin Release Platform Maturity
AAI data is filled out
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.
...
| 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 |
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
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.
...
AAI will contribute additional robot test tooling which does better regression testing
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
Please refer to Frankfurt Guilin Defect Status
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 - Frankfurt Risks
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 |
|---|---|---|
| To fill out | To fill out | To fill out |
Documentation, Training
Please update the following centralized wiki: Frankfurt Guilin Documentation
That includes
...
| 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.
...