Restructure CLAMP documentation tree
[policy/parent.git] / docs / clamp / clamp / clamp-architecture.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (c) 2017-2021 AT&T Intellectual Property.  All rights reserved.
4
5 .. _architecture:
6
7
8 Policy/Clamp in the ONAP Architecture
9 =====================================
10
11 CLAMP platform has been integrated into the Policy framework project, starting as a POC during
12 Honolulu release and as a official feature with Istanbul release. So CLAMP must be seen now
13 as a function provided by the Policy Framework project.
14
15 CLAMP is a function for designing and managing control loops and a UI to manage Policies.
16 It is used to visualize a control loop, configure it with specific parameters for a particular network
17 service, then deploying and undeploying it.  Once deployed, the user can also
18 update the loop with new parameters during runtime, as well as suspending and
19 restarting it.
20
21 Starting with Istanbul release, CLAMP GUI can also be used to create/read/update/delete/list policies
22 outside of a control loop, and therefore CLAMP is also the front-end for Policies management in ONAP.
23
24 CLAMP interacts with other systems to deploy and execute the control loop. For
25 example, it extracts the control loop blueprint from CSAR distributed by SDC.
26 CLAMP also calls the internal Policy framework API to get the Policy Models(Model Driven Control Loop)
27 It requests from DCAE the instantiation of microservices.
28 to manage the control loop flow. Furthermore, it creates and updates multiple
29 policies (for DCAE mS configuration and actual Control Operations) in the Policy Engine
30 that define the closed loop flow.
31
32 |clamp-flow|
33
34 The ONAP CLAMP function abstracts the details of these systems under the concept
35 of a control loop model.  The design of a control loop and its management is
36 represented by a workflow in which all relevant system interactions take
37 place.  This is essential for a self-service model of creating and managing
38 control loops, where no low-level user interaction with other components is
39 required.
40
41 At a higher level, CLAMP is about supporting and managing the broad operational
42 life cycle of VNFs/VMs and ultimately ONAP components itself. It offers the
43 ability to design, test, deploy and update control loop automation - both closed
44 and open. Automating these functions represents a significant saving on
45 operational costs compared to traditional methods.
46
47 |closed-loop|
48
49 .. |clamp-flow| image:: images/architecture/distdepl.png
50 .. |closed-loop| image:: images/architecture/ONAP-closedloop.png