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 Open Closed loop in CLAMP
   6 -------------------------
   7 There is 2 closed loop levels in CLAMP:
   8 - Closed loop template: This is created from the DCAE blueprint (designed in the DCAE designer), and distributed by SDC to CLAMP.
   9 - Closed loop instance: Based on the template, it represents a physical closed loop in the platform related to a service and a VNF.
  10         This is created in CLAMP when receiving the SDC notification, as this one is related to a specific service/vnf.
  11
  12 There is no way to design a closed 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 There is a specific menu to open distributed closed loops in CLAMP UI.
  16
  17 |clamp-open-menu|
  18
  19 Please note that the option "Create CL" can be used to create a closed loop from the template distributed by SDC, you can therefore instantiate it for another service/vnf
  20
  21 Once you click on "Open CL", this dialog box is shown
  22
  23 |clamp-open-box|
  24
  25 Once the distributed closed loop has been chosen, the closed loop is shown to the user
  26
  27 |clamp-opened-closed-loop|
  28
  29 Closed Loop properties
  30 ----------------------
  31 You can check to which service/vnf the closed loop has been associated in SDC.
  32
  33 |clamp-menu-prop|
  34
  35 This opens a box that gives the properties set during the SDC notification deployment in CLAMP.
  36 Do not change those settings
  37
  38 |clamp-prop-box|
  39
  40 Operational policy properties
  41 -----------------------------
  42 The box "policy" is clickable, so the operational policies can be defined.
  43 By clicking on the button "New Policy", it's possible to add new operational policies that can chosen in the configuration policy.
  44
  45 |clamp-op-policy-box|
  46
  47 Once clicked, it's possible to configure each operational policy that can also contain multiple "sub policies", one per Recipe
  48
  49 |clamp-op-policy-box-policy1|
  50
  51 Configuration policy properties
  52 -------------------------------
  53 The box "tca" is clickable, so the TCA configuration policy can be defined.
  54 In that popup dialog, multiple Thresholds can be defined, the operational policies defined previously can be chosen and set in the "Policy" field.
  55
  56 |clamp-config-policy-tca1|
  57
  58 Saving Closed loop
  59 ------------------
  60 Once all properties have been defined for all policies, the closed loop must be saved.
  61
  62 |clamp-save-cl|
  63
  64 Submitting the Closed loop to policy
  65 ------------------------------------
  66 In the "Manage Menu", the submit action can be used to send the configuration to policy engine.
  67 The "Validation test" can be used to check the data configured in the closed loop without sending anything to policy engine.
  68
  69 |clamp-submit-cl|
  70
  71 If everything is successful, this changes the status to "Distributed"
  72
  73 |clamp-distributed|
  74
  75 Deploy/undeploy the Closed loop to DCAE
  76 ---------------------------------------
  77 Once sent to policy engine, Clamp can ask to DCAE to deploy the micro service
  78
  79 |clamp-deploy|
  80
  81 This opens a window where the parameters of the DCAE micro service can be configured/tuned.
  82 The policy_id is automatically generated by Clamp in the previous steps.
  83
  84 |clamp-deploy-params|
  85
  86 Once deployed on DCAE the status Closed loop status goes to ACTIVE, it can then be Undeployed/Stopped or even Updated (this is to push new policies on policy engine)
  87
  88 |clamp-undeploy|
  89
  90 .. |clamp-open-menu| image:: images/user-guide/open-menu.png
  91 .. |clamp-open-box| image:: images/user-guide/open-box.png
  92 .. |clamp-opened-closed-loop| image:: images/user-guide/opened-closed-loop.png
  93 .. |clamp-menu-prop| image:: images/user-guide/open-menu-prop.png
  94 .. |clamp-prop-box| image:: images/user-guide/prop-box.png
  95 .. |clamp-op-policy-box| image:: images/user-guide/op-policy-box.png
  96 .. |clamp-op-policy-box-policy1| image:: images/user-guide/op-policy-box-policy1.png
  97 .. |clamp-config-policy-tca1| image:: images/user-guide/config-policy-tca1.png
  98 .. |clamp-save-cl| image:: images/user-guide/save-cl.png
  99 .. |clamp-submit-cl| image:: images/user-guide/submit-menu.png
 100 .. |clamp-distributed| image:: images/user-guide/distributed.png
 101 .. |clamp-deploy| image:: images/user-guide/deploy.png
 102 .. |clamp-deploy-params| image:: images/user-guide/deploy-params.png
 103 .. |clamp-undeploy| image:: images/user-guide/undeploy.png