Design and Public API documentation completed.

The draw.io diagrams are in Gerrit. If the page is ever deleted, they
will be lost. They ae now saved in XML format in gerrit.

The design documentation links to the examples in github rather than
quoting them in the document. General tidy up and cleaning of links,
rewording, and reformatting of desgin document.

Added missing diagram to the Design document.

Updated and tidied up the internal PAP/PDP document.

General improvement of documentation.

Issue-ID: POLICY-1676
Change-Id: Ie5c9f32693f047beafe14a3e412a32cdf9ed6fde
Signed-off-by: liamfallon <liam.fallon@est.tech>

1 files changed, 2 insertions, 0 deletions

diff --git a/docs/design/draw.io/PolicyImplPDPSubGroup.xml b/docs/design/draw.io/PolicyImplPDPSubGroup.xml
new file mode 100644
index 00000000..293f616e
--- /dev/null
+++ b/docs/design/draw.io/PolicyImplPDPSubGroup.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxGraphModel dx="1395" dy="1208" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" background="#ffffff" math="0" shadow="0"><root><mxCell id="0"/><mxCell id="1" parent="0"/><mxCell id="4" value="PDPGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="-140" y="-5" width="120" height="310" as="geometry"/></mxCell><mxCell id="5" value="PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="-130" y="205" width="100" height="90" as="geometry"/></mxCell><mxCell id="6" value="PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="-130" y="25" width="100" height="80" as="geometry"/></mxCell><mxCell id="7" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="-120" y="55" width="70" height="40" as="geometry"/></mxCell><mxCell id="8" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="7" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="9" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="7" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="10" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="-125" y="235" width="80" height="50" as="geometry"/></mxCell><mxCell id="11" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="10" vertex="1"><mxGeometry x="20" y="20" width="60" height="30" as="geometry"/></mxCell><mxCell id="12" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="10" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="13" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="10" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="14" value="PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="-130" y="115" width="100" height="80" as="geometry"/></mxCell><mxCell id="15" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="-120" y="140" width="80" height="50" as="geometry"/></mxCell><mxCell id="16" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="15" vertex="1"><mxGeometry x="20" y="20" width="60" height="30" as="geometry"/></mxCell><mxCell id="17" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="15" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="18" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="15" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="46" value="All PDPs in a &lt;i&gt;PDPSubGroup&lt;/i&gt; run the same &lt;i&gt;PolicyImpl&lt;/i&gt;" style="shape=note;whiteSpace=wrap;html=1;size=14;verticalAlign=top;align=left;spacingTop=-6;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1"><mxGeometry x="10" y="-5" width="130" height="50" as="geometry"/></mxCell><mxCell id="47" value="" style="endArrow=none;dashed=1;html=1;entryX=0;entryY=0.5;exitX=1;exitY=0.25;strokeColor=#97D077;" parent="1" source="6" target="46" edge="1"><mxGeometry width="50" height="50" relative="1" as="geometry"><mxPoint x="-320" y="375" as="sourcePoint"/><mxPoint x="-270" y="325" as="targetPoint"/></mxGeometry></mxCell><mxCell id="48" value="" style="endArrow=none;dashed=1;html=1;exitX=1;exitY=0.5;strokeColor=#97D077;" parent="1" source="55" edge="1"><mxGeometry width="50" height="50" relative="1" as="geometry"><mxPoint x="198" y="35" as="sourcePoint"/><mxPoint x="-120" y="155" as="targetPoint"/></mxGeometry></mxCell><mxCell id="49" value="The PDP running its&lt;i&gt; PolicyImpl&lt;/i&gt; is the unit of scaling" style="shape=note;whiteSpace=wrap;html=1;size=14;verticalAlign=top;align=left;spacingTop=-6;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1"><mxGeometry x="20" y="95" width="120" height="50" as="geometry"/></mxCell><mxCell id="50" value="" style="endArrow=none;dashed=1;html=1;entryX=0;entryY=0.5;exitX=1;exitY=0.75;strokeColor=#97D077;" parent="1" source="18" target="49" edge="1"><mxGeometry width="50" height="50" relative="1" as="geometry"><mxPoint x="-50" y="88" as="sourcePoint"/><mxPoint x="60" y="185" as="targetPoint"/></mxGeometry></mxCell><mxCell id="51" value="A &lt;i&gt;PDPSubGroup&lt;/i&gt; is a Kubernetes &lt;b&gt;&lt;i&gt;Deployment&lt;/i&gt;&lt;/b&gt;" style="shape=note;whiteSpace=wrap;html=1;size=8;verticalAlign=top;align=left;spacingTop=-6;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1"><mxGeometry x="-300" y="-2.5" width="130" height="55" as="geometry"/></mxCell><mxCell id="54" value="" style="endArrow=none;dashed=1;html=1;entryX=1;entryY=0.5;exitX=0;exitY=0.25;strokeColor=#97D077;" parent="1" source="6" target="51" edge="1"><mxGeometry width="50" height="50" relative="1" as="geometry"><mxPoint x="-20" y="55" as="sourcePoint"/><mxPoint x="60" y="10" as="targetPoint"/></mxGeometry></mxCell><mxCell id="55" value="PDPs run as Kubernets &lt;b&gt;&lt;i&gt;Pods&lt;/i&gt;&lt;/b&gt;&lt;i&gt;&lt;br&gt;&lt;/i&gt;" style="shape=note;whiteSpace=wrap;html=1;size=14;verticalAlign=top;align=left;spacingTop=-6;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1"><mxGeometry x="-300" y="120" width="120" height="45" as="geometry"/></mxCell><mxCell id="56" value="A &lt;i&gt;PDPGroup&lt;/i&gt; groups &lt;i&gt;PDPSubGroup&lt;/i&gt; entities together" style="shape=note;whiteSpace=wrap;html=1;size=4;verticalAlign=top;align=left;spacingTop=-6;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1"><mxGeometry x="-145" y="-100" width="130" height="50" as="geometry"/></mxCell><mxCell id="57" value="" style="endArrow=none;dashed=1;html=1;entryX=0.25;entryY=1;exitX=0.5;exitY=0;strokeColor=#97D077;" parent="1" source="4" target="56" edge="1"><mxGeometry width="50" height="50" relative="1" as="geometry"><mxPoint x="-120" y="55" as="sourcePoint"/><mxPoint x="-160" y="35" as="targetPoint"/></mxGeometry></mxCell><mxCell id="58" value="ControlLoop&lt;br&gt;PDPGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="200" y="-50" width="120" height="340" as="geometry"/></mxCell><mxCell id="59" value="CL_Apex&lt;br&gt;PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="210" y="186" width="100" height="98" as="geometry"/></mxCell><mxCell id="60" value="CL_Guard&lt;br&gt;PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="210" y="-10.5" width="100" height="88" as="geometry"/></mxCell><mxCell id="61" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="220" y="27" width="70" height="40" as="geometry"/></mxCell><mxCell id="62" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="61" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="63" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="61" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="64" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="215" y="223.5" width="80" height="50" as="geometry"/></mxCell><mxCell id="65" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="64" vertex="1"><mxGeometry x="20" y="20" width="60" height="30" as="geometry"/></mxCell><mxCell id="66" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="64" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="67" value="PDP-A" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="64" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="68" value="CL_Drools&lt;br&gt;PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="210" y="85" width="100" height="93" as="geometry"/></mxCell><mxCell id="69" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="220" y="122.5" width="80" height="50" as="geometry"/></mxCell><mxCell id="70" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="69" vertex="1"><mxGeometry x="20" y="20" width="60" height="30" as="geometry"/></mxCell><mxCell id="71" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="69" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="72" value="PDP-D" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="69" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell><mxCell id="73" value="Monitoring&lt;br&gt;PDPGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="340" y="-50" width="120" height="140" as="geometry"/></mxCell><mxCell id="75" value="Monitoring&lt;br&gt;PDPSubGroup" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;strokeColor=#B8B8B8;" parent="1" vertex="1"><mxGeometry x="350" y="-10.5" width="100" height="88" as="geometry"/></mxCell><mxCell id="76" value="" style="group" parent="1" vertex="1" connectable="0"><mxGeometry x="360" y="27" width="70" height="40" as="geometry"/></mxCell><mxCell id="77" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="76" vertex="1"><mxGeometry x="10" y="10" width="60" height="30" as="geometry"/></mxCell><mxCell id="78" value="PDP-X" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="76" vertex="1"><mxGeometry width="60" height="30" as="geometry"/></mxCell></root></mxGraphModel>
\ No newline at end of file