Complete Architecture Document

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

1 files changed, 46 insertions, 0 deletions

diff --git a/docs/architecture/images/ModelDrivenPolicyDesign.svg b/docs/architecture/images/ModelDrivenPolicyDesign.svg
new file mode 100644
index 00000000..7a42f346
--- /dev/null
+++ b/docs/architecture/images/ModelDrivenPolicyDesign.svg
@@ -0,0 +1,46 @@
+<?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="600px" preserveAspectRatio="none" style="width:879px;height:600px;" version="1.1" viewBox="0 0 879 600" width="879px" zoomAndPan="magnify"><defs><filter height="300%" id="f1tpd2l713nu6j" 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="334" y="22.9951">Model Driven Policy Design</text><rect fill="#ADD8E6" height="555.3125" style="stroke: #A80036; stroke-width: 1.0;" width="443" x="419" y="34.2969"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="94" x="593.5" y="46.3638">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="153.7969" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="486" y="334.0859"/><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="76.5313" style="stroke: #000000; stroke-width: 2.0;" width="455" x="413" y="354.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="32" x2="32" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="255" x2="255" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="491" x2="491" y1="105.0234" y2="535.0156"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="805" x2="805" y1="105.0234" y2="535.0156"/><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="44" x="8" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="30" x="15" y="89.7217">SDC</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="44" x="8" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="30" x="15" y="554.0107">SDC</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="222" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="229" y="89.7217">DMaaP</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="62" x="222" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="48" x="229" y="554.0107">DMaaP</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="132" x="423" y="53.4297"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="450" y="74.4297">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="118" x="430" y="90.7266">PolicyDistribution</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="46.5938" style="stroke: #A80036; stroke-width: 1.5;" width="132" x="423" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="78" x="450" y="555.0156">«API_User»</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="118" x="430" y="571.3125">PolicyDistribution</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="752" y="69.7266"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="759" y="89.7217">PolicyDesign</text><rect fill="#FEFECE" filter="url(#f1tpd2l713nu6j)" height="30.2969" style="stroke: #A80036; stroke-width: 1.5;" width="102" x="752" y="534.0156"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="88" x="759" y="554.0107">PolicyDesign</text><rect fill="#FFFFFF" filter="url(#f1tpd2l713nu6j)" height="153.7969" style="stroke: #A80036; stroke-width: 1.0;" width="10" x="486" y="334.0859"/><polygon fill="#A80036" points="266,147.2891,256,151.2891,266,155.2891,262,151.2891" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="260" x2="490" y1="151.2891" y2="151.2891"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="272" y="138.6567">1</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="199" x="285" y="131.0903">Subscribe for SDC Notifications</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="133" x="285" y="146.2231">on Entries of Interest</text><polygon fill="#A80036" points="243,176.4219,253,180.4219,243,184.4219,247,180.4219" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="32" x2="249" y1="180.4219" y2="180.4219"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="39" y="175.356">2</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="186" x="52" y="175.356">New Entry of Interest: EntityA</text><polygon fill="#A80036" points="479,205.5547,489,209.5547,479,213.5547,483,209.5547" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="255" x2="485" y1="209.5547" y2="209.5547"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="262" y="204.4888">3</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="186" x="275" y="204.4888">New Entry of Interest: EntityA</text><polygon fill="#A80036" points="43,234.6875,33,238.6875,43,242.6875,39,238.6875" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="37" x2="490" y1="238.6875" y2="238.6875"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="49" y="233.6216">4</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="412" x="62" y="233.6216">Download CSAR for EntityA that holds TOSCA Policy Specification</text><polygon fill="#A80036" points="793,263.8203,803,267.8203,793,271.8203,797,267.8203" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="491" x2="799" y1="267.8203" y2="267.8203"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="498" y="262.7544">5</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="131" x="511" y="262.7544">Get Policy Reference</text><polygon fill="#A80036" points="502,292.9531,492,296.9531,502,300.9531,498,296.9531" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="804" y1="296.9531" y2="296.9531"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="508" y="291.8872">6</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="243" x="521" y="291.8872">Return Policy Reference and Metadata</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="491" x2="538" y1="321.0859" y2="321.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="538" x2="538" y1="321.0859" y2="334.0859"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="497" x2="538" y1="334.0859" y2="334.0859"/><polygon fill="#A80036" points="507,330.0859,497,334.0859,507,338.0859,503,334.0859" 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="503" y="316.02">7</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="287" x="516" y="316.02">Create Policy Editing and Generation Session</text><path d="M413,354.0859 L490,354.0859 L490,361.0859 L480,371.0859 L413,371.0859 L413,354.0859 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="76.5313" style="stroke: #000000; stroke-width: 2.0;" width="455" x="413" y="354.0859"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="428" y="367.1528">loop</text><polygon fill="#A80036" points="793,418.6172,803,422.6172,793,426.6172,797,422.6172" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="799" y1="422.6172" y2="422.6172"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="503" y="402.4185">8</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="199" x="516" y="387.2856">Use Policy Type specification to</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="148" x="516" y="402.4185">read Policy Parameters</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="215" x="516" y="417.5513">from TOSCA specification in CSAR</text><polygon fill="#A80036" points="793,454.75,803,458.75,793,462.75,797,458.75" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="799" y1="458.75" y2="458.75"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="9" x="503" y="453.6841">9</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="83" x="516" y="453.6841">Create Policy</text><polygon fill="#A80036" points="502,483.8828,492,487.8828,502,491.8828,498,487.8828" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="496" x2="804" y1="487.8828" y2="487.8828"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="508" y="482.8169">10</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="137" x="530" y="482.8169">Policy Creation Result</text><polygon fill="#A80036" points="43,513.0156,33,517.0156,43,521.0156,39,517.0156" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="37" x2="490" y1="517.0156" y2="517.0156"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="18" x="49" y="511.9497">11</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="190" x="71" y="511.9497">Notify SDC of operation result</text><!--
+@startuml

+title Model Driven Policy Design

+

+participant SDC

+participant DMaaP

+

+box "PolicyDesign" #LightBlue

+  participant PolicyDistribution << API_User >>

+  participant PolicyDesign

+end box

+

+autonumber

+

+PolicyDistribution - -> DMaaP : Subscribe for SDC Notifications\non Entries of Interest

+SDC - -> DMaaP : New Entry of Interest: EntityA

+DMaaP - -> PolicyDistribution : New Entry of Interest: EntityA

+

+PolicyDistribution - -> SDC : Download CSAR for EntityA that holds TOSCA Policy Specification

+

+PolicyDistribution - -> PolicyDesign : Get Policy Reference

+PolicyDesign - -> PolicyDistribution : Return Policy Reference and Metadata

+PolicyDistribution - -> PolicyDistribution : Create Policy Editing and Generation Session

+

+activate PolicyDistribution

+loop

+  PolicyDistribution - -> PolicyDesign : Use Policy Type specification to\nread Policy Parameters\nfrom TOSCA specification in CSAR

+end

+

+PolicyDistribution - -> PolicyDesign : Create Policy

+PolicyDesign - -> PolicyDistribution : Policy Creation Result

+deactivate PolicyDistribution

+

+PolicyDistribution - -> SDC : Notify SDC of operation result

+@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