diff options
Diffstat (limited to 'docs')
20 files changed, 117 insertions, 5 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index e526fb064..fc9e6c322 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -39,6 +39,6 @@ operational costs compared to traditional methods. |closed-loop| -.. |clamp-flow| image:: images/distdepl.png -.. |dashboard-flow| image:: images/monitoring.png -.. |closed-loop| image:: images/ONAP-closedloop.png
\ No newline at end of file +.. |clamp-flow| image:: images/architecture/distdepl.png +.. |dashboard-flow| image:: images/architecture/monitoring.png +.. |closed-loop| image:: images/architecture/ONAP-closedloop.png
\ No newline at end of file diff --git a/docs/images/ONAP-closedloop.png b/docs/images/architecture/ONAP-closedloop.png Binary files differindex 7d3a2cac8..7d3a2cac8 100644 --- a/docs/images/ONAP-closedloop.png +++ b/docs/images/architecture/ONAP-closedloop.png diff --git a/docs/images/distdepl.png b/docs/images/architecture/distdepl.png Binary files differindex 5593f4986..5593f4986 100755..100644 --- a/docs/images/distdepl.png +++ b/docs/images/architecture/distdepl.png diff --git a/docs/images/monitoring.png b/docs/images/architecture/monitoring.png Binary files differindex 6dbf75e45..6dbf75e45 100755..100644 --- a/docs/images/monitoring.png +++ b/docs/images/architecture/monitoring.png diff --git a/docs/images/user-guide/config-policy-tca1.png b/docs/images/user-guide/config-policy-tca1.png Binary files differnew file mode 100644 index 000000000..032bc9a2e --- /dev/null +++ b/docs/images/user-guide/config-policy-tca1.png diff --git a/docs/images/user-guide/deploy-params.png b/docs/images/user-guide/deploy-params.png Binary files differnew file mode 100644 index 000000000..d51a41ac8 --- /dev/null +++ b/docs/images/user-guide/deploy-params.png diff --git a/docs/images/user-guide/deploy.png b/docs/images/user-guide/deploy.png Binary files differnew file mode 100644 index 000000000..8f12aa1b6 --- /dev/null +++ b/docs/images/user-guide/deploy.png diff --git a/docs/images/user-guide/distributed.png b/docs/images/user-guide/distributed.png Binary files differnew file mode 100644 index 000000000..4a765a994 --- /dev/null +++ b/docs/images/user-guide/distributed.png diff --git a/docs/images/user-guide/op-policy-box-policy1.png b/docs/images/user-guide/op-policy-box-policy1.png Binary files differnew file mode 100644 index 000000000..ffd9733bd --- /dev/null +++ b/docs/images/user-guide/op-policy-box-policy1.png diff --git a/docs/images/user-guide/op-policy-box.png b/docs/images/user-guide/op-policy-box.png Binary files differnew file mode 100644 index 000000000..107d2670d --- /dev/null +++ b/docs/images/user-guide/op-policy-box.png diff --git a/docs/images/user-guide/open-box.png b/docs/images/user-guide/open-box.png Binary files differnew file mode 100644 index 000000000..d38cdb4cf --- /dev/null +++ b/docs/images/user-guide/open-box.png diff --git a/docs/images/user-guide/open-menu-prop.png b/docs/images/user-guide/open-menu-prop.png Binary files differnew file mode 100644 index 000000000..f8d6438b9 --- /dev/null +++ b/docs/images/user-guide/open-menu-prop.png diff --git a/docs/images/user-guide/open-menu.png b/docs/images/user-guide/open-menu.png Binary files differnew file mode 100644 index 000000000..8ca5e86f1 --- /dev/null +++ b/docs/images/user-guide/open-menu.png diff --git a/docs/images/user-guide/opened-closed-loop.png b/docs/images/user-guide/opened-closed-loop.png Binary files differnew file mode 100644 index 000000000..ea854c427 --- /dev/null +++ b/docs/images/user-guide/opened-closed-loop.png diff --git a/docs/images/user-guide/prop-box.png b/docs/images/user-guide/prop-box.png Binary files differnew file mode 100644 index 000000000..54027b4fa --- /dev/null +++ b/docs/images/user-guide/prop-box.png diff --git a/docs/images/user-guide/save-cl.png b/docs/images/user-guide/save-cl.png Binary files differnew file mode 100644 index 000000000..7e0439d1c --- /dev/null +++ b/docs/images/user-guide/save-cl.png diff --git a/docs/images/user-guide/submit-menu.png b/docs/images/user-guide/submit-menu.png Binary files differnew file mode 100644 index 000000000..641055e2f --- /dev/null +++ b/docs/images/user-guide/submit-menu.png diff --git a/docs/images/user-guide/undeploy.png b/docs/images/user-guide/undeploy.png Binary files differnew file mode 100644 index 000000000..c17fa89ee --- /dev/null +++ b/docs/images/user-guide/undeploy.png diff --git a/docs/index.rst b/docs/index.rst index 43fb315f6..677c32b12 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -190,12 +190,15 @@ For OOM, the URL is https://<host-ip>:30258/designer/index.html - 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 (CLAMP Designer) - serve to configure control loop +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. + The following actions are done using the UI: * Design a control loop flow by selecting a predefined template from a list @@ -219,8 +222,14 @@ The following actions are done using the UI: * 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 diff --git a/docs/user-guide.rst b/docs/user-guide.rst new file mode 100644 index 000000000..dca5bb80f --- /dev/null +++ b/docs/user-guide.rst @@ -0,0 +1,103 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. 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. +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. + +|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 + +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 + +|clamp-opened-closed-loop| + +Closed Loop properties +---------------------- +You can check to which service/vnf the closed loop has been associated in SDC. + +|clamp-menu-prop| + +This opens a box that gives the properties set during the SDC notification deployment in CLAMP. +Do not change those settings + +|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. + +|clamp-op-policy-box| + +Once clicked, it's possible to configure each operational policy that can also contain multiple "sub policies", one per Recipe + +|clamp-op-policy-box-policy1| + +Configuration 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. + +|clamp-config-policy-tca1| + +Saving Closed loop +------------------ +Once all properties have been defined for all policies, the closed loop must be saved. + +|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" + +|clamp-distributed| + +Deploy/undeploy the Closed loop to DCAE +--------------------------------------- +Once sent to policy engine, Clamp can ask to DCAE to deploy the micro service + +|clamp-deploy| + +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 Closed 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| + +.. |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-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-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 |
