Complete Architecture Document

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

1 files changed, 34 insertions, 0 deletions

diff --git a/docs/architecture/images/PAPStartStop.svg b/docs/architecture/images/PAPStartStop.svg
new file mode 100644
index 00000000..817b5857
--- /dev/null
+++ b/docs/architecture/images/PAPStartStop.svg
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="501px" preserveAspectRatio="none" style="width:382px;height:501px;" version="1.1" viewBox="0 0 382 501" width="382px" zoomAndPan="magnify"><defs><filter height="300%" id="f1djzk8zozdiog" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="213" x="85.75" y="22.9951">PAP Startup and Shutdown</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="123.5" y="192.9922"/><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="168.1953" style="stroke: #000000; stroke-width: 2.0;" width="153" x="96" y="242.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="30" x2="30" y1="95.5938" y2="428.1875"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="128" x2="128" y1="95.5938" y2="428.1875"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="343.5" x2="343.5" y1="95.5938" y2="428.1875"/><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="60.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="80.292">K8S</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="8" y="427.1875"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="15" y="447.1826">K8S</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="106" y="60.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="113" y="80.292">PAP</text><rect fill="#FEFECE" filter="url(#f1djzk8zozdiog)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="106" y="427.1875"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="113" y="447.1826">PAP</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="310.5" y="92.292">PolicyDB</text><path d="M325.5,43.2969 C325.5,33.2969 343.5,33.2969 343.5,33.2969 C343.5,33.2969 361.5,33.2969 361.5,43.2969 L361.5,69.2969 C361.5,79.2969 343.5,79.2969 343.5,79.2969 C343.5,79.2969 325.5,79.2969 325.5,69.2969 L325.5,43.2969 " fill="#FEFECE" filter="url(#f1djzk8zozdiog)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M325.5,43.2969 C325.5,53.2969 343.5,53.2969 343.5,53.2969 C343.5,53.2969 361.5,53.2969 361.5,43.2969 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="60" x="310.5" y="440.1826">PolicyDB</text><path d="M325.5,453.4844 C325.5,443.4844 343.5,443.4844 343.5,443.4844 C343.5,443.4844 361.5,443.4844 361.5,453.4844 L361.5,479.4844 C361.5,489.4844 343.5,489.4844 343.5,489.4844 C343.5,489.4844 325.5,489.4844 325.5,479.4844 L325.5,453.4844 " fill="#FEFECE" filter="url(#f1djzk8zozdiog)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M325.5,453.4844 C325.5,463.4844 343.5,463.4844 343.5,463.4844 C343.5,463.4844 361.5,463.4844 361.5,453.4844 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="28" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="123.5" y="192.9922"/><polygon fill="#A80036" points="116.5,122.7266,126.5,126.7266,116.5,130.7266,120.5,126.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="30.5" x2="122.5" y1="126.7266" y2="126.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="37.5" y="121.6606">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="61" x="50.5" y="121.6606">Start PAP</text><polygon fill="#A80036" points="331.5,151.8594,341.5,155.8594,331.5,159.8594,335.5,155.8594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="128.5" x2="337.5" y1="155.8594" y2="155.8594"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="135.5" y="150.7935">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="148.5" y="150.7935">Read Initial Data</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="133.5" x2="175.5" y1="184.9922" y2="184.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="175.5" x2="175.5" y1="184.9922" y2="197.9922"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="134.5" x2="175.5" y1="197.9922" y2="197.9922"/><polygon fill="#A80036" points="144.5,193.9922,134.5,197.9922,144.5,201.9922,140.5,197.9922" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="140.5" y="179.9263">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="188" x="153.5" y="179.9263">Initialize Policy Administration</text><path d="M96,242.9922 L173,242.9922 L173,249.9922 L163,259.9922 L96,259.9922 L96,242.9922 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="168.1953" style="stroke: #000000; stroke-width: 2.0;" width="153" x="96" y="242.9922"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="111" y="256.0591">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="188" y="255.2026">[forever]</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="70.5313" style="stroke: #000000; stroke-width: 2.0;" width="108" x="103" y="260.125"/><polygon fill="#EEEEEE" points="103,260.125,169,260.125,169,267.125,159,277.125,103,277.125,103,260.125" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="116" y="274.1919">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="109" y="293.1919">Wait for and</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="75" x="109" y="308.3247">Handle PDP</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="100" x="109" y="323.4575">Status Updates</text><rect fill="#FFFFFF" filter="url(#f1djzk8zozdiog)" height="70.5313" style="stroke: #000000; stroke-width: 2.0;" width="112" x="103" y="335.6563"/><polygon fill="#EEEEEE" points="103,335.6563,169,335.6563,169,342.6563,159,352.6563,103,352.6563,103,335.6563" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="116" y="349.7231">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="109" y="368.7231">Wait for and</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="45" x="109" y="383.856">Handle</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="109" y="398.9888">Admin Requests</text><!--
+@startuml

+title PAP Startup and Shutdown

+

+participant K8S

+participant PAP

+database PolicyDB

+

+autonumber

+

+K8S - -> PAP : Start PAP

+

+PAP - -> PolicyDB : Read Initial Data

+PAP - -> PAP : Initialize Policy Administration

+

+activate PAP

+deactivate PAP

+

+loop forever

+  ref over PAP: Wait for and\nHandle PDP\nStatus Updates

+  ref over PAP: Wait for and\nHandle\nAdmin Requests

+end

+@enduml

+
+PlantUML version 1.2019.07beta1(Unknown compile time)
+(GPL source distribution)
+Java Runtime: Java(TM) SE Runtime Environment
+JVM: Java HotSpot(TM) 64-Bit Server VM
+Java Version: 1.7.0_25-b15
+Operating System: Linux
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>
\ No newline at end of file