...
2. API Definitions
2a. Exposed APIs
| API Key | API Name | Description | Payload Model(s) | Status |
|---|
| POE- |
1a Model InputPolicy Creation model input interface (manual interface through GUI) | production | POE-1b | Policy Creation & Management | API for the creation and management of policies | production | POE-2a | PDP Query API (SDN-CP) | Policy Decision Point query API for SDN-CP | production | POE-2b | PDP Query API (SO) | Policy Decision Point query API for SO | production | POE_3a | Policy Distribution (DCAE) | Policy Distribution interface for DCAE | production | POE-3b | Policy Distribution (OOF) | Policy Distribution interface for OOF | production | POE-5 | Policy Trigger | Trigger policies | production | POE-6 | Policy Type Design API for TOSCA Policy Types | allows Policy Model TOSCA Policy Model | unstable | | POE-7 | Policy Design API | support CRUD of TOSCA Policy entities from TOSCA compliant PolicyType definitions. | Policy Model TOSCA Policy Model | unstable |
POE-8 | Policy Administration API | support | 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. | REST | production |
| POE-2 | Policy Design | Allows applications (such as CLAMP and Integration) to create, update, delete, and query |
the PolicyType entities that are available for Policycreation| Policy entities. | REST | production |
| POE-2 | Policy Administration | Support CRUD of PDP groups and subgroups and to support the deployment and life cycles |
of entities (TOSCA Policy and PolicyTypeImpl entities| entities (TOSCA Policy and PolicyTypeImpl entities) on PDP sub groups and PDPs. |
unstable9Policy Decision API| 3 | Data Ingress | Policy listens on a DMaaP topic. Messages of interest are described in the policy logic | DMaaP | production |
| POE-4 | Decision Query | Policy decisions are required by ONAP components to support the policy-driven ONAP architecture. Policy Decisions are implemented using the XACML PDP. |
unstable| The calling application must provide attributes in order for the XACML PDP to return a correct decision. | JSON/HTTP | production |
2b. Consumed APIs
| API Key | API Name | Description |
|---|
| POE-4a | Authentication | Authentication for PDP |
POE-4bretrieve | Enrich ingress data with topology information |
for enrichmentPOE6a| POE-6b | Generic NF Controller | Restart / rebuild / migrate / evacuate the target entity |
POE-7 | SDN Controller | Restart / rebuild / migrate / evacuate the target entity | | Service Orchestrator | Trigger orchestration actions (policy driven) |
| Controller-X | Controller API | trigger control actions (policy driven) |
| TT-X | Trouble Ticketing | trigger open loop ticketing system |
| POE-8 | SO | Create a VF module |
| POE-9a | VFC | restart the target entity |
POE-9b | APP-C | Direct needed actions| Other | Other Actions | Trigger any interface defined in a policy |
3. Component Description
4. Known System Limitations
5. Used Models
6. System Deployment Architecture
...