docs/user-guide.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
   5 Control loop in CLAMP
   6 ---------------------
   7 There are 2 control loop levels in CLAMP:
   8
   9 - Control loop template: This is created from the DCAE blueprint (designed in the DCAE designer), and distributed by SDC to CLAMP.
  10 - Control loop instance: Based on the template, it represents a physical control loop in the platform related to a service and a VNF.
  11
  12 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.
  13 For more info on how to design the service in SDC, check this: https://wiki.onap.org/display/DW/CLAMP+videos#CLAMPvideos-DesignpartinSDC
  14
  15
  16 There is a specific menu to view the available Control loop templates.
  17
  18 |clamp-template-menu|
  19
  20
  21 Each microservice policies and operational policies is related to a Policy Model.
  22 Clamp either communicates with Policy Engine periodically to download the available Policy Models automatically or user can upload the Policy Model manually.
  23 Policy Models related operations could be found under Policy Models menu.
  24
  25 |clamp-policy-model-menu|
  26
  27
  28 Under the menu *Loop Instance*, there's a list of actions to perform regarding to the loops.
  29
  30 |clamp-loop-menu|
  31
  32
  33 Option *Create* creates the loop from the templates distributed by SDC.
  34
  35 |clamp-create-loop|
  36
  37
  38 Option *Open* opens the saved loops. Once the distributed control loop has been chosen, the control loop is shown to the user.
  39
  40 |clamp-open-loop|
  41
  42
  43 Option *Close* will close the current opened loop.
  44
  45
  46 Option *Modify* opens the window to add/remove different Operational Policies to the loop.
  47 Tab *Add Operational Policies* lists all the available operational policies.
  48 Click *Add* button to add the selected operational policies to the loop.
  49
  50 |clamp-add-operational-policies|
  51
  52 Tab *Remove Operational Policies* lists all the operational policies added to the loop.
  53 Click *Remove* button to remove the selected operational policies from the loop.
  54
  55 |clamp-remove-operational-policies|
  56
  57
  58 Once opened, the user can start configure empty control loop using **Closed loop modeller**.
  59
  60 |clamp-opened-loop|
  61
  62
  63 Loop modeler has 3 main parts:
  64
  65 #. Loop configuration view
  66     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.
  67     It Always consists of **VES -> <nodes from blueprint> -> OperationalPolicy**. Not all nodes are visualized. Only those with type **dcae.nodes.\***
  68     |blueprint-node|
  69
  70 #. Loop status
  71     Visualizes status of opened loop.
  72 #. Loop logs
  73     Table with log data of opened loop
  74
  75
  76 Control Loop properties
  77 -----------------------
  78 In Dublin release this view shows what are deployment parameters or control Loop.
  79 To open it from *Loop Instance* menu select *Properties*
  80
  81 |clamp-menu-prop|
  82
  83 This opens a box with JSON object. It contains deployment parameters extracted from DCAE_INVENTORY_BLUEPRINT.
  84 It's not recommended to edit this JSON. Each of this parameters should be available in view shown to deploy analytic application.
  85
  86 |clamp-prop-box|
  87
  88
  89 Operational policy properties
  90 ---------------------------------------
  91 Operational policies are added by the user using *Modify* window. The configuration view is generated using Policy Type assigned to selected operational policy.
  92
  93 To configure operational policies, user has to click the corresponding operational policy boxes. Example popup dialog for operational policy looks like:
  94
  95 |clamp-op-policy-box-policy|
  96
  97 Operations and payload for CDS actor is fetched from CDS.
  98 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.
  99
 100 |clamp-cds-operation|
 101
 102 Micro-service policy properties
 103 -------------------------------
 104 Boxes between `VES` and `Operational Policies` are generated from blueprint. They can be one of ONAP predefined analytic microservices or custom analytics.
 105 Each of the boxes is clickable. Microservice configuration view is generated using Policy Type assigned to selected microservice.
 106 Clamp by default assumes that microservices have policy type **onap.policies.monitoring.cdap.tca.hi.lo.app**.
 107
 108 After clicking microservice box Clamp opens popup dialog. Example popup dialog for microservice with default type looks like:
 109
 110 |clamp-config-policy-tca|
 111
 112
 113
 114 In the *Loop Operations* menu, lists the operations to be perform to the loop.
 115
 116 |clamp-loop-operation-menu|
 117
 118
 119 Submitting the Control loop to policy
 120 -------------------------------------
 121 The SUBMIT operation can be used to send the configuration to policy engine.
 122 If everything is successful, the status to the policy will become *SENT*. Clamp should also show proper logs in logs view.
 123
 124 |clamp-policy-submitted|
 125
 126 After Policies are submitted they should be visible in Policy PAP component.
 127 Please check  `Policy GUI <https://docs.onap.org/en/dublin/submodules/policy/engine.git/docs/platform/policygui.html>`_
 128
 129
 130 Deploy/undeploy the Control Loop to DCAE
 131 -----------------------------------------
 132 Once sent to policy engine, Clamp can ask to DCAE to DEPLOY the micro service
 133
 134 This opens a window where the parameters of the DCAE micro service can be configured/tuned.
 135 The policy_id is automatically generated by Clamp in the previous steps.
 136
 137 |clamp-deploy-params|
 138
 139 Once deployed on DCAE the status of DCAE goes to *MICROSERVICE_INSTALLED_SUCCESSFULLY*, it can then be Undeployed/Stopped/Restart.
 140
 141 .. |clamp-template-menu| image:: images/user-guide/template-menu.png
 142 .. |clamp-policy-model-menu| image:: images/user-guide/policy-model-menu.png
 143 .. |clamp-loop-menu| image:: images/user-guide/loop-menu.png
 144 .. |clamp-create-loop| image:: images/user-guide/create-loop.png
 145 .. |clamp-open-loop| image:: images/user-guide/open-loop.png
 146 .. |clamp-add-operational-policies| image:: images/user-guide/add-operational-policies.png
 147 .. |clamp-remove-operational-policies| image:: images/user-guide/remove-operational-policies.png
 148 .. |clamp-opened-loop| image:: images/user-guide/opened-loop.png
 149 .. |clamp-menu-prop| image:: images/user-guide/open-menu-prop.png
 150 .. |clamp-prop-box| image:: images/user-guide/loop-properties.png
 151 .. |clamp-op-policy-box-policy| image:: images/user-guide/op-policy-box-policy.png
 152 .. |clamp-config-policy-tca| image:: images/user-guide/config-policy-tca.png
 153 .. |clamp-loop-operation-menu| image:: images/user-guide/loop-operation-menu.png
 154 .. |clamp-policy-submitted| image:: images/user-guide/policy-submitted.png
 155 .. |clamp-deploy-params| image:: images/user-guide/deploy-params.png
 156 .. |blueprint-node| image:: images/user-guide/blueprint_node_type.png
 157 .. |clamp-cds-operation| image:: images/user-guide/clamp-cds-operation.png