:maxdepth: 1
clamp/clamp
+ clamp/user-guide
+ clamp/architecture
controlloop/controlloop
controlloop/system-level-dialogues
controlloop/defining-controlloops
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved.
+.. _architecture:
+
+Policy/Clamp in ONAP Architecture
+---------------------------------
+
+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.
+
+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 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.
+
+At a higher level, CLAMP is about supporting and managing the broad operational
+life cycle of VNFs/VMs and ultimately ONAP components itself. It offers the
+ability to design, test, deploy and update control loop automation - both closed
+and open. Automating these functions represents a significant saving on
+operational costs compared to traditional methods.
+
+|closed-loop|
+
+.. |clamp-flow| image:: images/architecture/distdepl.png
+.. |closed-loop| image:: images/architecture/ONAP-closedloop.png
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved.
.. _clamp-builtin-label:
-Placeholder for CLAMP Built In Control Loop Automation Management
-#################################################################
+Policy/CLAMP - Control Loop Automation Management Platform
+==========================================================
+.. High level architecture, design, and packaging information for release planning and delivery.
+
+.. include:: architecture.rst
+
+
+Offered APIs
+------------
+The list of APIs that Policy/CLAMP offers can be found on the following table:
+
+.. |pdf-icon| image:: images/pdf.png
+ :width: 40px
+
+.. |swagger-icon| image:: images/swagger.png
+ :width: 40px
+
+.. |html-icon| image:: images/html.png
+ :width: 40px
+
+.. csv-table::
+ :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|"
+ :widths: 60,60,60
+
+ "swagger json file", "html doc", "pdf doc"
+ ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`"
+
+
+Consumed APIs
+-------------
+Policy/CLAMP uses the API's exposed by the following ONAP components:
+
+- SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
+- DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
+- Policy Core: REST based interface, Policy Core engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C
+- CDS: REST based interface, to retrieve list of operations/actions with their corresponding payload at runtime for Operational Policies where the field 'actor' is 'CDS'.
+
+Delivery
+--------
+Policy/CLAMP component is composed of a UI layer and a backend layer, each layer having its own container.
+Policy/CLAMP also requires a database instance with 1 DB, it uses MariaDB, which is the same DB as for the core Policy.
+
+.. |clamp-policy-archi| image:: images/clamp-policy_archi.png
+
+|clamp-policy-archi|
+
+Logging & Diagnostic Information
+--------------------------------
+CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources).
+
+With the default log settings, all logs will be generated into console and into root.log file under the CLAMP root folder. The root.log file is not allowed to be appended, thus restarting the CLAMP will result in cleaning of the old log files.
+
+
+.. _index-clamp-installation:
+
+Installation
+------------
+A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
+
+Once the image has been built and is available locally, you can use the `docker-compose up` command to deploy a pre-populated database and a CLAMP instance available on [https://localhost:3000](https://localhost:3000).
+
+Configuration
+-------------
+.. Where are they provided?
+.. What are parameters and values?
+
+
+Currently, the CLAMP docker images can be deployed with small configuration needs. Though, you might need to make small adjustments to the configuration. As CLAMP is spring based, you can use the SPRING_APPLICATION_JSON environment variable to update its parameters.
+
+.. TODO detail config parameters and the usage
+
+
+There are one datasource for Clamp. By default, it will try to connect to the localhost server using the credentials available in the example SQL files. If you need to change the default database host and/or credentials, you can do it by using the following json as SPRING_APPLICATION_JSON environment variable :
+
+.. code-block:: json
+
+ {
+ "spring.datasource.cldsdb.url": "jdbc:mariadb:sequential://clampdb.{{ include "common.namespace" . }}:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3",
+ "clamp.config.files.sdcController": "file:/opt/clamp/sdc-controllers-config.json",
+ "clamp.config.dcae.inventory.url": "https://inventory.{{ include "common.namespace" . }}:8080",
+ "clamp.config.dcae.dispatcher.url": "https://deployment-handler.{{ include "common.namespace" . }}:8443",
+ "clamp.config.dcae.deployment.url": "https://deployment-handler.{{ include "common.namespace" . }}:8443",
+ "clamp.config.dcae.deployment.userName": "none",
+ "clamp.config.dcae.deployment.password": "none",
+ "clamp.config.policy.api.url": "https://policy-api.{{ include "common.namespace" . }}:6969",
+ "clamp.config.policy.api.userName": "healthcheck",
+ "clamp.config.policy.api.password": "zb!XztG34",
+ "clamp.config.policy.pap.url": "https://policy-pap.{{ include "common.namespace" . }}:6969",
+ "clamp.config.policy.pap.userName": "healthcheck",
+ "clamp.config.policy.pap.password": "zb!XztG34",
+ "clamp.config.cadi.aafLocateUrl": "https://aaf-locate.{{ include "common.namespace" . }}:8095",
+ "com.att.eelf.logging.path": "/opt/clamp",
+ "com.att.eelf.logging.file": "logback.xml"
+ }
+
+SDC-Controllers config
+----------------------
+This file is a JSON that must be specified to Spring config, here is an example:
+
+.. code-block:: json
+
+ {
+ "sdc-connections":{
+ "sdc-controller1":{
+ "user": "clamp",
+ "consumerGroup": "consumerGroup1",
+ "consumerId": "consumerId1",
+ "environmentName": "AUTO",
+ "sdcAddress": "localhost:8443",
+ "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
+ "pollingInterval":30,
+ "pollingTimeout":30,
+ "activateServerTLSAuth":"false",
+ "keyStorePassword":"",
+ "keyStorePath":"",
+ "messageBusAddresses":["dmaaphost.com"]
+ },
+ "sdc-controller2":{
+ "user": "clamp",
+ "consumerGroup": "consumerGroup1",
+ "consumerId": "consumerId1",
+ "environmentName": "AUTO",
+ "sdcAddress": "localhost:8443",
+ "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
+ "pollingInterval":30,
+ "pollingTimeout":30,
+ "activateServerTLSAuth":"false",
+ "keyStorePassword":"",
+ "keyStorePath":"",
+ "messageBusAddresses":["dmaaphost.com"]
+ }
+ }
+ }
+
+Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
+Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
+The environmentName is normally the Dmaap Topic used by SDC.
+If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
+
+Administration
+--------------
+
+A user can access Policy/CLAMP UI at the following URL : https://localhost:3000.
+(in this URL 'localhost' must be replaced by the actual host where Policy/CLAMP has been installed if it is not your current localhost)
+For OOM, the URL is https://<host-ip>:30258
+
+.. code-block:: html
+
+ - Without AAF, the credentials are
+ Default username : admin
+ Default password : password
+
+ - With AAF enabled, the certificate p12 must be added to the browser
+ ca path: src/main/resources/clds/aaf/org.onap.clamp.p12, password "China in the Spring"
+ Or get it from this page : https://wiki.onap.org/display/DW/Control+Loop+Flows+and+Models+for+Casablanca
+
+Human Interfaces
+----------------
+.. Basic info on the interface type, ports/protocols provided over, etc.
+
+User Interface - serve to configure control loop
+Policy/CLAMP UI is used to configure the Control Loop designed and distributed by SDC. From that UI it's possible to distribute the configuration policies and control the life-cycle of the DCAE Micro Services.
+Policy/CLAMP UI is also used to manage Policies outside of a Control Loop.
+
+The following actions are done using the UI:
+
+* Design a control loop flow by selecting a predefined template from a list
+ (a template is an orchestration chain of Micro-services, so the template
+ defines how the micro-services of the control loop are chained together)
+
+* Give value to the configuration the parameters of each micro-service of
+ the control loop
+
+* Select the service and VNF(of that service) to which the control loop
+ will be attached
+
+* Configure the operational policy(the actual operation resulting from
+ the control loop)
+
+* Send the “TOSCA” blueprint parameters that will be used by DCAE to start the
+ control loop (The blueprint will be sent first to SDC and SDC will
+ publish it to DCAE)
+
+* Trigger the deployment of the Control loop in DCAE
+
+* Control (start/stop) the operation of the control loop in DCAE
+
+HealthCheck API - serve to verify CLAMP status (see offered API's section)
+* https://<host-ip>:8443/restservices/clds/v1/healthcheck
+This one does not require the certificate
+
+Walk-through can be found here: https://wiki.onap.org/display/DW/CLAMP+videos
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CLAMP User Guide <user-guide.rst>
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved.
+
+Control loop in Policy/CLAMP
+----------------------------
+There are 2 control loop levels in Policy/CLAMP:
+
+- Control loop template: This is created from the DCAE blueprint (designed in the DCAE designer), and distributed by SDC to CLAMP.
+- Control loop instance: Based on the template, it represents a physical control loop in the platform related to a service and a VNF.
+
+There is no way to design the microservice components of the control loop from scratch in CLAMP, you can only configure it and manage its life-cycle.
+For more info on how to design the service in SDC, check this: https://wiki.onap.org/display/DW/CLAMP+videos#CLAMPvideos-DesignpartinSDC
+
+
+There is a specific menu to view the available Control loop templates.
+
+|clamp-template-menu|
+
+
+Each microservice policies and operational policies is related to a Policy Model.
+Clamp either communicates with Policy Engine periodically to download the available Policy Models automatically or user can upload the Policy Model manually.
+Policy Models related operations could be found under Policy Models menu.
+
+|clamp-policy-model-menu|
+
+
+Under the menu *Loop Instance*, there's a list of actions to perform regarding to the loops.
+
+|clamp-loop-menu|
+
+
+Option *Create* creates the loop from the templates distributed by SDC.
+
+|clamp-create-loop|
+
+
+Option *Open* opens the saved loops. Once the distributed control loop has been chosen, the control loop is shown to the user.
+
+|clamp-open-loop|
+
+
+Option *Close* will close the current opened loop.
+
+
+Option *Modify* opens the window to add/remove different Operational Policies to the loop.
+Tab *Add Operational Policies* lists all the available operational policies.
+Click *Add* button to add the selected operational policies to the loop.
+
+|clamp-add-operational-policies|
+
+Tab *Remove Operational Policies* lists all the operational policies added to the loop.
+Click *Remove* button to remove the selected operational policies from the loop.
+
+|clamp-remove-operational-policies|
+
+
+Once opened, the user can start configure empty control loop using **Closed loop modeller**.
+
+|clamp-opened-loop|
+
+
+Loop modeler has 3 main parts:
+
+#. Loop configuration view
+ Visualizes event flow in Control Loop. This view is auto-generated by Clamp. To generate it Clamp parses DCAE_INVENTORY_BLUEPRINT from CSAR distributed by SDC.
+ It Always consists of **VES -> <nodes from blueprint> -> OperationalPolicy**. Not all nodes are visualized. Only those with type **dcae.nodes.\***
+ |blueprint-node|
+
+#. Loop status
+ Visualizes status of opened loop.
+#. Loop logs
+ Table with log data of opened loop
+
+
+Control Loop properties
+-----------------------
+In Dublin release this view shows what are deployment parameters or control Loop.
+To open it from *Loop Instance* menu select *Properties*
+
+|clamp-menu-prop|
+
+This opens a box with JSON object. It contains deployment parameters extracted from DCAE_INVENTORY_BLUEPRINT.
+It's not recommended to edit this JSON. Each of this parameters should be available in view shown to deploy analytic application.
+
+|clamp-prop-box|
+
+
+Operational policy properties
+---------------------------------------
+Operational policies are added by the user using *Modify* window. The configuration view is generated using Policy Type assigned to selected operational policy.
+
+To configure operational policies, user has to click the corresponding operational policy boxes. Example popup dialog for operational policy looks like:
+
+|clamp-op-policy-box-policy|
+
+Operations and payload for CDS actor is fetched from CDS.
+Clamp receives CDS blueprint name and version information from sdnc_model_name and sdnc_model_version properties in CSAR distributed by SDC and queries CDS to get list of operations and payload for the corresponding CDS blueprint.
+
+|clamp-cds-operation|
+
+Micro-service policy properties
+-------------------------------
+Boxes between `VES` and `Operational Policies` are generated from blueprint. They can be one of ONAP predefined analytic microservices or custom analytics.
+Each of the boxes is clickable. Microservice configuration view is generated using Policy Type assigned to selected microservice.
+Clamp by default assumes that microservices have policy type **onap.policies.monitoring.cdap.tca.hi.lo.app**.
+
+After clicking microservice box Clamp opens popup dialog. Example popup dialog for microservice with default type looks like:
+
+|clamp-config-policy-tca|
+
+
+
+In the *Loop Operations* menu, lists the operations to be perform to the loop.
+
+|clamp-loop-operation-menu|
+
+
+Submitting the Control loop to core policy
+------------------------------------------
+The SUBMIT operation can be used to send the configuration to policy engine.
+If everything is successful, the status to the policy will become *SENT*. Clamp should also show proper logs in logs view.
+
+|clamp-policy-submitted|
+
+After Policies are submitted they should be visible in Policy PAP component.
+Please check `Policy GUI <https://docs.onap.org/en/dublin/submodules/policy/engine.git/docs/platform/policygui.html>`_
+
+
+Deploy/undeploy the Control Loop to DCAE
+-----------------------------------------
+Once sent to policy engine, Clamp can ask to DCAE to DEPLOY the micro service
+
+This opens a window where the parameters of the DCAE micro service can be configured/tuned.
+The policy_id is automatically generated by Clamp in the previous steps.
+
+|clamp-deploy-params|
+
+Once deployed on DCAE the status of DCAE goes to *MICROSERVICE_INSTALLED_SUCCESSFULLY*, it can then be Undeployed/Stopped/Restart.
+
+.. |clamp-template-menu| image:: images/user-guide/template-menu.png
+.. |clamp-policy-model-menu| image:: images/user-guide/policy-model-menu.png
+.. |clamp-loop-menu| image:: images/user-guide/loop-menu.png
+.. |clamp-create-loop| image:: images/user-guide/create-loop.png
+.. |clamp-open-loop| image:: images/user-guide/open-loop.png
+.. |clamp-add-operational-policies| image:: images/user-guide/add-operational-policies.png
+.. |clamp-remove-operational-policies| image:: images/user-guide/remove-operational-policies.png
+.. |clamp-opened-loop| image:: images/user-guide/opened-loop.png
+.. |clamp-menu-prop| image:: images/user-guide/open-menu-prop.png
+.. |clamp-prop-box| image:: images/user-guide/loop-properties.png
+.. |clamp-op-policy-box-policy| image:: images/user-guide/op-policy-box-policy.png
+.. |clamp-config-policy-tca| image:: images/user-guide/config-policy-tca.png
+.. |clamp-loop-operation-menu| image:: images/user-guide/loop-operation-menu.png
+.. |clamp-policy-submitted| image:: images/user-guide/policy-submitted.png
+.. |clamp-deploy-params| image:: images/user-guide/deploy-params.png
+.. |blueprint-node| image:: images/user-guide/blueprint_node_type.png
+.. |clamp-cds-operation| image:: images/user-guide/clamp-cds-operation.png
Code Review / policy / parent.git / commitdiff
