Contents

AAF Interfaces

AAF provides the following interfaces:
Interface NameInterface Definition Interface CapabilitiesVersionStatusConsumed Models
AAFE-1Application Authorization Framework Management Interface  A user interface for:
  • to be filled in



AAFE-2Application Authorization Framework Authentication and Authorization Interface

 An interface for the ONAP components to:

  • to be filled in.



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

AAF Consumes no Interfaces:

Interface NamePurpose Reason For Use
AAFE-3: AAF External Credential InterfaceAn interface to retrieve and authenticate using credentials from a credential supplier external to ONAP.

The current API documents can be found at:

  • AAFE-1 (to be added)

  • AAFE2 (to be added)
  • AAFE3 (to be added)

AAI Interfaces

AAI provides the following interfaces:
Interface NameInterface Definition Interface CapabilitiesVersionStatusConsumed Models
AAIE-1Inventory Service Interface.   An interface to create, update, retrieve, query, delete the service, resources and relationship inventory 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 business 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
  • Licenses
  • Site resources

AAI also provides Inventory History information

v16
AAI XSD
 AAIE-2AAI 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 NamePurpose Reason For Use
SDCE-6To receive the service and resource artifacts from SDC.


CLAMP Interfaces

CLAMP provides the following interfaces: (add the link to the interfaces)
Interface NameInterface Definition Interface Capabilities
CLAMPE-1Control Loop Lifecycle Management Interface.   A user interface for:
  • Selecting the control loop flow
  • Entering configuration policy parameters
  • Entering operational policy parameters
  • Managing life cycle of DCAE control flow blueprint 
CLAMPE-2Control loop dashboard.  User interface to show the overall status of the control loop through DMAAP events

 Display and update:

  • Events received and actions taken on the control loop.

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

The current API documents can be found at:

CLAMP consumes the following Interfaces:

Interface NamePurpose Reason For Use
SDCE-6To receive the Control Loop Blueprint from SDCTo receive
PolicyE-2To create and configure the closed Loop Operational Policies and Configuration policies(DCAE Aps. Config.)
DCAEE-x Retrieve DCAE appplication status
DCAEE-y Deploy/remove DCAE application. 


Policy Interfaces

Exposed APIs

Interface NameDefinitionCapabilitiesVersionStatusPayload Model(s)
POE-1Policy Type DesignAllows applications to create, update, delete, and query PolicyType entities so that they become available for use in ONAP by applications such as CLAMP.1.0.0production

tosca.policies.root

TOSCA

POE-2Policy DesignAllows applications (such as CLAMP and Integration) to create, update, delete, and query Policy entities.1.0.0production

tosca.policies.root

TOSCA

POE-3Policy AdministrationSupport CRUD of PDP groups and subgroups and to support the deployment and life cycles of PolicyImpl entities (TOSCA Policy and PolicyTypeImpl entities) on PDP sub groups and PDPs.1.0.0productionEmbedded
POE-4Data IngressListen on a DMaaP topic. 
production

Messages of interest are described in the policy logic

DMaaP

POE-5Decision QueryPolicy decisions are required by ONAP components to support the policy-driven ONAP architecture. Policy Decisions are implemented using the XACML PDP. The calling application must provide attributes in order for the XACML PDP to return a correct decision.NAproductionDefined by policy

Consumed APIs

Interface NameConsumed byDescription
AAFPolicy FrameworkAuthentication and authorization
DMaaP

Policy Framework

Policies

Policy framework uses DMaaP for SDC subscriptions and internal communication.

Policies use DMaaP as a transport for contextual information from various sources

SDCPolicy FrameworkNotification of CSAR; Retrieval of CSAR
AAIPoliciesEnrich ingress data with topology information
SOPoliciesTrigger orchestration actions (policy driven)

SDNC

APPC

PoliciesTrigger control actions (policy driven)
OtherPoliciesTrigger any interface defined in a policy, for example, trouble ticketing


  • No labels