From 5dea22255fc131d5c2b0348986bfc75c56d17097 Mon Sep 17 00:00:00 2001 From: sebdet Date: Fri, 11 Jan 2019 13:11:03 +0100 Subject: Add user guide Add user guide to the ReadTheDoc pages, this is still a draft Issue-ID: CLAMP-257 Change-Id: I9b1feb9af3749b262ad42518110280b21df7e610 Signed-off-by: sebdet --- docs/images/user-guide/deploy-params.png | Bin 0 -> 222209 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/images/user-guide/deploy-params.png (limited to 'docs/images/user-guide/deploy-params.png') diff --git a/docs/images/user-guide/deploy-params.png b/docs/images/user-guide/deploy-params.png new file mode 100644 index 000000000..d51a41ac8 Binary files /dev/null and b/docs/images/user-guide/deploy-params.png differ -- cgit 1.2.3-korg From d3a57d9d71f9a24876153ac4448ae00712f3eb66 Mon Sep 17 00:00:00 2001 From: Krysiak Adam Date: Tue, 28 May 2019 15:35:09 +0200 Subject: updating documentation Issue-ID: CLAMP-394 Change-Id: Idf4afe6c4a580e73923ea5c396c0b00a33e7c160 Signed-off-by: Krysiak Adam --- docs/images/user-guide/blueprint_node_type.png | Bin 0 -> 65898 bytes docs/images/user-guide/config-policy-tca1.png | Bin 215133 -> 109172 bytes docs/images/user-guide/config-policy-tca2.png | Bin 0 -> 74271 bytes docs/images/user-guide/deploy-params.png | Bin 222209 -> 97245 bytes docs/images/user-guide/deploy.png | Bin 126562 -> 12329 bytes docs/images/user-guide/distributed.png | Bin 141030 -> 89578 bytes docs/images/user-guide/op-policy-box-policy1.png | Bin 186694 -> 173503 bytes docs/images/user-guide/op-policy-box.png | Bin 138868 -> 0 bytes docs/images/user-guide/open-box.png | Bin 135943 -> 40699 bytes docs/images/user-guide/open-menu-prop.png | Bin 260489 -> 46358 bytes docs/images/user-guide/open-menu.png | Bin 102693 -> 35423 bytes docs/images/user-guide/opened-closed-loop.png | Bin 168886 -> 48148 bytes docs/images/user-guide/prop-box.png | Bin 114725 -> 91272 bytes docs/images/user-guide/submit-menu.png | Bin 149394 -> 14076 bytes docs/user-guide.rst | 91 +++++++++++++++++------ 15 files changed, 69 insertions(+), 22 deletions(-) create mode 100644 docs/images/user-guide/blueprint_node_type.png create mode 100644 docs/images/user-guide/config-policy-tca2.png delete mode 100644 docs/images/user-guide/op-policy-box.png (limited to 'docs/images/user-guide/deploy-params.png') diff --git a/docs/images/user-guide/blueprint_node_type.png b/docs/images/user-guide/blueprint_node_type.png new file mode 100644 index 000000000..1e5ef6a4a Binary files /dev/null and b/docs/images/user-guide/blueprint_node_type.png differ diff --git a/docs/images/user-guide/config-policy-tca1.png b/docs/images/user-guide/config-policy-tca1.png index 032bc9a2e..47c096d28 100644 Binary files a/docs/images/user-guide/config-policy-tca1.png and b/docs/images/user-guide/config-policy-tca1.png differ diff --git a/docs/images/user-guide/config-policy-tca2.png b/docs/images/user-guide/config-policy-tca2.png new file mode 100644 index 000000000..cf1157bec Binary files /dev/null and b/docs/images/user-guide/config-policy-tca2.png differ diff --git a/docs/images/user-guide/deploy-params.png b/docs/images/user-guide/deploy-params.png index d51a41ac8..aeafb8e3e 100644 Binary files a/docs/images/user-guide/deploy-params.png and b/docs/images/user-guide/deploy-params.png differ diff --git a/docs/images/user-guide/deploy.png b/docs/images/user-guide/deploy.png index 8f12aa1b6..2ec86cc8e 100644 Binary files a/docs/images/user-guide/deploy.png and b/docs/images/user-guide/deploy.png differ diff --git a/docs/images/user-guide/distributed.png b/docs/images/user-guide/distributed.png index 4a765a994..540168a5c 100644 Binary files a/docs/images/user-guide/distributed.png and b/docs/images/user-guide/distributed.png differ diff --git a/docs/images/user-guide/op-policy-box-policy1.png b/docs/images/user-guide/op-policy-box-policy1.png index ffd9733bd..1143fa212 100644 Binary files a/docs/images/user-guide/op-policy-box-policy1.png and b/docs/images/user-guide/op-policy-box-policy1.png differ diff --git a/docs/images/user-guide/op-policy-box.png b/docs/images/user-guide/op-policy-box.png deleted file mode 100644 index 107d2670d..000000000 Binary files a/docs/images/user-guide/op-policy-box.png and /dev/null differ diff --git a/docs/images/user-guide/open-box.png b/docs/images/user-guide/open-box.png index d38cdb4cf..9d7c6ff0c 100644 Binary files a/docs/images/user-guide/open-box.png and b/docs/images/user-guide/open-box.png differ diff --git a/docs/images/user-guide/open-menu-prop.png b/docs/images/user-guide/open-menu-prop.png index f8d6438b9..57c0f2d0d 100644 Binary files a/docs/images/user-guide/open-menu-prop.png and b/docs/images/user-guide/open-menu-prop.png differ diff --git a/docs/images/user-guide/open-menu.png b/docs/images/user-guide/open-menu.png index 8ca5e86f1..2ea4f5ee0 100644 Binary files a/docs/images/user-guide/open-menu.png and b/docs/images/user-guide/open-menu.png differ diff --git a/docs/images/user-guide/opened-closed-loop.png b/docs/images/user-guide/opened-closed-loop.png index ea854c427..01a3f4e0d 100644 Binary files a/docs/images/user-guide/opened-closed-loop.png and b/docs/images/user-guide/opened-closed-loop.png differ diff --git a/docs/images/user-guide/prop-box.png b/docs/images/user-guide/prop-box.png index 54027b4fa..52879f996 100644 Binary files a/docs/images/user-guide/prop-box.png and b/docs/images/user-guide/prop-box.png differ diff --git a/docs/images/user-guide/submit-menu.png b/docs/images/user-guide/submit-menu.png index 641055e2f..9d07f4e85 100644 Binary files a/docs/images/user-guide/submit-menu.png and b/docs/images/user-guide/submit-menu.png differ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index dca5bb80f..cc86c48bb 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -2,12 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -Open Closed loop in CLAMP +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. + 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. For more info on how to design the service in SDC, check this: https://wiki.onap.org/display/DW/CLAMP+videos#CLAMPvideos-DesignpartinSDC @@ -22,56 +23,102 @@ 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 closed loop has been chosen, the closed loop is shown to the user. +From this view user can start configure empty closed loop using **Closed loop modeller**. |clamp-opened-closed-loop| +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 -> -> 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 + Closed Loop properties ---------------------- -You can check to which service/vnf the closed loop has been associated in SDC. +In Dublin release this view shows what are deployment parameters or Closed 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 +Operational and Guard 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 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 closed loop. More about operational policies can be found here `Control Loop Operational Policy `_. + +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 `_. -|clamp-op-policy-box| +To configure operational and guard policy user has to click *OperationalPolicy* box. -Once clicked, it's possible to configure each operational policy that can also contain multiple "sub policies", one per Recipe +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 `_. + + +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| +|clamp-config-policy-tca2| + + Saving Closed loop ------------------ -Once all properties have been defined for all policies, the closed loop must be saved. +Policies are saved localy in Clamp after each configuration change -|clamp-save-cl| Submitting the Closed 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| +After Policies are submitted they should be visible in Policy PAP component. +Please check `Policy GUI `_ + Deploy/undeploy the Closed loop to DCAE --------------------------------------- Once sent to policy engine, Clamp can ask to DCAE to deploy the micro service @@ -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 -- cgit 1.2.3-korg From fe947238182cc1f0c962dc21938325a50a741c10 Mon Sep 17 00:00:00 2001 From: xuegao Date: Tue, 31 Mar 2020 08:37:02 +0200 Subject: Update docs UPdate the user guide based on the Frankfurt release. Issue-ID: CLAMP-663 Change-Id: I3f10dbd8ccaec63de815df1977eebb71c3c398cc Signed-off-by: xuegao --- .../images/user-guide/add-operational-policies.png | Bin 0 -> 115060 bytes docs/images/user-guide/blueprint_node_type.png | Bin docs/images/user-guide/config-policy-tca.png | Bin 0 -> 49477 bytes docs/images/user-guide/config-policy-tca1.png | Bin 109172 -> 0 bytes docs/images/user-guide/config-policy-tca2.png | Bin 74271 -> 0 bytes docs/images/user-guide/create-loop.png | Bin 0 -> 46065 bytes docs/images/user-guide/deploy-params.png | Bin 97245 -> 45138 bytes docs/images/user-guide/deploy.png | Bin 12329 -> 0 bytes docs/images/user-guide/distributed.png | Bin 89578 -> 0 bytes docs/images/user-guide/loop-menu.png | Bin 0 -> 43472 bytes docs/images/user-guide/loop-operation-menu.png | Bin 0 -> 116408 bytes docs/images/user-guide/loop-properties.png | Bin 0 -> 43060 bytes docs/images/user-guide/op-policy-box-policy.png | Bin 0 -> 67750 bytes docs/images/user-guide/op-policy-box-policy1.png | Bin 173503 -> 0 bytes docs/images/user-guide/open-box.png | Bin 40699 -> 0 bytes docs/images/user-guide/open-loop.png | Bin 0 -> 42481 bytes docs/images/user-guide/open-menu-prop.png | Bin 46358 -> 37343 bytes docs/images/user-guide/open-menu.png | Bin 35423 -> 0 bytes docs/images/user-guide/opened-closed-loop.png | Bin 48148 -> 0 bytes docs/images/user-guide/opened-loop.png | Bin 0 -> 104515 bytes docs/images/user-guide/policy-model-menu.png | Bin 0 -> 43925 bytes docs/images/user-guide/policy-submitted.png | Bin 0 -> 47028 bytes docs/images/user-guide/prop-box.png | Bin 91272 -> 0 bytes .../user-guide/remove-operational-policies.png | Bin 0 -> 108698 bytes docs/images/user-guide/save-cl.png | Bin 139066 -> 0 bytes docs/images/user-guide/submit-menu.png | Bin 14076 -> 0 bytes docs/images/user-guide/template-menu.png | Bin 0 -> 39685 bytes docs/images/user-guide/undeploy.png | Bin 117598 -> 0 bytes docs/user-guide.rst | 179 +++++++++------------ 29 files changed, 80 insertions(+), 99 deletions(-) create mode 100644 docs/images/user-guide/add-operational-policies.png mode change 100644 => 100755 docs/images/user-guide/blueprint_node_type.png create mode 100755 docs/images/user-guide/config-policy-tca.png delete mode 100644 docs/images/user-guide/config-policy-tca1.png delete mode 100644 docs/images/user-guide/config-policy-tca2.png create mode 100644 docs/images/user-guide/create-loop.png mode change 100644 => 100755 docs/images/user-guide/deploy-params.png delete mode 100644 docs/images/user-guide/deploy.png delete mode 100644 docs/images/user-guide/distributed.png create mode 100644 docs/images/user-guide/loop-menu.png create mode 100644 docs/images/user-guide/loop-operation-menu.png create mode 100644 docs/images/user-guide/loop-properties.png create mode 100755 docs/images/user-guide/op-policy-box-policy.png delete mode 100644 docs/images/user-guide/op-policy-box-policy1.png delete mode 100644 docs/images/user-guide/open-box.png create mode 100644 docs/images/user-guide/open-loop.png mode change 100644 => 100755 docs/images/user-guide/open-menu-prop.png delete mode 100644 docs/images/user-guide/open-menu.png delete mode 100644 docs/images/user-guide/opened-closed-loop.png create mode 100644 docs/images/user-guide/opened-loop.png create mode 100644 docs/images/user-guide/policy-model-menu.png create mode 100755 docs/images/user-guide/policy-submitted.png delete mode 100644 docs/images/user-guide/prop-box.png create mode 100644 docs/images/user-guide/remove-operational-policies.png delete mode 100644 docs/images/user-guide/save-cl.png delete mode 100644 docs/images/user-guide/submit-menu.png create mode 100644 docs/images/user-guide/template-menu.png delete mode 100644 docs/images/user-guide/undeploy.png (limited to 'docs/images/user-guide/deploy-params.png') diff --git a/docs/images/user-guide/add-operational-policies.png b/docs/images/user-guide/add-operational-policies.png new file mode 100644 index 000000000..3d5224aec Binary files /dev/null and b/docs/images/user-guide/add-operational-policies.png differ diff --git a/docs/images/user-guide/blueprint_node_type.png b/docs/images/user-guide/blueprint_node_type.png old mode 100644 new mode 100755 diff --git a/docs/images/user-guide/config-policy-tca.png b/docs/images/user-guide/config-policy-tca.png new file mode 100755 index 000000000..ce5f79bc8 Binary files /dev/null and b/docs/images/user-guide/config-policy-tca.png differ diff --git a/docs/images/user-guide/config-policy-tca1.png b/docs/images/user-guide/config-policy-tca1.png deleted file mode 100644 index 47c096d28..000000000 Binary files a/docs/images/user-guide/config-policy-tca1.png and /dev/null differ diff --git a/docs/images/user-guide/config-policy-tca2.png b/docs/images/user-guide/config-policy-tca2.png deleted file mode 100644 index cf1157bec..000000000 Binary files a/docs/images/user-guide/config-policy-tca2.png and /dev/null differ diff --git a/docs/images/user-guide/create-loop.png b/docs/images/user-guide/create-loop.png new file mode 100644 index 000000000..20b9f05d0 Binary files /dev/null and b/docs/images/user-guide/create-loop.png differ diff --git a/docs/images/user-guide/deploy-params.png b/docs/images/user-guide/deploy-params.png old mode 100644 new mode 100755 index aeafb8e3e..9d003258f Binary files a/docs/images/user-guide/deploy-params.png and b/docs/images/user-guide/deploy-params.png differ diff --git a/docs/images/user-guide/deploy.png b/docs/images/user-guide/deploy.png deleted file mode 100644 index 2ec86cc8e..000000000 Binary files a/docs/images/user-guide/deploy.png and /dev/null differ diff --git a/docs/images/user-guide/distributed.png b/docs/images/user-guide/distributed.png deleted file mode 100644 index 540168a5c..000000000 Binary files a/docs/images/user-guide/distributed.png and /dev/null differ diff --git a/docs/images/user-guide/loop-menu.png b/docs/images/user-guide/loop-menu.png new file mode 100644 index 000000000..658359e02 Binary files /dev/null and b/docs/images/user-guide/loop-menu.png differ diff --git a/docs/images/user-guide/loop-operation-menu.png b/docs/images/user-guide/loop-operation-menu.png new file mode 100644 index 000000000..2a2dbf899 Binary files /dev/null and b/docs/images/user-guide/loop-operation-menu.png differ diff --git a/docs/images/user-guide/loop-properties.png b/docs/images/user-guide/loop-properties.png new file mode 100644 index 000000000..5c266155d Binary files /dev/null and b/docs/images/user-guide/loop-properties.png differ diff --git a/docs/images/user-guide/op-policy-box-policy.png b/docs/images/user-guide/op-policy-box-policy.png new file mode 100755 index 000000000..89c6265ba Binary files /dev/null and b/docs/images/user-guide/op-policy-box-policy.png differ diff --git a/docs/images/user-guide/op-policy-box-policy1.png b/docs/images/user-guide/op-policy-box-policy1.png deleted file mode 100644 index 1143fa212..000000000 Binary files a/docs/images/user-guide/op-policy-box-policy1.png and /dev/null differ diff --git a/docs/images/user-guide/open-box.png b/docs/images/user-guide/open-box.png deleted file mode 100644 index 9d7c6ff0c..000000000 Binary files a/docs/images/user-guide/open-box.png and /dev/null differ diff --git a/docs/images/user-guide/open-loop.png b/docs/images/user-guide/open-loop.png new file mode 100644 index 000000000..a763ad133 Binary files /dev/null and b/docs/images/user-guide/open-loop.png differ diff --git a/docs/images/user-guide/open-menu-prop.png b/docs/images/user-guide/open-menu-prop.png old mode 100644 new mode 100755 index 57c0f2d0d..c07b2256a Binary files a/docs/images/user-guide/open-menu-prop.png and b/docs/images/user-guide/open-menu-prop.png differ diff --git a/docs/images/user-guide/open-menu.png b/docs/images/user-guide/open-menu.png deleted file mode 100644 index 2ea4f5ee0..000000000 Binary files a/docs/images/user-guide/open-menu.png and /dev/null differ diff --git a/docs/images/user-guide/opened-closed-loop.png b/docs/images/user-guide/opened-closed-loop.png deleted file mode 100644 index 01a3f4e0d..000000000 Binary files a/docs/images/user-guide/opened-closed-loop.png and /dev/null differ diff --git a/docs/images/user-guide/opened-loop.png b/docs/images/user-guide/opened-loop.png new file mode 100644 index 000000000..c955deee8 Binary files /dev/null and b/docs/images/user-guide/opened-loop.png differ diff --git a/docs/images/user-guide/policy-model-menu.png b/docs/images/user-guide/policy-model-menu.png new file mode 100644 index 000000000..838fcf8d9 Binary files /dev/null and b/docs/images/user-guide/policy-model-menu.png differ diff --git a/docs/images/user-guide/policy-submitted.png b/docs/images/user-guide/policy-submitted.png new file mode 100755 index 000000000..04a9df358 Binary files /dev/null and b/docs/images/user-guide/policy-submitted.png differ diff --git a/docs/images/user-guide/prop-box.png b/docs/images/user-guide/prop-box.png deleted file mode 100644 index 52879f996..000000000 Binary files a/docs/images/user-guide/prop-box.png and /dev/null differ diff --git a/docs/images/user-guide/remove-operational-policies.png b/docs/images/user-guide/remove-operational-policies.png new file mode 100644 index 000000000..fbc680d04 Binary files /dev/null and b/docs/images/user-guide/remove-operational-policies.png differ diff --git a/docs/images/user-guide/save-cl.png b/docs/images/user-guide/save-cl.png deleted file mode 100644 index 7e0439d1c..000000000 Binary files a/docs/images/user-guide/save-cl.png and /dev/null differ diff --git a/docs/images/user-guide/submit-menu.png b/docs/images/user-guide/submit-menu.png deleted file mode 100644 index 9d07f4e85..000000000 Binary files a/docs/images/user-guide/submit-menu.png and /dev/null differ diff --git a/docs/images/user-guide/template-menu.png b/docs/images/user-guide/template-menu.png new file mode 100644 index 000000000..cc2cdf78b Binary files /dev/null and b/docs/images/user-guide/template-menu.png differ diff --git a/docs/images/user-guide/undeploy.png b/docs/images/user-guide/undeploy.png deleted file mode 100644 index c17fa89ee..000000000 Binary files a/docs/images/user-guide/undeploy.png and /dev/null differ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 0d7d4e619..bfac885dc 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -4,31 +4,63 @@ Control loop in CLAMP --------------------- -There is 2 control loop levels in CLAMP: +There are 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. +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 open distributed control loops in CLAMP UI. -|clamp-open-menu| +There is a specific menu to view the available Control loop templates. -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 +|clamp-template-menu| -Once you click on "Open CL", this dialog box is shown -|clamp-open-box| +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. -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-policy-model-menu| -|clamp-opened-closed-loop| -Closed loop modeler has 3 main parts: +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. @@ -40,133 +72,82 @@ Closed loop modeler has 3 main parts: #. 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* +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 and Guard policy properties + +Operational 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 `_. - -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 `_. - -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| - -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 - Child/parent policies are policies that depend on one another under certain circumstances (check point 12.) -6. Unique id of Policy. (Clamp internal) -7. Recipe/Operation triggered on controller/orchestrator - This recipe will be used by policy drools PDP when sending request to controller/orchestrator. - E.g. in case of *Health-Check* is selected here and *APPC* as actor PDP will trigger APPC LCM API triggering health-check operation. - - List of options is predefined in Clamp code and can't be modified. - Possible options: - * Restart - * Rebuild - * Migrate - * Health-Check - * ModifyConfig - * VF Module Create - * VF Module Delete - * Reroute -8. Maximum amount of retries that policy takes when triggering action -9. Timeout for this operational policy -10. Actor used to perform action. (Orchestrator/Controller) - Actor that will be used by drools PDP to perform action. - Possible options: - * APPC - * SO - * VFC - * SDNC - * SDNR -11. Payload required by actor to perform an action -12. Set of fields describing child/parend policies dependency. - 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 `_. +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| + Micro-service policy properties ------------------------------- -Boxes between `VES` and `OperationalPolicy` are generated from blueprint. They can be one of ONAP predefined analytic microservices or custom analytics. +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-tca1| +|clamp-config-policy-tca| + -|clamp-config-policy-tca2| +In the *Loop Operations* menu, lists the operations to be perform to the loop. -Saving Control loop -------------------- -Policies are saved localy in Clamp after each configuration change +|clamp-loop-operation-menu| Submitting the Control loop to policy ------------------------------------- -In the "Manage Menu", the submit action can be used to send the configuration to policy engine. - - -|clamp-submit-cl| +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. -If everything is successful, this changes the status to "Submitted". Clamp should also show proper logs in logs view. - -|clamp-distributed| +|clamp-policy-submitted| After Policies are submitted they should be visible in Policy PAP component. Please check `Policy GUI `_ -Deploy/undeploy the Control Loop to DCAE ------------------------------------------ -Once sent to policy engine, Clamp can ask to DCAE to deploy the micro service -|clamp-deploy| +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 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| +Once deployed on DCAE the status of DCAE goes to *MICROSERVICE_INSTALLED_SUCCESSFULLY*, it can then be Undeployed/Stopped/Restart. -.. |clamp-open-menu| image:: images/user-guide/open-menu.png -.. |clamp-open-box| image:: images/user-guide/open-box.png -.. |clamp-opened-closed-loop| image:: images/user-guide/opened-closed-loop.png +.. |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/prop-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-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-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 -.. |clamp-undeploy| image:: images/user-guide/undeploy.png -.. |blueprint-node| image:: images/user-guide/blueprint_node_type.png \ No newline at end of file +.. |blueprint-node| image:: images/user-guide/blueprint_node_type.png -- cgit 1.2.3-korg