The content of this template is expected to be fill out for M1 Release Planning Milestone.

Overview

Scope

What is this release trying to address?

The scope of the Guilin Release of AAI will address 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 Guilin Release: TSC must have requirements

Requirements

Use Cases: AAI R7 Guilin Release: Functional Use Cases 

TSC MUST HAVES : AAI R7 Guilin Release: TSC must have 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.

Epics

Stories

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.

Sub-Components

See Resources and Repositories (Deprecated)#ActiveandAvailableInventory

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: 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.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

API Outgoing Dependencies

API this project is delivering to other projects.

• 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, ...).

• 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 R7 Guilin: 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.

• KNOWN DEFECTS AND ISSUES

TBD

• 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 - Guilin Risks

• RESOURCES

TBD

• RELEASE MILESTONE

The milestones are defined at the Guilin Release Planning 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.

• DOCUMENTATION, TRAINING

Please update the following centralized wiki: Guilin 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

  • ...

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.