Added flow diagram to clc documentation. 14/72714/1
authorJoshua Reich <jreich@research.att.com>
Mon, 12 Nov 2018 20:22:27 +0000 (12:22 -0800)
committerJoshua Reich <jreich@research.att.com>
Wed, 14 Nov 2018 23:30:11 +0000 (15:30 -0800)
Issue-ID: POLICY-1246
Change-Id: Iacc314242e47650087bfbcc6208b2ed92bb0e603
Signed-off-by: Joshua Reich <jreich@research.att.com>
docs/platform/clc.rst
docs/platform/detailed_clc_flow.PNG [new file with mode: 0755]

index feef34f..70261b3 100644 (file)
@@ -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 (executable)
index 0000000..14ca175
Binary files /dev/null and b/docs/platform/detailed_clc_flow.PNG differ