STATUS: Draft

External API:

1 High Level Component Definition and Architectural Relationships

The AAI (Available and active inventory function provides real-time views of the resrouces and services in managed by and their relationships. It provides

Realtime views of the managed resources and services and their relationships
The relivance of the managed resources and services to the ONAP components.
It is a registry of the active, available and assigned assets.
It maintains a multidimenstional relationship amonst the managed services and resouces.

2. API definitions

AAI provides the following interfaces:

Interface Name

Interface Definition

Interface Capabilities

AAIE-1

Inventary Service Interface.

An interface to create, update, retrieve, query, delete the service, resources and relationship inventary information for:

Cloud infrastructure (including cloud infrastructure regions and availability zones, cloud infrastructure resources such as servers, storage, VLANs, cloud network technologies,...)
Paths and connectors
Business Customers and busines customer relationship to managed assets
Service Instances (including the relationship to used resources)
Resource instances (including allotted resources) (virtual and physical, including VNFs, PNFs, Switches, VNF modules)
External systems (systems that ONAP connects to)
Images
Networks
Infrastructure tenants
Relationships
Interfaces
IP addresses
Configurations
Licences
Site resources

AAI also provides Inventory History information

AAIE-2

AAI Graphical User Interfaces

Provides the capability to view the inventory

Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface

The current API documents can be found at:

AAI consumes the following Interfaces:

Interface Name	Purpose Reason For Use
SDCE-6	To receive the service and resource artifacts from SDC.

3. Component Description:

A more detailed figure and description of the component.

<< For later inclusion >>

4. known system limitations

Multithreaded concurrent operations on the same objects can cause duplicates in the graph - we have implemented stickiness in the haproxy that sits between AAI and clients to keep a client bound to the same node which can mitigate this, but we do not force locking on updates which means that malicious or careless clients can cause duplicates in the graph. We provide cleanup utilities for data grooming, but we recommend that clients are careful not to send multiple requests on the same object within microseconds of one another.
Operators should pay special attention to giving cassandra enough space, because we have known issues where things go pretty bad (like unhelpful or just wrong error messages) when the disks fill up on the cassandra cluster nodes.

5. Used Models

AAI uses the following models:

Inventary Model

6. System Deployment Architecture

AAI consists of X containers:

?????

7. New Capabilities in this Release

This release, AAI adds the following Capabilities:

Extended PNF support

ARC ExternalAPI Component Description - Dublin