From ebc6907968050189688a0b8ccc0e0c42419a9202 Mon Sep 17 00:00:00 2001 From: osgn422w Date: Tue, 16 Mar 2021 16:27:47 +0100 Subject: Policy/Clamp doc update update the documentation to reflect the merge of clamp into Policy framework Issue-ID: REQ-684 Change-Id: I06391cb6468c15aba58bac18a5c042d05b6c8b9f Signed-off-by: osgn422w --- docs/architecture.rst | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) (limited to 'docs/architecture.rst') diff --git a/docs/architecture.rst b/docs/architecture.rst index 79c8e06f5..b65eb1c1d 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,39 +1,41 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. +.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved. .. _architecture: -Clamp in ONAP Architecture --------------------------- +Policy/Clamp in ONAP Architecture +--------------------------------- -CLAMP is a platform for designing and managing control loops. It is used to visualize -a control loop, configure it with specific parameters for a particular network +CLAMP platform has been integrated into the Policy framework project, starting as a POC during +Honolulu release and as a official feature with Istanbul release. So CLAMP must be seen now +as a function provided by the Policy Framework project. + +CLAMP is a function for designing and managing control loops and a UI to manage Policies. + It is used to visualize a control loop, configure it with specific parameters for a particular network service, then deploying and undeploying it. Once deployed, the user can also update the loop with new parameters during runtime, as well as suspending and restarting it. -It interacts with other systems to deploy and execute the control loop. For -example, it extracts the control loop blueprint and Policy Model(Model Driven Control Loop) -from CSAR distributed by SDC/DCAE-DS. -It requests from DCAE the instantiation of microservices -to manage the control loop flow. Furthermore, it creates and updates multiple -policies (for DCAE mS configuration and actual Control Operations) in the Policy Engine +Starting with Istanbul release, CLAMP GUI can also be used to create/read/update/delete/list policies +outside of a control loop, and therefore CLAMP is also the front-end for Policies management in ONAP. + +CLAMP interacts with other systems to deploy and execute the control loop. For +example, it extracts the control loop blueprint from CSAR distributed by SDC. +CLAMP also calls the internal Policy framework API to get the Policy Models(Model Driven Control Loop) +It requests from DCAE the instantiation of microservices. +to manage the control loop flow. Furthermore, it creates and updates multiple +policies (for DCAE mS configuration and actual Control Operations) in the Policy Engine that define the closed loop flow. |clamp-flow| -The ONAP CLAMP platform abstracts the details of these systems under the concept +The ONAP CLAMP function abstracts the details of these systems under the concept of a control loop model. The design of a control loop and its management is represented by a workflow in which all relevant system interactions take place. This is essential for a self-service model of creating and managing control loops, where no low-level user interaction with other components is required. -CLAMP also allows to visualize control loop metrics through a dashboard, in order -to help operations understand how and when a control loop is triggered and takes action. - -|dashboard-flow| - At a higher level, CLAMP is about supporting and managing the broad operational life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the ability to design, test, deploy and update control loop automation - both closed @@ -43,5 +45,4 @@ operational costs compared to traditional methods. |closed-loop| .. |clamp-flow| image:: images/architecture/distdepl.png -.. |dashboard-flow| image:: images/architecture/monitoring.png .. |closed-loop| image:: images/architecture/ONAP-closedloop.png -- cgit 1.2.3-korg