You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
STATUS: Draft
External API:
1 High Level Component Definition and Architectural Relationships
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlN0ZXBoZW4gVGVycmlsbCIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJNYXR0aGlldSBHZWVyZWJhZXJ0IiwibGFuZ3VhZ2UiOiJlbiIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IkV4dGVybmFsQVBJIFN5c3RlbSBDb250ZXh0IFZpZXciLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiI2MDg4NDQ1NCIsImRpYWdyYW1OYW1lIjoiRXh0ZXJuYWxBUEkgU3lzdGVtIENvbnRleHQgVmlldyIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJBUkMgRXh0ZXJuYWxBUEkgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRHVibGluIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo2MDg4NDQ0OCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6NjA4ODQ0ODMsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjMsIm1hY3JvSWQiOiI3MzE0Njk2Mi1lNWY4LTQyMjMtOWRiNC1iM2JhMTc2YzBhZTEiLCJwcmV2aWV3TmFtZSI6IkV4dGVybmFsQVBJIFN5c3RlbSBDb250ZXh0IFZpZXcucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjQ5MiIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTU1MzAxMDA2NjAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
External API exposes ONAPs capabilities through defined interfaces. Enables ONAP to be viewed as a "black box".
It provides
Exposes the ONAP service catalogue capabilities
Exposes the ONAP inventory capabiliteis
Exposes ONAP Service Ordering capabilities
Interaces to manage subscription to ExternalAPI events
2. API definitions
Extenal API 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:
6. System Deployment Architecture
AAI consists of X containers:
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlN0ZXBoZW4gVGVycmlsbCIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJFcmljIERlYmVhdSIsImxhbmd1YWdlIjoiZW4iLCJkaWFncmFtRGlzcGxheU5hbWUiOiJFeHRlcm5hbEFQSSBydW50aW1lIGFyY2hpdGVjdHVyZSIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjYwODg0NDU2IiwiZGlhZ3JhbU5hbWUiOiJFeHRlcm5hbEFQSSBydW50aW1lIGFyY2hpdGVjdHVyZSIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJBUkMgRXh0ZXJuYWxBUEkgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRHVibGluIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo2MDg4NDQ0OCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6NjA4ODQ0ODMsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjEsIm1hY3JvSWQiOiI4MTEwODE0Ny1jNDFjLTQxNTUtOGRlOS1kZTg2MmNmODM5NWEiLCJwcmV2aWV3TmFtZSI6IkV4dGVybmFsQVBJIHJ1bnRpbWUgYXJjaGl0ZWN0dXJlLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiI4MjEiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE1NTI0MDAzOTgwMDAsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
7. New Capabilities in this Release
This release, AAI adds the following Capabilities:
8. References
- AAI read the docs: https://docs.onap.org/en/casablanca/submodules/aai/aai-common.git/docs/index.html?highlight=AAI
- AAI REST API Documentation - Dublin
AAI REST API Documentation on readthedocs.io
- AAI GUI: AAI Graphical User Interface