From: Joshua Reich Date: Mon, 12 Nov 2018 20:22:27 +0000 (-0800) Subject: Added flow diagram to clc documentation. X-Git-Tag: 1.3.4~1 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=policy%2Fengine.git;a=commitdiff_plain;h=306eb5a5c99c115fb54be27acfedace081b04c03 Added flow diagram to clc documentation. Issue-ID: POLICY-1246 Change-Id: Iacc314242e47650087bfbcc6208b2ed92bb0e603 Signed-off-by: Joshua Reich (cherry picked from commit 071d1df9334aaf14b8e0d7cfbf0a2e9586f793fa) --- diff --git a/docs/platform/clc.rst b/docs/platform/clc.rst index feef34fbe..70261b31f 100644 --- a/docs/platform/clc.rst +++ b/docs/platform/clc.rst @@ -49,7 +49,12 @@ How is the CLC implemented? .. _ControlLoopEventManager: https://git.onap.org/policy/drools-applications/tree/controlloop/templates/template.demo.clc/src/main/resources/__closedLoopControlName__.drl#n210 Example code is provided at `template.demo.clc`_. The abstraction implemented for the initial release is simply a XACML policy (e.g., `synthetic_control_loop_one_blocks_synthetic_control_loop_two.xml`_) that matches against one CLF (e.g., `policy_ControlLoop_SyntheticOne.yaml`_) and checks the status of another CLF (e.g., `policy_ControlLoop_SyntheticTwo.yaml`_) via provided PIPs. The following release will provide a much more succinct YAML representation consisting of coordination_directive_type, control_loop_one_id, control_loop_two_id, and, optionally, one or more parameters, the semantics of which are defined by the coordination_directive_type. - + +The following figure provides a detailed overview of the call flow as implemented: + + .. image:: detailed_clc_flow.PNG + :scale: 67 + How do you run the example? ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/platform/detailed_clc_flow.PNG b/docs/platform/detailed_clc_flow.PNG new file mode 100755 index 000000000..14ca175ca Binary files /dev/null and b/docs/platform/detailed_clc_flow.PNG differ