Add architecture and release notes structure
[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 2017 AT&T Intellectual Property.  All rights reserved.
4
5
6 Clamp in ONAP Architecture
7 --------------------------
8
9 CLAMP is a platform for designing and managing control loops. It is used to design
10 a closed 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 closed loop. For
16 example, it pushes the control loop design to the SDC catalog, associating it
17 with the VF resource.  It requests from DCAE the instantiation of microservices
18 to manage the closed loop flow.  Further, it creates and updates multiple
19 policies in the Policy Engine that define the closed loop flow.
20
21 The ONAP CLAMP platform abstracts the details of these systems under the concept
22 of a control loop model.  The design of a control loop and its management is
23 represented by a workflow in which all relevant system interactions take
24 place.  This is essential for a self-service model of creating and managing
25 control loops, where no low-level user interaction with other components is
26 required.
27
28 At a higher level, CLAMP is about supporting and managing the broad operational
29 life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the
30 ability to design, test, deploy and update control loop automation - both closed
31 and open. Automating these functions would represent a significant saving on
32 operational costs compared to traditional methods.