add Guilin note
[clamp.git] / docs / 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-2018 AT&T Intellectual Property.  All rights reserved.
4 .. _architecture:
5
6 Clamp in ONAP Architecture
7 --------------------------
8
9 CLAMP is a platform for designing and managing control loops. It is used to visualize
10 a control loop, configure it with specific parameters for a particular network
11 service, then deploying and undeploying it.  Once deployed, the user can also
12 update the loop with new parameters during runtime, as well as suspending and
13 restarting it.
14
15 It interacts with other systems to deploy and execute the control loop. For
16 example, it extracts the control loop blueprint and Policy Model(Model Driven Control Loop) 
17 from CSAR distributed by SDC/DCAE-DS.
18 It requests from DCAE the instantiation of microservices
19 to manage the control loop flow.  Furthermore, it creates and updates multiple
20 policies (for DCAE mS configuration and actual Control Operations) in the Policy Engine 
21 that define the closed loop flow.
22
23 |clamp-flow|
24
25 The ONAP CLAMP platform abstracts the details of these systems under the concept
26 of a control loop model.  The design of a control loop and its management is
27 represented by a workflow in which all relevant system interactions take
28 place.  This is essential for a self-service model of creating and managing
29 control loops, where no low-level user interaction with other components is
30 required.
31
32 CLAMP also allows to visualize control loop metrics through a dashboard, in order
33 to help operations understand how and when a control loop is triggered and takes action.
34
35 |dashboard-flow|
36
37 At a higher level, CLAMP is about supporting and managing the broad operational
38 life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the
39 ability to design, test, deploy and update control loop automation - both closed
40 and open. Automating these functions would represent a significant saving on
41 operational costs compared to traditional methods.
42
43 |closed-loop|
44
45 .. |clamp-flow| image:: images/architecture/distdepl.png
46 .. |dashboard-flow| image:: images/architecture/monitoring.png
47 .. |closed-loop| image:: images/architecture/ONAP-closedloop.png