Page Status: Updated by PTL - July, 13, 2020
Component Status: ArchCom Review done on the 28th of July 2020
Last Reviewed on:
Certified by:
CLAMP (Closed loop Automation Platform):
1. High Level Component Definition and Architectural Relationships
The CLAMP functional entity provides the capability to manage runtime control loops. It provides the capability to
- Create control loop from DCAE blueprint, those blueprint are either:
- sent by SDC to DCAE(inventory) via SDC distribution.
- or sent by DCAE-MOD to DCAE(inventory)
- Create configuration policy from the policy-model Tosca, the tosca policy-model are either:
- sent by SDC via SDC distribution to everyone
- or query by CLAMP to Policy. in this case the policy-model is either pre-provison in Policy
or separately provision to Policy via the REST API exposed by Policy.
- Configure DCAE applications of the control loop
- Associate µService configuration policies to the DCAE application
- Configure the operations to be taken by the control loop (by creating/updating/deleting operational policies)
- Deploy/un-deploy control loop flow (blueprints) to DCAE
- Control loop visualization.
CLAMP relies on Policy to communicate to App-C/VF-C/SDN-C/SO in runtime, hence these are not part of CLAMP
2. API definitions
CLAMP provides the following interfaces: (add the link to the interfaces)
| Interface Name | Interface Definition | Interface Capabilities | API Spec (Swagger) |
|---|---|---|---|
| CLAMPE-1 | Control Loop Lifecycle Management Interface. | A user interface (GUI) for:
| N/A (GUI) |
| CLAMPE-2 | Control loop dashboard. User interface to show the overall status of the control loop through DMAAP events | A GUI to Display and update:
| N/A (kibana/ELK) |
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 API's
CLAMP consumes the following Interfaces:
| Interface Name | Purpose Reason For Use | API Spec (Swagger) |
|---|---|---|
| SDCE-6 | To receive the Control Loop Blueprint from SDCTo receive | https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html |
| PolicyE-2 | To create and configure the closed Loop Operational Policies and Configuration policies(DCAE Aps. Config.) | https://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html |
| PolicyE-1 | To query policy-model based on a policy-model id. used for Configuration policy-model and Operational Policy-model | https://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html |
| DCAEE-x |
| |
| DCAEE-y | Deploy/remove DCAE application. | |
| CDS-1 | Get list of operations/actions and corresponding payload for Operational Policy where selected actor is "CDS". | |
| AAF-1 | done via cady plugin(so not directly CLAMP code), authenticate/authorize user when accessing Management interface of CLAMP ('CLAMP-1' above) |
3. Component Description:
A more detailed figure and description of the component.
https://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index
4. known system limitations
Runtime: None
Clamp data redundancy is dependent on Kubernetes and the persistent volume.
Clamp application redundancy HA relies on Kubernetes
5. Used Models
Clamp uses the following models:
- Service model (received from SDC)
- VNF model (received from SDC)
- Policy Model.
6. System Deployment Architecture
FFS
7. New Capabilities in this Release
-
8. References
- CLAMP Overview : https://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index
- CLAMP internal interfaces: https://docs.onap.org/projects/onap-clamp/en/latest/_downloads/d25f20712a4cf2524a1cf13242349743/swagger.pdf
- CLAMP User Guide: https://docs.onap.org/projects/onap-clamp/en/latest/user-guide.html#