Contents
AAF Interfaces
AAF provides the following interfaces:
Interface Name | Interface Definition | Interface Capabilities | Version | Status | Consumed Models |
---|---|---|---|---|---|
AAFE-1 | Application Authorization Framework Management Interface | A user interface for:
| |||
AAFE-2 | Application Authorization Framework Authentication and Authorization Interface | An interface for the ONAP components to:
|
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
AAF Consumes no Interfaces:
Interface Name | Purpose Reason For Use |
---|---|
AAFE-3: AAF External Credential Interface | An 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 Name | Interface Definition | Interface Capabilities | Version | Status | Consumed Models |
---|---|---|---|---|---|
AAIE-1 | Inventory Service Interface. | An interface to create, update, retrieve, query, delete the service, resources and relationship inventory information for:
AAI also provides Inventory History information | v16 | AAI XSD | |
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. |
CLAMP Interfaces
CLAMP provides the following interfaces: (add the link to the interfaces)
Interface Name | Interface Definition | Interface Capabilities |
---|---|---|
CLAMPE-1 | Control Loop Lifecycle Management Interface. | A user interface for:
|
CLAMPE-2 | Control loop dashboard. User interface to show the overall status of the control loop through DMAAP events | Display and update:
|
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
The current API documents can be found at:
The provided UI interfaces are found at: CLAMP latest user guide
- CLAMP internal APIs can be found: clamp swagger pdf
CLAMP consumes the following Interfaces:
Interface Name | Purpose Reason For Use |
---|---|
SDCE-6 | To receive the Control Loop Blueprint from SDCTo receive |
PolicyE-2 | To 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 Name | Definition | Capabilities | Version | Status | Payload Model(s) |
---|---|---|---|---|---|
POE-1 | Policy Type Design | Allows 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.0 | production | tosca.policies.root |
POE-2 | Policy Design | Allows applications (such as CLAMP and Integration) to create, update, delete, and query Policy entities. | 1.0.0 | production | tosca.policies.root |
POE-3 | Policy Administration | Support 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.0 | production | Embedded |
POE-4 | Data Ingress | Listen on a DMaaP topic. | production | Messages of interest are described in the policy logic DMaaP | |
POE-5 | Decision Query | Policy 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. | NA | production | Defined by policy |
Consumed APIs
Interface Name | Consumed by | Description |
---|---|---|
AAF | Policy Framework | Authentication 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 |
SDC | Policy Framework | Notification of CSAR; Retrieval of CSAR |
AAI | Policies | Enrich ingress data with topology information |
SO | Policies | Trigger orchestration actions (policy driven) |
Policies | Trigger control actions (policy driven) | |
Other | Policies | Trigger any interface defined in a policy, for example, trouble ticketing |