Complete Architecture Document

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

1 files changed, 53 insertions, 0 deletions

diff --git a/docs/architecture/images/PolicyRollout.svg b/docs/architecture/images/PolicyRollout.svg
new file mode 100644
index 00000000..1c0b21c9
--- /dev/null
+++ b/docs/architecture/images/PolicyRollout.svg
@@ -0,0 +1,53 @@
+<?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="803px" preserveAspectRatio="none" style="width:737px;height:803px;" version="1.1" viewBox="0 0 737 803" width="737px" zoomAndPan="magnify"><defs><filter height="300%" id="f1f2g3wl1bqly4" 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="105" x="317.25" y="22.9951">Policy Rollout</text><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="62.3984" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="162.7266"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="268.2578"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="415.9219"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="563.5859"/><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="75.3984" style="stroke: #000000; stroke-width: 2.0;" width="713.5" x="13" y="623.8516"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="42" x2="42" y1="116.5938" y2="716.25"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="409.5" x2="409.5" y1="116.5938" y2="716.25"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="692.5" x2="692.5" y1="116.5938" y2="716.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="113.292">User</text><ellipse cx="42" cy="43.2969" fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,51.2969 L42,78.2969 M29,59.2969 L55,59.2969 M42,78.2969 L29,93.2969 M42,78.2969 L55,93.2969 " fill="none" filter="url(#f1f2g3wl1bqly4)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="32" x="23" y="728.2451">User</text><ellipse cx="42" cy="741.5469" fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M42,749.5469 L42,776.5469 M29,757.5469 L55,757.5469 M42,776.5469 L29,791.5469 M42,776.5469 L55,791.5469 " fill="none" filter="url(#f1f2g3wl1bqly4)" style="stroke: #A80036; stroke-width: 2.0;"/><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="387.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="394.5" y="101.292">PAP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="41" x="387.5" y="715.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="394.5" y="735.2451">PAP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="669.5" y="81.2969"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="676.5" y="101.292">PDP</text><rect fill="#FEFECE" filter="url(#f1f2g3wl1bqly4)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="43" x="669.5" y="715.25"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="29" x="676.5" y="735.2451">PDP</text><polygon fill="#A80036" points="398,143.7266,408,147.7266,398,151.7266,402,147.7266" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="147.7266" y2="147.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="142.6606">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="203" x="62" y="142.6606">Create Policy Set for PDP Group</text><path d="M377.5,162.7266 L454.5,162.7266 L454.5,169.7266 L444.5,179.7266 L377.5,179.7266 L377.5,162.7266 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="62.3984" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="162.7266"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="175.7935">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="174.937">[over PDP Group]</text><rect fill="#FFFFFF" filter="url(#f1f2g3wl1bqly4)" height="40.2656" style="stroke: #000000; stroke-width: 2.0;" width="331" x="384.5" y="179.8594"/><polygon fill="#EEEEEE" points="384.5,179.8594,450.5,179.8594,450.5,186.8594,440.5,196.8594,384.5,196.8594,384.5,179.8594" 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="397.5" y="193.9263">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="209" x="447.5" y="212.9263">PAP downloads Policy Set to PDP</text><polygon fill="#A80036" points="398,249.2578,408,253.2578,398,257.2578,402,253.2578" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="253.2578" y2="253.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="248.1919">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="180" x="62" y="248.1919">Set PDP Group in Test Mode</text><path d="M377.5,268.2578 L454.5,268.2578 L454.5,275.2578 L444.5,285.2578 L377.5,285.2578 L377.5,268.2578 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="268.2578"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="281.3247">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="280.4683">[over PDP Group]</text><polygon fill="#A80036" points="681,302.5234,691,306.5234,681,310.5234,685,306.5234" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="306.5234" y2="306.5234"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="417" y="301.4575">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="143" x="430" y="301.4575">Set PDP in TEST mode</text><polygon fill="#A80036" points="421,338.6563,411,342.6563,421,346.6563,417,342.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="342.6563" y2="342.6563"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="427" y="337.5903">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="118" x="440" y="337.5903">Report test results</text><polygon fill="#A80036" points="53,367.7891,43,371.7891,53,375.7891,49,371.7891" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="371.7891" y2="371.7891"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="59" y="366.7231">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="203" x="72" y="366.7231">Report consolidated test results</text><polygon fill="#A80036" points="398,396.9219,408,400.9219,398,404.9219,402,400.9219" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="400.9219" y2="400.9219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="395.856">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="182" x="62" y="395.856">Set PDP Group in Safe Mode</text><path d="M377.5,415.9219 L454.5,415.9219 L454.5,422.9219 L444.5,432.9219 L377.5,432.9219 L377.5,415.9219 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="415.9219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="428.9888">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="428.1323">[over PDP Group]</text><polygon fill="#A80036" points="681,450.1875,691,454.1875,681,458.1875,685,454.1875" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="454.1875" y2="454.1875"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="417" y="449.1216">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="145" x="430" y="449.1216">Set PDP in SAFE mode</text><polygon fill="#A80036" points="421,486.3203,411,490.3203,421,494.3203,417,490.3203" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="490.3203" y2="490.3203"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="427" y="485.2544">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="226" x="440" y="485.2544">Report safe mode operation results</text><polygon fill="#A80036" points="53,515.4531,43,519.4531,53,523.4531,49,519.4531" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="519.4531" y2="519.4531"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="59" y="514.3872">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="311" x="72" y="514.3872">Report consolidated safe mode operation results</text><polygon fill="#A80036" points="398,544.5859,408,548.5859,398,552.5859,402,548.5859" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="42" x2="404" y1="548.5859" y2="548.5859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="49" y="543.52">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="192" x="71" y="543.52">Set PDP Group in Active Mode</text><path d="M377.5,563.5859 L454.5,563.5859 L454.5,570.5859 L444.5,580.5859 L377.5,580.5859 L377.5,563.5859 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="46.2656" style="stroke: #000000; stroke-width: 2.0;" width="349" x="377.5" y="563.5859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="392.5" y="576.6528">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="109" x="469.5" y="575.7964">[over PDP Group]</text><polygon fill="#A80036" points="681,597.8516,691,601.8516,681,605.8516,685,601.8516" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="410" x2="687" y1="601.8516" y2="601.8516"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="417" y="596.7856">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="151" x="439" y="596.7856">Set PDP in Active mode</text><path d="M13,623.8516 L90,623.8516 L90,630.8516 L80,640.8516 L13,640.8516 L13,623.8516 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="75.3984" style="stroke: #000000; stroke-width: 2.0;" width="713.5" x="13" y="623.8516"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="28" y="636.9185">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="56" x="105" y="636.062">[forever]</text><polygon fill="#A80036" points="421,658.1172,411,662.1172,421,666.1172,417,662.1172" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="415" x2="692" y1="662.1172" y2="662.1172"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="427" y="657.0513">12</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="237" x="449" y="657.0513">Report active mode operation results</text><polygon fill="#A80036" points="53,687.25,43,691.25,53,695.25,49,691.25" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="47" x2="409" y1="691.25" y2="691.25"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="59" y="686.1841">13</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="322" x="81" y="686.1841">Report consolidated active mode operation results</text><!--
+@startuml

+title Policy Rollout

+

+actor User

+participant PAP

+participant PDP

+

+autonumber

+User - -> PAP: Create Policy Set for PDP Group

+

+loop over PDP Group

+  ref over PAP, PDP: PAP downloads Policy Set to PDP

+end

+

+User - -> PAP: Set PDP Group in Test Mode

+

+loop over PDP Group

+  PAP - -> PDP: Set PDP in TEST mode

+end

+

+PDP - -> PAP: Report test results

+PAP - -> User: Report consolidated test results

+

+User - -> PAP: Set PDP Group in Safe Mode

+loop over PDP Group

+  PAP - -> PDP: Set PDP in SAFE mode

+end

+

+PDP - -> PAP: Report safe mode operation results

+PAP - -> User: Report consolidated safe mode operation results

+

+User - -> PAP: Set PDP Group in Active Mode

+loop over PDP Group

+  PAP - -> PDP: Set PDP in Active mode

+end

+

+loop forever

+  PDP - -> PAP: Report active mode operation results

+  PAP - -> User: Report consolidated active mode operation results

+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