Page Status: Updated for Istanbul -   
Component Status: Approved

Last Reviewed on: 17th of March 2021

Certified by: Gervais-Martial Ngueko

CLAMP has been merged into Policy, so from now forward, please refer to: ARC Policy Framework Component Description - Montreal-R13, for the CLAMP architecture.

CLAMP (Closed loop Automation Platform): this CLAMP component has been merged with Policy

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 NameInterface Definition Interface CapabilitiesAPI Spec (Swagger)
CLAMPE-1Control Loop Lifecycle Management Interface.   A user interface (GUI) for:
  • Selecting the control loop flow
  • Entering configuration policy parameters
  • Entering operational policy parameters
  • Managing life cycle of DCAE control flow blueprint 
  • Select a Service to associate to a Control Loop to be instanciated

N/A

(GUI)

CLAMPE-2Control loop dashboard.  User interface to show the overall status of the control loop through DMAAP events

 A GUI to Display and update:

  • Events received and actions taken on the control loop.

N/A

(GUI: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:

CLAMP consumes the following Interfaces:

Interface NamePurpose Reason For UseAPI Spec (Swagger)
SDCE-6To receive the Control Loop Blueprint from SDCTo receivehttps://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html
PolicyE-2To 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-modelhttps://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html
DCAEE-x 
  • Retrieve DCAE appplication status
  • Retrieve DCAE µS lists
  • Retrieve DCAE µS description and blueprints
https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/apis/inventory.html
DCAEE-y Deploy/remove DCAE application. https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/apis/deployment-handler.html
CDS-1Get list of operations/actions and corresponding payload for Operational Policy where selected actor is "CDS".

CDS EXTERNAL REST API FOR WORKFLOW.docx

AAF-1  done via cady plugin(so not directly CLAMP code), authenticate/authorize user when accessing Management interface of CLAMP ('CLAMP-1' above)

https://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-index

https://docs.onap.org/projects/onap-aaf-certservice/en/latest/sections/offeredapis.html#aaf-cert-service-api

https://docs.onap.org/projects/onap-aaf-sms/en/latest/api.html


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

  1. CLAMP Overview : https://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index
  2. CLAMP internal interfaces:  https://docs.onap.org/projects/onap-clamp/en/latest/_downloads/d25f20712a4cf2524a1cf13242349743/swagger.pdf 
  3. CLAMP User Guide: https://docs.onap.org/projects/onap-clamp/en/latest/user-guide.html#



  • No labels