diff options
Diffstat (limited to 'docs/user-guide.rst')
| -rw-r--r-- | docs/user-guide.rst | 127 |
1 files changed, 87 insertions, 40 deletions
diff --git a/docs/user-guide.rst b/docs/user-guide.rst index dca5bb80f..ac45ebc42 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -2,78 +2,125 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -Open Closed loop in CLAMP -------------------------- -There is 2 closed loop levels in CLAMP: -- Closed loop template: This is created from the DCAE blueprint (designed in the DCAE designer), and distributed by SDC to CLAMP. -- Closed loop instance: Based on the template, it represents a physical closed loop in the platform related to a service and a VNF. - This is created in CLAMP when receiving the SDC notification, as this one is related to a specific service/vnf. - -There is no way to design a closed loop from scratch in CLAMP, you can only configure it and manage its life-cycle. +Control loop in CLAMP +--------------------- +There is 2 control loop levels in 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. + This is created in CLAMP when receiving the SDC notification, as this one is related to a specific service/vnf. + +There is no way to design a 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 open distributed closed loops in CLAMP UI. +There is a specific menu to open distributed control loops in CLAMP UI. |clamp-open-menu| -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 +Please note that the option "Create CL" can be used to create a control loop from the template distributed by SDC, you can therefore instantiate it for another service/vnf Once you click on "Open CL", this dialog box is shown |clamp-open-box| -Once the distributed closed loop has been chosen, the closed loop is shown to the user +Once the distributed control loop has been chosen, the control loop is shown to the user. +From this view user can start configure empty control loop using **Closed loop modeller**. |clamp-opened-closed-loop| -Closed Loop properties ----------------------- -You can check to which service/vnf the closed loop has been associated in SDC. +Closed 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 *Closed Loop* menu select *Properties CL* |clamp-menu-prop| -This opens a box that gives the properties set during the SDC notification deployment in CLAMP. -Do not change those settings +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 ------------------------------ -The box "policy" is clickable, so the operational policies can be defined. -By clicking on the button "New Policy", it's possible to add new operational policies that can chosen in the configuration policy. +Operational and Guard policy properties +--------------------------------------- +Operational policy is a parametrized drools (in Dublin) rule with logic performing action on resource. +User can't chose his own rule. Clamp always tries to create operational policy that bases on rule bind with **ClosedLoopControlName** attribute available in Policy dictionary. + +There is only one operational policy per control loop. More about operational policies can be found here `Control Loop Operational Policy <https://wiki.onap.org/display/DW/Control+Loop+Operational+Policy>`_. -|clamp-op-policy-box| +Guard policy is policy securing operational policy calls. It defines a set of constraints that have to be matched before running operational policy. +More about guard policies can be found here `Creating and Using Guard Policies <https://docs.onap.org/en/dublin/submodules/policy/engine.git/docs/platform/guardpolicy.html>`_. -Once clicked, it's possible to configure each operational policy that can also contain multiple "sub policies", one per Recipe +To configure operational and guard policy user has to click *OperationalPolicy* box. + +Once clicked, it's possible to configure operational policy. Policy can have child policies, one per Recipe. |clamp-op-policy-box-policy1| -Configuration policy properties +1. Parent policy name +2. Global time limit for this operational policies +3. Specifies whether policy is abated +4. Unique id for Control Loop. +5. Button for creating child/parent policies +6. Unique id of Policy. (Clamp internal) +7. Recipe/Operation triggered on controller/orchestrator +8. Maximum count of retries +9. Timeout for this operational policy +10. Actor used to perform action. (Orchestrator/Controller) +11. Payload required by actor to perform an action +12. Set of fields with policies called under certain conditions. E.g. when health-check receives timeout failure restart could be called. +13. Set of fields specifying resource. On this resource Operational Policy should perform an action +14. Checkbox enabling/disabling guard policy for this operational policy +15. Guard Policy type (frequency limited or min max) +16. Set of guard policy specific fields. Please check `Creating and Using Guard Policies <https://docs.onap.org/en/dublin/submodules/policy/engine.git/docs/platform/guardpolicy.html>`_. + + +Micro-service policy properties ------------------------------- -The box "tca" is clickable, so the TCA configuration policy can be defined. -In that popup dialog, multiple Thresholds can be defined, the operational policies defined previously can be chosen and set in the "Policy" field. - +Boxes between `VES` and `OperationalPolicy` 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-tca1| -Saving Closed loop ------------------- -Once all properties have been defined for all policies, the closed loop must be saved. +|clamp-config-policy-tca2| + -|clamp-save-cl| +Saving Control loop +------------------- +Policies are saved localy in Clamp after each configuration change -Submitting the Closed loop to policy ------------------------------------- + +Submitting the Control loop to policy +------------------------------------- In the "Manage Menu", the submit action can be used to send the configuration to policy engine. -The "Validation test" can be used to check the data configured in the closed loop without sending anything to policy engine. + |clamp-submit-cl| -If everything is successful, this changes the status to "Distributed" +If everything is successful, this changes the status to "Submitted". Clamp should also show proper logs in logs view. |clamp-distributed| -Deploy/undeploy the Closed loop to DCAE ---------------------------------------- +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 |clamp-deploy| @@ -83,7 +130,7 @@ The policy_id is automatically generated by Clamp in the previous steps. |clamp-deploy-params| -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) +Once deployed on DCAE the status Control loop status goes to ACTIVE, it can then be Undeployed/Stopped or even Updated (this is to push new policies on policy engine) |clamp-undeploy| @@ -92,12 +139,12 @@ Once deployed on DCAE the status Closed loop status goes to ACTIVE, it can then .. |clamp-opened-closed-loop| image:: images/user-guide/opened-closed-loop.png .. |clamp-menu-prop| image:: images/user-guide/open-menu-prop.png .. |clamp-prop-box| image:: images/user-guide/prop-box.png -.. |clamp-op-policy-box| image:: images/user-guide/op-policy-box.png .. |clamp-op-policy-box-policy1| image:: images/user-guide/op-policy-box-policy1.png .. |clamp-config-policy-tca1| image:: images/user-guide/config-policy-tca1.png -.. |clamp-save-cl| image:: images/user-guide/save-cl.png +.. |clamp-config-policy-tca2| image:: images/user-guide/config-policy-tca2.png .. |clamp-submit-cl| image:: images/user-guide/submit-menu.png .. |clamp-distributed| image:: images/user-guide/distributed.png .. |clamp-deploy| image:: images/user-guide/deploy.png .. |clamp-deploy-params| image:: images/user-guide/deploy-params.png -.. |clamp-undeploy| image:: images/user-guide/undeploy.png
\ No newline at end of file +.. |clamp-undeploy| image:: images/user-guide/undeploy.png +.. |blueprint-node| image:: images/user-guide/blueprint_node_type.png
\ No newline at end of file |